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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.132     spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
1.148     asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75      rillig     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.217     jnemeth    33: <div><p class="copyright">Copyright © 1994-2016 The NetBSD Foundation, Inc</p></div>
                     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.29 2016/05/06 17:26:34 jnemeth Exp $</p></div>
1.148     asau       35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
1.210     leot       48: <dl class="toc">
1.75      rillig     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
1.157     asau       67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz        68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig     69: </dl></dd>
                     70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     71: <dd><dl>
                     72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     74: </dl></dd>
                     75: </dl></dd>
                     76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     77: <dd><dl>
1.82      rillig     78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     81: <dd><dl>
1.151     obache     82: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                     83: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                     84: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166     jnemeth    85: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
                     86: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
                     87: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
                     88: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
                     89: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
                     90: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
                     91: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75      rillig     92: </dl></dd>
                     93: </dl></dd>
                     94: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     97: <dd><dl>
                     98: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    100: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    102: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    103: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    104: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    105: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    106: </dl></dd>
                    107: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    108: <dd><dl>
                    109: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    110: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    111: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    112: </dl></dd>
                    113: </dl></dd>
                    114: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    115: <dd><dl>
                    116: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    117: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    118: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       119: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       120: <dd><dl>
1.103     wiz       121: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz       122: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    123: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       124: </dl></dd>
1.103     wiz       125: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    126: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    127: </dl></dd>
                    128: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    129: <dd><dl>
                    130: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    131: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    132: </dl></dd>
                    133: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    134: builds)</a></span></dt>
1.75      rillig    135: <dd><dl>
1.180     wiz       136: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                    137: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                    138: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                    139: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau      140: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig    142: </dl></dd>
                    143: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    144: <dd><dl>
1.128     wiz       145: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    146: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106     rillig    147: </dl></dd>
                    148: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    149: <dd><dl>
                    150: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194     bsiegert  151: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                    152: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                    153: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    154: <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>
                    155: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                    156: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                    157: <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>
                    158: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    159: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       160: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert  161: <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>
                    162: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    163: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    164: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    165: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    166: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    168: </dl></dd>
                    169: </dl></dd>
                    170: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    171: <dd><dl>
1.106     rillig    172: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    173: <dd><dl>
1.106     rillig    174: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig    175: <dd><dl>
1.106     rillig    176: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174     asau      177: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118     imil      178: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig    179: </dl></dd>
1.106     rillig    180: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    181: <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>
                    182: </dl></dd>
                    183: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    184: <dd><dl>
1.128     wiz       185: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                    186: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106     rillig    187: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                    188: <dd><dl>
                    189: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    190: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    191: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    192: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    193: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    194: </dl></dd>
                    195: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    196: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    197: <dd><dl>
                    198: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    199: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    200: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    201: </dl></dd>
1.128     wiz       202: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                    203: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    204: </dl></dd>
1.128     wiz       205: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    206: <dd><dl>
                    207: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz       208: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig    209: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    210: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    211: <dd><dl>
                    212: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                    213: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                    214: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                    215: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                    216: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                    217: </dl></dd>
                    218: </dl></dd>
                    219: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    220: <dd><dl>
                    221: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz       222: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    223: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106     rillig    224: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    225: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz       226: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig    227: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz       228: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                    229: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106     rillig    230: </dl></dd>
                    231: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    232: <dd><dl>
                    233: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz       234: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    235: <dd><dl>
                    236: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz       237: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                    238:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    239:       and
                    240:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    241:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    242: </dl></dd>
1.128     wiz       243: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig    244: <dd><dl>
1.128     wiz       245: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106     rillig    246: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    247: </dl></dd>
                    248: </dl></dd>
                    249: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    250: <dd><dl>
                    251: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    252: <dd><dl>
                    253: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    254: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    255: </dl></dd>
                    256: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    257: <dd><dl>
1.128     wiz       258: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig    259: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    260: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    261: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    262: </dl></dd>
                    263: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    264: <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>
                    265: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    266: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    267: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    268: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    269: <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>
                    270: </dl></dd>
                    271: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    272: <dd><dl>
                    273: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz       274: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106     rillig    275: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig    276: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    277: </dl></dd>
                    278: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    279: <dd><dl>
                    280: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    281: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    282: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    283: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz       284: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    285: <dd><dl>
                    286: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    287: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    288: </dl></dd>
1.128     wiz       289: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    290: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    291: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    292: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    293: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    294: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    295: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    296: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    297: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    298: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig    299: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    300: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    301: </dl></dd>
                    302: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    303: <dd><dl>
                    304: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    305: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    306: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    307: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                    308: </dl></dd>
                    309: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    310: <dd><dl>
                    311: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    312: <dd><dl>
1.218   ! rillig    313: <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>
        !           314: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
        !           315: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
        !           316: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
        !           317: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
        !           318: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
        !           319: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
        !           320: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
        !           321: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
        !           322: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
        !           323: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.106     rillig    324: </dl></dd>
1.218   ! rillig    325: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    326: <dd><dl>
                    327: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    328: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.199     tnn       329: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig    330: </dl></dd>
1.218   ! rillig    331: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig    332: <dd><dl>
                    333: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    334: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    335: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    336: </dl></dd>
                    337: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    338: <dd><dl>
                    339: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    340: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    341: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz       342: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                    343: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig    344: </dl></dd>
1.218   ! rillig    345: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig    346: <dd><dl>
                    347: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    348: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz       349: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.106     rillig    350: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    351: </dl></dd>
1.218   ! rillig    352: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig    353: <dd><dl>
                    354: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    355: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    356: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    357: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    358: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    359: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    360: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    361: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig    362: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka    363: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig    364: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    365: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    366: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    367: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    368: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    369: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    370: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    371: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz       372:     emulation</a></span></dt>
1.106     rillig    373: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    374: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    375: </dl></dd>
1.106     rillig    376: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig    377: </dl></dd>
1.106     rillig    378: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    379: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig    380: <dd><dl>
1.106     rillig    381: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    382: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    383: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140     wiz       384: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig    385: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed      386: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                    387: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig    388: </dl></dd>
                    389: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    390: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    391: <dd><dl>
                    392: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    393: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    394: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    395: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv      396: </dl></dd>
1.75      rillig    397: </dl></dd>
                    398: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    399: <dd><dl>
1.106     rillig    400: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    401: <dd><dl>
1.106     rillig    402: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    403: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    404: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig    405: <dd><dl>
1.106     rillig    406: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    407: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig    408: </dl></dd>
1.106     rillig    409: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    410: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    411: <dd><dl>
1.106     rillig    412: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    413: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    414: </dl></dd>
1.106     rillig    415: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig    416: <dd><dl>
1.128     wiz       417: <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>
                    418: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    419: </dl></dd>
                    420: </dl></dd>
1.106     rillig    421: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig    422: <dd><dl>
1.106     rillig    423: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    424: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    425: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig    426: <dd><dl>
1.106     rillig    427: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    428: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig    429: </dl></dd>
                    430: </dl></dd>
1.106     rillig    431: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig    432: <dd><dl>
1.106     rillig    433: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    434: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig    435: </dl></dd>
                    436: </dl></dd>
                    437: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    438: <dd><dl>
                    439: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    440: <dd><dl>
                    441: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    442: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    443: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz       444: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75      rillig    445: </dl></dd>
                    446: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    447: </dl></dd>
                    448: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    449: <dd><dl>
                    450: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    451: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    452: </dl></dd>
1.76      rillig    453: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    454: <dd><dl>
1.128     wiz       455: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    456: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    457: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    458: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    459: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                    460: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    461: source packages</a></span></dt>
                    462: </dl></dd>
1.75      rillig    463: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    464: <dd><dl>
1.79      rillig    465: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    466: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    467: </dl></dd>
                    468: </dl>
                    469: </div>
1.82      rillig    470: <div class="list-of-tables">
                    471: <p><b>List of Tables</b></p>
                    472: <dl>
                    473: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    474: </dt>
1.106     rillig    475: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      476: </dt>
1.106     rillig    477: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      478: </dt>
1.82      rillig    479: </dl>
                    480: </div>
1.148     asau      481: <div class="chapter">
                    482: <div class="titlepage"><div><div><h1 class="title">
                    483: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    484: <div class="toc">
                    485: <p><b>Table of Contents</b></p>
1.210     leot      486: <dl class="toc">
1.75      rillig    487: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    488: <dd><dl>
                    489: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    490: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    491: </dl></dd>
1.75      rillig    492: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    493: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       494: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig    495: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    496: </dl>
                    497: </div>
1.148     asau      498: <div class="sect1">
1.75      rillig    499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    500: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    501: <p>There is a lot of software freely available for Unix-based
                    502: systems, which is usually available in form of the source code. Before
                    503: such software can be used, it needs to be configured to the local
                    504: system, compiled and installed, and this is exactly what The NetBSD
                    505: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    506: to handle binary packages, so that not every user has to build the
                    507: packages for himself, which is a time-costly task.</p>
1.75      rillig    508: <p>pkgsrc currently contains several thousand packages,
                    509:       including:</p>
1.148     asau      510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.214     sevan     511: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75      rillig    512:          web server</p></li>
1.189     snj       513: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    514:          web browser</p></li>
1.189     snj       515: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    516:          Desktop Environment</p></li>
1.212     ryoon     517: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.75      rillig    518:          Desktop Environment</p></li>
                    519: </ul></div>
                    520: <p>...just to name a few.</p>
                    521: <p>pkgsrc has built-in support for handling varying dependencies,
                    522:       such as pthreads and X11, and extended features such as IPv6 support on
                    523:       a range of platforms.</p>
1.148     asau      524: <div class="sect2">
1.82      rillig    525: <div class="titlepage"><div><div><h3 class="title">
                    526: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    527: <p>
                    528: pkgsrc provides the following key features:
                    529: </p>
1.148     asau      530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       531: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    532:   and installation of binary packages. The source and latest
                    533:   patches are retrieved from a master or mirror download site, checksum
                    534:   verified, then built on your system. Support for binary-only
                    535:   distributions is available for both native platforms and NetBSD
                    536:   emulated platforms.</p></li>
1.128     wiz       537: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    538:   including binaries, libraries, man pages and other
                    539:   documentation.</p></li>
1.214     sevan     540: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    541:   performing updates, to ensure required packages are installed. The
                    542:   configuration files of various packages are handled automatically during
                    543:   updates, so local changes are preserved.</p></li>
1.128     wiz       544: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    545:   consists of highly portable code. This allows the greatest speed of
1.132     spz       546:   development when porting to a new platform. This portability also
1.82      rillig    547:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    548:   platforms</em></span>.</p></li>
1.128     wiz       549: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    550:   international encryption requirements and build-time options for a
                    551:   large number of packages are all set in a simple, central
                    552:   configuration file.</p></li>
1.128     wiz       553: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    554:   freely available under a BSD license, so you may extend and adapt
                    555:   pkgsrc to your needs. Support for local packages and patches is
                    556:   available right out of the box, so you can configure it specifically
                    557:   for your environment.</p></li>
                    558: </ul></div>
1.91      rillig    559: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      560: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       561: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.126     jakllsch  562: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    563: them and to complain about them rather than to just install the package
                    564: and hope that it works. There are numerous checks in pkgsrc that try to
1.189     snj       565: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91      rillig    566: of shell scripts), and post-installation checks (installed files,
                    567: references to shared libraries, script interpreters).</p></li>
1.128     wiz       568: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  569: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    570: pkgsrc has been ported to many operating systems. Care is taken that
                    571: packages behave the same on all platforms.</p></li>
                    572: </ul></div>
1.82      rillig    573: </div>
1.148     asau      574: <div class="sect2">
1.82      rillig    575: <div class="titlepage"><div><div><h3 class="title">
                    576: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    577: <p>pkgsrc consists of both a source distribution and a binary
                    578: distribution for these operating systems. After retrieving the required
                    579: source or binaries, you can be up and running with pkgsrc in just
                    580: minutes!</p>
1.75      rillig    581: <p>pkgsrc was derived from FreeBSD's ports system, and
                    582:       initially developed for NetBSD only. Since then, pkgsrc has
                    583:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    584: <div class="table">
                    585: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       586: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    587: <colgroup>
                    588: <col>
                    589: <col>
1.202     sevan     590: <col>
1.82      rillig    591: </colgroup>
                    592: <thead><tr>
                    593: <th>Platform</th>
                    594: <th>Date Support Added</th>
1.202     sevan     595: <th>Notes</th>
1.82      rillig    596: </tr></thead>
                    597: <tbody>
                    598: <tr>
1.110     hubertf   599: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    600: <td align="center">Aug 1997</td>
1.202     sevan     601: <td class="auto-generated"> </td>
1.82      rillig    602: </tr>
                    603: <tr>
1.110     hubertf   604: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    605: <td align="center">Mar 1999</td>
1.203     sevan     606: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.82      rillig    607: </tr>
                    608: <tr>
1.110     hubertf   609: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    610: <td align="center">Jun 1999</td>
1.203     sevan     611: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.82      rillig    612: </tr>
                    613: <tr>
                    614: <td>
1.110     hubertf   615:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    616:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82      rillig    617:         </td>
                    618: <td align="center">Oct 2001</td>
1.203     sevan     619: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.82      rillig    620: </tr>
                    621: <tr>
1.110     hubertf   622: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    623: <td align="center">Nov 2002</td>
1.203     sevan     624: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.82      rillig    625: </tr>
                    626: <tr>
1.110     hubertf   627: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    628: <td align="center">Nov 2002</td>
1.203     sevan     629: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.82      rillig    630: </tr>
                    631: <tr>
1.110     hubertf   632: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    633: <td align="center">Dec 2002</td>
1.202     sevan     634: <td>
1.203     sevan     635:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    636:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.202     sevan     637:        </td>
1.82      rillig    638: </tr>
                    639: <tr>
                    640: <td>BSD/OS</td>
                    641: <td align="center">Dec 2003</td>
1.202     sevan     642: <td class="auto-generated"> </td>
1.82      rillig    643: </tr>
                    644: <tr>
1.110     hubertf   645: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    646: <td align="center">Dec 2003</td>
1.203     sevan     647: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.82      rillig    648: </tr>
                    649: <tr>
                    650: <td>
1.110     hubertf   651:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    652:           (Microsoft Windows Services for Unix)
                    653:         </td>
                    654: <td align="center">Mar 2004</td>
1.203     sevan     655: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.82      rillig    656: </tr>
                    657: <tr>
1.110     hubertf   658: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    659: <td align="center">Oct 2004</td>
1.202     sevan     660: <td class="auto-generated"> </td>
1.82      rillig    661: </tr>
                    662: <tr>
1.110     hubertf   663: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    664: <td align="center">Nov 2004</td>
1.203     sevan     665: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.82      rillig    666: </tr>
1.98      wiz       667: <tr>
1.110     hubertf   668: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       669: <td align="center">Apr 2007</td>
1.203     sevan     670: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.98      wiz       671: </tr>
1.128     wiz       672: <tr>
                    673: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    674: <td align="center">Sep 2010</td>
1.203     sevan     675: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.128     wiz       676: </tr>
1.151     obache    677: <tr>
                    678: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  679: <td align="center">Jan 2011</td>
1.202     sevan     680: <td class="auto-generated"> </td>
1.151     obache    681: </tr>
                    682: <tr>
                    683: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
                    684: <td align="center">Nov 2011</td>
1.203     sevan     685: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.151     obache    686: </tr>
                    687: <tr>
                    688: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
                    689: <td align="center">Mar 2013</td>
1.203     sevan     690: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.151     obache    691: </tr>
1.166     jnemeth   692: <tr>
                    693: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
                    694: <td align="center">Jul 2013</td>
1.203     sevan     695: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.166     jnemeth   696: </tr>
1.214     sevan     697: <tr>
                    698: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
                    699: <td align="center">Jun 2014</td>
                    700: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
                    701: </tr>
1.82      rillig    702: </tbody>
1.91      rillig    703: </table></div>
1.82      rillig    704: </div>
1.91      rillig    705: <br class="table-break">
1.82      rillig    706: </div>
1.75      rillig    707: </div>
1.148     asau      708: <div class="sect1">
1.75      rillig    709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    710: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    711: <p>This document is divided into three parts. The first,
1.110     hubertf   712:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    713:        describes how one can use one of the packages in the Package
                    714:        Collection, either by installing a precompiled binary package,
1.93      rillig    715:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   716:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75      rillig    717:        package so it can be easily built by other NetBSD users without
                    718:        knowing about the package's building details. The third part,
1.110     hubertf   719:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    720:        is intended for those who want to understand how pkgsrc is
                    721:        implemented.</p>
                    722: <p>This document is available in various formats:
1.110     hubertf   723:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75      rillig    724: </div>
1.148     asau      725: <div class="sect1">
1.75      rillig    726: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    727: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       728: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    729:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    730:       terminology used within this document.</p>
1.148     asau      731: <div class="variablelist"><dl class="variablelist">
1.75      rillig    732: <dt><span class="term">Package</span></dt>
                    733: <dd><p>A set of files and building instructions
                    734:            that describe what's necessary
                    735:            to build a certain piece of software using
                    736:             pkgsrc. Packages are traditionally stored under
1.76      rillig    737:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    738: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       739: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       740:          is part of the NetBSD operating system and can be bootstrapped
                    741:          to run on non-NetBSD operating systems as well.  It handles
                    742:          building (compiling), installing, and removing of
                    743:          packages.</p></dd>
1.75      rillig    744: <dt><span class="term">Distfile</span></dt>
                    745: <dd><p>This term describes the file or files that are
                    746:            provided by the author of the piece of software to
                    747:            distribute his work. All the changes necessary to build on
                    748:            NetBSD are reflected in the corresponding package. Usually
                    749:            the distfile is in the form of a compressed tar-archive,
                    750:            but other types are possible, too. Distfiles are usually
                    751:            stored below
1.76      rillig    752:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    753: <dt><span class="term">Port</span></dt>
                    754: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    755:            for what we call a package.
1.128     wiz       756:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    757:            architecture.</p></dd>
                    758: <dt><span class="term">Precompiled/binary package</span></dt>
                    759: <dd>
                    760: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    761:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    762:            file so it can be installed on machines of the same
                    763:            machine architecture without the need to
                    764:            recompile. Packages are usually generated in
1.76      rillig    765:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       766:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       767: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    768:            especially in the context of precompiled packages.</p>
                    769: </dd>
                    770: <dt><span class="term">Program</span></dt>
1.88      wiz       771: <dd><p>The piece of software to be installed which will be
                    772:          constructed from all the files in the distfile by the
                    773:          actions defined in the corresponding package.</p></dd>
1.75      rillig    774: </dl></div>
1.148     asau      775: <div class="sect2">
1.75      rillig    776: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       777: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      778: <div class="variablelist"><dl class="variablelist">
1.75      rillig    779: <dt><span class="term">pkgsrc users</span></dt>
                    780: <dd>
                    781: <p>The
                    782:        pkgsrc users are people who use the packages provided by pkgsrc.
                    783:        Typically they are system administrators. The people using the
1.128     wiz       784:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    785:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    786: <p>There are two kinds of pkgsrc users: Some only want to
                    787:        install pre-built binary packages. Others build the pkgsrc
                    788:        packages from source, either for installing them directly or for
1.110     hubertf   789:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.75      rillig    790:        documentation.</p>
                    791: </dd>
                    792: <dt><span class="term">package maintainers</span></dt>
                    793: <dd><p>A
1.110     hubertf   794:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.75      rillig    795: <dt><span class="term">infrastructure developers</span></dt>
                    796: <dd><p>These people are involved in all those files
1.76      rillig    797:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   798:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.75      rillig    799:        too.</p></dd>
                    800: </dl></div>
                    801: </div>
                    802: </div>
1.148     asau      803: <div class="sect1">
1.75      rillig    804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    805: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    806: <p>When giving examples for commands, shell prompts are used to
                    807:       show if the command should/can be issued as root, or if
1.128     wiz       808:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.75      rillig    809:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    810:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    811: </div>
                    812: </div>
1.148     asau      813: <div class="part">
1.75      rillig    814: <div class="titlepage"><div><div><h1 class="title">
                    815: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    816: <div class="toc">
                    817: <p><b>Table of Contents</b></p>
1.210     leot      818: <dl class="toc">
1.75      rillig    819: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    820: <dd><dl>
                    821: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    822: <dd><dl>
1.157     asau      823: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       824: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    825: </dl></dd>
                    826: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    827: <dd><dl>
                    828: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    829: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    830: </dl></dd>
                    831: </dl></dd>
                    832: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    833: <dd><dl>
1.82      rillig    834: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    835: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    836: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    837: <dd><dl>
1.151     obache    838: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                    839: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                    840: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166     jnemeth   841: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
                    842: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
                    843: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
                    844: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
                    845: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
                    846: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
                    847: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75      rillig    848: </dl></dd>
                    849: </dl></dd>
                    850: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    851: <dd><dl>
                    852: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    853: <dd><dl>
                    854: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    855: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    856: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    857: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    858: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    859: <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>
                    860: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    861: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    862: </dl></dd>
                    863: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    864: <dd><dl>
                    865: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    866: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    867: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    868: </dl></dd>
                    869: </dl></dd>
                    870: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    871: <dd><dl>
                    872: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    873: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    874: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       875: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       876: <dd><dl>
1.103     wiz       877: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz       878: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    879: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       880: </dl></dd>
1.103     wiz       881: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    882: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    883: </dl></dd>
                    884: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    885: <dd><dl>
                    886: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    887: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    888: </dl></dd>
                    889: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    890: builds)</a></span></dt>
1.75      rillig    891: <dd><dl>
1.180     wiz       892: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                    893: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                    894: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                    895: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau      896: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    897: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig    898: </dl></dd>
                    899: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    900: <dd><dl>
1.128     wiz       901: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    902: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106     rillig    903: </dl></dd>
                    904: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    905: <dd><dl>
                    906: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194     bsiegert  907: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                    908: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                    909: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    910: <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>
                    911: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                    912: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                    913: <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>
                    914: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    915: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       916: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert  917: <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>
                    918: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    919: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    920: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    921: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    922: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    923: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    924: </dl></dd>
                    925: </dl>
                    926: </div>
1.148     asau      927: <div class="chapter">
1.75      rillig    928: <div class="titlepage"><div><div><h2 class="title">
                    929: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    930: <div class="toc">
                    931: <p><b>Table of Contents</b></p>
1.210     leot      932: <dl class="toc">
1.75      rillig    933: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    934: <dd><dl>
1.157     asau      935: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       936: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    937: </dl></dd>
                    938: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    939: <dd><dl>
                    940: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    941: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    942: </dl></dd>
                    943: </dl>
                    944: </div>
1.91      rillig    945: <p>Before you download and extract the files, you need to decide
                    946: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    947: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    948: free to install the sources and binary packages wherever you want in
                    949: your filesystem, provided that the pathname does not contain white-space
                    950: or other characters that are interpreted specially by the shell and some
                    951: other programs. A safe bet is to use only letters, digits, underscores
                    952: and dashes.</p>
1.148     asau      953: <div class="sect1">
1.75      rillig    954: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    955: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    956: <p>Before you download any pkgsrc files, you should decide
                    957:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    958:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    959:        quarterly basis from the current branch and only gets modified
                    960:        for security updates. The names of the stable branches are built
                    961:        from the year and the quarter, for example
1.188     snj       962:        <code class="literal">2014Q3</code>.</p>
1.75      rillig    963: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz       964:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    965:        Both ways are described here.</p>
1.157     asau      966: <p>Note that tar archive contains CVS working copy.
                    967:        Thus you can switch to using CVS at any later time.</p>
1.148     asau      968: <div class="sect2">
1.75      rillig    969: <div class="titlepage"><div><div><h3 class="title">
1.157     asau      970: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75      rillig    971: <p>The primary download location for all pkgsrc files is
1.157     asau      972:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
                    973:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    974:        (it points to the same location).
                    975:        There are a number of subdirectories for different purposes,
                    976:        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>
                    977: <p>The tar archive for the current branch is in the directory
                    978:        <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75      rillig    979:        It is autogenerated daily.</p>
1.157     asau      980: <p>To save download time we provide bzip2- and
                    981:        xz-compressed archives which are published at
                    982:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
                    983:        and
                    984:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
                    985:        respectively.
                    986:        </p>
                    987: <p>You can fetch the same files using FTP.</p>
1.188     snj       988: <p>The tar file for the stable branch 2014Q3 is in the
                    989:        directory <code class="filename">pkgsrc-2014Q3</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2014Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.112     weinem    990: <p>To download a pkgsrc stable tarball, run:</p>
                    991: <pre class="screen">
1.166     jnemeth   992: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.126     jakllsch  993: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112     weinem    994:        stable branch to be downloaded, for example, 
1.188     snj       995:        <span class="quote">&#8220;<span class="quote">pkgsrc-2014Q3</span>&#8221;</span>.</p>
                    996: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau      997:        or your web browser.</p>
1.112     weinem    998: <p>Then, extract it with:</p>
1.188     snj       999: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem   1000: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1001:        in <code class="filename">/usr/</code> and all the package source will be 
                   1002:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1003: <p>To download pkgsrc-current, run:</p>
                   1004: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75      rillig   1005: </div>
1.148     asau     1006: <div class="sect2">
1.75      rillig   1007: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz      1008: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                   1009: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146     wiz      1010: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.128     wiz      1011: </pre>
                   1012: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
1.188     snj      1013:        branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2014Q3</span>&#8221;</span></p>
1.128     wiz      1014: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1015:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1016:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1017: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1018: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       grant    1019: </pre>
1.188     snj      1020: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128     wiz      1021: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146     wiz      1022: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128     wiz      1023: </pre>
                   1024: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1025:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1026:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1027: <pre class="programlisting">
                   1028: # set CVS remote shell command
                   1029: CVS_RSH=ssh
                   1030: export CVS_RSH
                   1031: </pre>
                   1032: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1033:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1034:        in your home directory and saving the following lines to it.
                   1035:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1036:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1037: <pre class="programlisting">
                   1038: # recommended CVS configuration file from the pkgsrc guide
1.146     wiz      1039: cvs -q -z2
1.101     rillig   1040: checkout -P
1.103     wiz      1041: update -dP
                   1042: diff -upN
1.101     rillig   1043: rdiff -u
1.128     wiz      1044: release -d
1.101     rillig   1045: </pre>
1.75      rillig   1046: </div>
                   1047: </div>
1.148     asau     1048: <div class="sect1">
1.75      rillig   1049: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1050: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1051: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1052:        (which also works if you have first installed it via a tar
                   1053:        file). It saves bandwidth and hard disk activity, compared to
                   1054:        downloading the tar file again.</p>
1.148     asau     1055: <div class="sect2">
1.75      rillig   1056: <div class="titlepage"><div><div><h3 class="title">
                   1057: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148     asau     1058: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1059: <h3 class="title">Warning</h3>
1.77      rillig   1060: <p>When updating from a tar file, you first need to
                   1061:        completely remove the old pkgsrc directory. Otherwise those
                   1062:        files that have been removed from pkgsrc in the mean time will
                   1063:        not be removed on your local disk, resulting in inconsistencies.
                   1064:        When removing the old files, any changes that you have done to
                   1065:        the pkgsrc files will be lost after updating. Therefore updating
                   1066:        via CVS is strongly recommended.</p>
1.75      rillig   1067: </div>
1.82      rillig   1068: <p>Note that by default the distfiles and the binary packages
                   1069:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1070:        before updating. You can also configure pkgsrc to store distfiles
                   1071:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1072:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1073:        variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1074: <p>To update pkgsrc from a tar file, download the tar file as
                   1075:        explained above. Then, make sure that you have not made any
                   1076:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1077:        directory and extract the new tar file. Done.</p>
                   1078: </div>
1.148     asau     1079: <div class="sect2">
1.75      rillig   1080: <div class="titlepage"><div><div><h3 class="title">
                   1081: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132     spz      1082: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1083: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1084: </pre>
                   1085: <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>
                   1086: <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>
                   1087: </pre>
1.148     asau     1088: <div class="sect3">
1.75      rillig   1089: <div class="titlepage"><div><div><h4 class="title">
                   1090: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1091: <p>When updating pkgsrc, the CVS program keeps track of the
                   1092:        branch you selected. But if you, for whatever reason, want to
                   1093:        switch from the stable branch to the current one, you can do it
1.128     wiz      1094:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1095:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1096:        back to the stable branch, add the
1.188     snj      1097:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2014Q3</span>&#8221;</span> option.</p>
1.75      rillig   1098: </div>
1.148     asau     1099: <div class="sect3">
1.75      rillig   1100: <div class="titlepage"><div><div><h4 class="title">
                   1101: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1102: <p>When you update pkgsrc, the CVS program will only touch
                   1103:        those files that are registered in the CVS repository. That
                   1104:        means that any packages that you created on your own will stay
                   1105:        unmodified. If you change files that are managed by CVS, later
                   1106:        updates will try to merge your changes with those that have been
                   1107:        done by others. See the CVS manual, chapter
1.128     wiz      1108:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1109: </div>
                   1110: </div>
                   1111: </div>
                   1112: </div>
1.148     asau     1113: <div class="chapter">
1.75      rillig   1114: <div class="titlepage"><div><div><h2 class="title">
                   1115: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1116: <div class="toc">
                   1117: <p><b>Table of Contents</b></p>
1.210     leot     1118: <dl class="toc">
1.82      rillig   1119: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1120: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1121: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1122: <dd><dl>
1.151     obache   1123: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                   1124: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                   1125: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166     jnemeth  1126: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
                   1127: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
                   1128: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
                   1129: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
                   1130: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
                   1131: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
                   1132: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75      rillig   1133: </dl></dd>
                   1134: </dl>
                   1135: </div>
1.148     asau     1136: <div class="sect1">
1.75      rillig   1137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1138: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1139: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.82      rillig   1140: </div>
1.148     asau     1141: <div class="sect1">
1.82      rillig   1142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1143: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1144: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1145:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1146:     to privileged one all programs are installed under one particular user
1.149     asau     1147:     and cannot utilise privileged operations (packages don't create
                   1148:     special users and all special file permissions like setuid are ignored).
                   1149:     </p>
1.82      rillig   1150: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1151: <pre class="screen">
1.167     asau     1152: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75      rillig   1153: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1154: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1155:     </pre>
1.149     asau     1156: <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>
                   1157: <p>By default, in privileged mode pkgsrc uses
                   1158:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1159:     where programs will be installed in,
1.87      wiz      1160:     and <code class="filename">/var/db/pkg</code> for the package database
1.149     asau     1161:     directory where pkgsrc will do its internal bookkeeping,
                   1162:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1163:     where packages install their persistent data.
                   1164:     In unprivileged mode pkgsrc uses
                   1165:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
                   1166:     <code class="filename">~/pkg/var/db/pkg</code> for the package database,
                   1167:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1168:     </p>
                   1169: <p>You can change default layout using command-line arguments.
                   1170:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1171:     </p>
1.148     asau     1172: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1173: <h3 class="title">Note</h3>
1.110     hubertf  1174: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1175:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1176:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1177:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1178: </div>
1.149     asau     1179: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1180: <h3 class="title">Note</h3>
                   1181: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1182:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1183:       corresponding to the installation you're working with to build
                   1184:       and install packages.
                   1185:       </p>
                   1186: </div>
1.75      rillig   1187: </div>
1.148     asau     1188: <div class="sect1">
1.75      rillig   1189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1190: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1191: <p>Here are some platform-specific notes you should be aware of.</p>
1.148     asau     1192: <div class="sect2">
1.75      rillig   1193: <div class="titlepage"><div><div><h3 class="title">
1.151     obache   1194: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
                   1195: <p>Cygwin 1.7.x and later are supported.</p>
                   1196: <p>You need to install minimal base packages in `Base' category
                   1197:       plus any of compiler, gcc, gcc4, and/or clang.
                   1198:       For gcc and gcc4, C and C++ compiler will be installed by default,
                   1199:       but you can install Fortran compiler additionally
                   1200:       because it will be required to use libtool.
                   1201:       If it is not installed (or too old), Fortran compiler will be
                   1202:       installed with pkgsrc automatically.</p>
                   1203: <p>As noted in
                   1204:       <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
                   1205:       su(1) command has been in Cygwin distribution, but it has never worked.
                   1206:       Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
                   1207:       </p>
                   1208: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
                   1209:           then pick "Run as administrator".</p></li></ul></div>
                   1210: </div>
                   1211: <div class="sect2">
                   1212: <div class="titlepage"><div><div><h3 class="title">
                   1213: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.211     sevan    1214: <p>Darwin 8.x and up are supported.</p>
1.148     asau     1215: <p>Before you start, you need to download and install
                   1216:       the Mac OS X Developer Tools from Apple's Developer Connection.
                   1217:       This requires (free) membership. See
1.126     jakllsch 1218:       <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148     asau     1219:       for details. Also, make sure you install X11 (an optional
                   1220:       package included with the Developer Tools) if you intend
                   1221:       to build packages that use the X11 Window System.
                   1222:       (If you don't want or need the full Xcode GUI,
                   1223:       download and install Command Line Tools for Xcode.)</p>
1.75      rillig   1224: </div>
1.148     asau     1225: <div class="sect2">
1.75      rillig   1226: <div class="titlepage"><div><div><h3 class="title">
1.151     obache   1227: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136     dholland 1228: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87      wiz      1229:       other versions may work.</p>
1.75      rillig   1230: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1231:       with the FreeBSD userland tools. There are several steps:</p>
1.128     wiz      1232: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1233: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87      wiz      1234:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1235:          recommended that you choose a different location (e.g.
                   1236:          <code class="filename">/usr/pkgdb</code>) by
                   1237:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.128     wiz      1238: <li class="listitem">
1.75      rillig   1239: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1240:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1241: <pre class="screen">
                   1242: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1243: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1244: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1245: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1246: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1247:          </pre>
1.75      rillig   1248: </li>
1.128     wiz      1249: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1250:          <code class="filename">/etc/mk.conf.example</code> file
                   1251:          when you use the bootstrap script.</p></li>
1.75      rillig   1252: </ol></div>
                   1253: </div>
1.148     asau     1254: <div class="sect2">
1.75      rillig   1255: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1256: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
                   1257: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
                   1258:       Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
                   1259: <p> You should install ncurses (libncurses and libncurses-dev)
                   1260:       packages.</p>
                   1261: </div>
                   1262: <div class="sect2">
                   1263: <div class="titlepage"><div><div><h3 class="title">
                   1264: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.75      rillig   1265: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1266:       providing a Unix-like environment with a tighter kernel integration than
                   1267:       available with Cygwin.  It is part of the Windows Services for Unix
                   1268:       package, available for free for any licensed copy of Windows 2000, XP
1.110     hubertf  1269:       (not including XP Home), or 2003.  SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93      rillig   1270: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1271:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1272:       of pthreads, but other parts of libc may also be lacking.)</p>
1.129     wiz      1273: <p>Services for Unix Applications (aka SUA) is an integrated
                   1274:       component of Windows Server 2003 R2 (5.2), Windows Vista and
                   1275:       Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
                   1276:       (6.1).  As of this writing, the SUA's Interix 6.0 (32bit) and
                   1277:       6.1 (64bit) subsystems have been tested.  Other versions may
                   1278:       work as well. The Interix 5.x subsystem has not yet been tested
                   1279:       with pkgsrc.</p>
1.148     asau     1280: <div class="sect3">
1.75      rillig   1281: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1282: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1283: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1284:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148     asau     1285: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1286: <li class="listitem"><p>Utilities -&gt; Base Utilities</p></li>
                   1287: <li class="listitem"><p>Interix GNU Components -&gt; (all)</p></li>
                   1288: <li class="listitem"><p>Remote Connectivity</p></li>
                   1289: <li class="listitem"><p>Interix SDK</p></li>
1.75      rillig   1290: </ul></div>
                   1291: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1292:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1293:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1294:        pkgsrc (or from a binary package).</p>
1.75      rillig   1295: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1296:        not need to be installed, but Remote Connectivity itself should be
                   1297:        installed in order to have a working inetd.</p>
1.75      rillig   1298: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1299:        behavior for Interix programs, and whether to make pathnames default to
                   1300:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1301:        enabled.  (Without case-sensitivity, a large number of packages including
                   1302:        perl will not build.)</p>
1.75      rillig   1303: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1304:        works (via the Data Execution Prevention feature).  In order to use
                   1305:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1306:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1307:        must be installed.  Hotfixes are available from Microsoft through a
1.114     jmcneill 1308:        support contract; however, Debian Interix Port has made most Interix
                   1309:        hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.93      rillig   1310: <p>In addition to the hotfix noted above, it may be necessary to
                   1311:        disable Data Execution Prevention entirely to make Interix functional.
                   1312:        This may happen only with certain types of CPUs; the cause is not fully
                   1313:        understood at this time.  If gcc or other applications still segfault
                   1314:        repeatedly after installing one of the hotfixes note above, the
                   1315:        following option can be added to the appropriate "boot.ini" line on the
                   1316:        Windows boot drive:  /NoExecute=AlwaysOff
                   1317:        (WARNING, this will disable DEP completely, which may be a security
                   1318:        risk if applications are often run as a user in the Administrators
                   1319:        group!)</p>
1.75      rillig   1320: </div>
1.148     asau     1321: <div class="sect3">
1.75      rillig   1322: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1323: <a name="platform.interix-sfu-postinstall"></a>3.3.5.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75      rillig   1324: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1325:        with pkgsrc, note the following things.</p>
1.148     asau     1326: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1327: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1328:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1329:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.128     wiz      1330: <li class="listitem">
1.75      rillig   1331: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1332:            change the following registry key:</p>
1.75      rillig   1333: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1334: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1335: </li>
1.128     wiz      1336: <li class="listitem">
1.75      rillig   1337: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1338:            following registry key:</p>
1.75      rillig   1339: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1340: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1341: </li>
                   1342: </ul></div>
                   1343: </div>
1.148     asau     1344: <div class="sect3">
1.75      rillig   1345: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1346: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1347: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1348:        running "pkg_add") must be a member of the local Administrators
                   1349:        group.  Such a user must also be used to run the bootstrap.  This is
                   1350:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1351: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1352:        automatically complain if this is not the case.  This ensures that
                   1353:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1354: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1355:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1356:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1357:        the same time as the pkgsrc packages, ensure that you use the proper
                   1358:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1359: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1360:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1361:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1362:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1363: <pre class="programlisting">
1.100     rillig   1364: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87      wiz      1365:        </pre>
1.75      rillig   1366: </div>
1.148     asau     1367: <div class="sect3">
1.75      rillig   1368: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1369: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1370: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1371:        for a full Unix-like platform, it has some drawbacks that should
                   1372:        be noted for those desiring to make the most of Interix.</p>
1.148     asau     1373: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1374: <li class="listitem">
1.75      rillig   1375: <p><span class="strong"><strong>X11:</strong></span></p>
                   1376: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1377:          and can run X11 based applications, but it does
                   1378:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.110     hubertf  1379:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1380:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87      wiz      1381:          (available in a trimmed version for Interix from Interop Systems as the
1.110     hubertf  1382:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87      wiz      1383:          and the free X11 server included with
1.110     hubertf  1384:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1385: </li>
1.128     wiz      1386: <li class="listitem">
1.75      rillig   1387: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1388: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1389:          Win32 applications, it does not currently support various X11
                   1390:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1391:          Most interactive applications to a local X server will run
                   1392:          reasonably fast, but full motion video and other graphics
                   1393:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1394: </li>
1.128     wiz      1395: <li class="listitem">
1.75      rillig   1396: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1397: <p>Interix has no native support for audio output.  For audio
1.110     hubertf  1398:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87      wiz      1399:          audio system on Interix.  Unlike on most platforms, the
1.189     snj      1400:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.110     hubertf  1401:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87      wiz      1402:          server component.  To output audio via an Interix host, the
1.189     snj      1403:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1.87      wiz      1404:          must also be installed.</p>
1.75      rillig   1405: </li>
1.128     wiz      1406: <li class="listitem">
1.75      rillig   1407: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1408: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1409:          is not currently possible to access CD/DVD drives, USB devices,
                   1410:          or SCSI devices through non-filesystem means.  Among other things,
                   1411:          this makes it impossible to use Interix directly for CD/DVD
                   1412:          burning.</p>
1.75      rillig   1413: </li>
1.128     wiz      1414: <li class="listitem">
1.75      rillig   1415: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1416: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1417:          drives are also not directly accessible in Interix.  However,
                   1418:          support is in work to make tape drive access possible by using
                   1419:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1420:          esound server).</p>
1.75      rillig   1421: </li>
                   1422: </ul></div>
                   1423: </div>
1.148     asau     1424: <div class="sect3">
1.75      rillig   1425: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1426: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1427: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1428:        Windows system; any member of the local Administrators group will
                   1429:        suffice.  However, some packages currently assume that the user
                   1430:        named "root" is the privileged user.  To accommodate these, you
                   1431:        may create such a user; make sure it is in the local group
                   1432:        Administrators (or your language equivalent).</p>
1.110     hubertf  1433: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87      wiz      1434:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1435:        time being, install packages as the local Administrator (or
                   1436:        your language equivalent), or run the following command after
                   1437:        installing a package to work around the issue:</p>
1.75      rillig   1438: <pre class="screen">
1.87      wiz      1439: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1440:        </pre>
1.75      rillig   1441: </div>
                   1442: </div>
1.148     asau     1443: <div class="sect2">
1.75      rillig   1444: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1445: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75      rillig   1446: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1447:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1448:       according to your preference.  If you do not have a license for the MIPSpro
1.110     hubertf  1449:       compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75      rillig   1450: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.189     snj      1451:       version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87      wiz      1452:       etc.</p>
1.86      schwarz  1453: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1454:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1455:        you start out using "abi=n32", that's what all your packages will be built
                   1456:        with.</p>
                   1457: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1458:       <code class="varname">CFLAGS</code> in your environment or the
1.110     hubertf  1459:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.87      wiz      1460:       try to link n32 object files with lib64 or vice versa.  Check your
                   1461:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1462: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1463:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1464:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1465:       link over a network-mounted file system.</p>
1.75      rillig   1466: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1467:       as imake(1), but you may want to set some options depending on your local
                   1468:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1469:       course, your compiler's man pages for details.</p>
1.75      rillig   1470: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1471: 
1.87      wiz      1472:       </p>
1.75      rillig   1473: <pre class="programlisting">
1.100     rillig   1474: PKGSRC_COMPILER=        mipspro
1.87      wiz      1475:       </pre>
1.75      rillig   1476: <p>
1.1       grant    1477: 
1.110     hubertf  1478:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.87      wiz      1479:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1480:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1481:       default.</p>
1.75      rillig   1482: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1483:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1484:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1485:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1486:       '--preserve-path' flag.</p>
1.75      rillig   1487: </div>
1.148     asau     1488: <div class="sect2">
1.75      rillig   1489: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1490: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87      wiz      1491: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1492:       either libtermcap or libcurses (libncurses).  Installing the
                   1493:       distributions libncurses-dev package (or equivalent) should fix
                   1494:       the problem.</p>
                   1495: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1496:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1497:       i386 have been tested.</p>
1.75      rillig   1498: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1499:       directory:</p>
1.75      rillig   1500: <pre class="programlisting">
1.138     wiz      1501: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87      wiz      1502:       </pre>
1.148     asau     1503: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1504: <h3 class="title">Note</h3>
1.138     wiz      1505: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
                   1506: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
                   1507: <p>For icc 10.1 neither of these appears to be necessary.</p>
                   1508: </div>
                   1509: <p>Use a value for ICCBASE that corresponds to the directory
                   1510:       where icc is installed. After bootstrapping, set
                   1511:       <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137     wiz      1512: <pre class="programlisting">
1.138     wiz      1513: ICCBASE=                /opt/intel/cc/10.1.008
1.87      wiz      1514:       </pre>
1.138     wiz      1515: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
                   1516:       <code class="filename">/opt/intel_cc_80</code>. This is the default
                   1517:       install directory for icc 8.0. If you are using a more recent
                   1518:       version, be sure to set the correct path explicitly.
                   1519:       </p>
1.75      rillig   1520: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1521:       provided by icc, so binaries can be run on other systems which do not
                   1522:       have the shared libraries installed.</p>
                   1523: <p>Libtool, however, extracts a list of libraries from the
1.189     snj      1524:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87      wiz      1525:       records it, throwing away the -Bstatic and -Bdynamic options
                   1526:       interspersed between the libraries.  This means that
                   1527:       libtool-linked C++ shared libraries will have a runtime
                   1528:       dependency on the icc libraries until this is fixed in
                   1529:       libtool.</p>
1.75      rillig   1530: </div>
1.148     asau     1531: <div class="sect2">
1.75      rillig   1532: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1533: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163     bsiegert 1534: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
                   1535:       Older versions might also work. Releases before #10 are not
                   1536:       supported.</p>
                   1537: <p>The package tools of the (older) native ports tree,
                   1538:       <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
                   1539:       have the same names as the ones used by pkgsrc. Care should be taken
                   1540:       that the right tools are used. When installing packages from source,
                   1541:       use the <code class="filename">bmake</code> command for pkgsrc and
                   1542:       <code class="filename">mmake</code> for MirPorts.</p>
                   1543: <p>pkgsrc and MirPorts use the same location for the package
                   1544:       database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
                   1545:       to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
                   1546:       tree is self-contained. This is also the default setting used in the
                   1547:       binary package builds.</p>
                   1548: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
                   1549:       server. The bootstrap kit there already contains the
                   1550:       <span class="command"><strong>pkgin</strong></span> package manager. See the
                   1551:       <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
                   1552:       page for more details.</p>
                   1553: </div>
                   1554: <div class="sect2">
                   1555: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1556: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136     dholland 1557: <p>OpenBSD 5.1 has been tested and supported,
                   1558:       other versions may work.</p>
1.75      rillig   1559: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1560:       with the OpenBSD userland tools. There are several steps:</p>
1.128     wiz      1561: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1562: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87      wiz      1563:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1564:          recommended that you choose a different location (e.g.
                   1565:          <code class="filename">/usr/pkgdb</code>) by
                   1566:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.128     wiz      1567: <li class="listitem">
1.75      rillig   1568: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1569:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1570: <pre class="screen">
                   1571: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1572: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1573: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1574: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1575: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1576:          </pre>
1.75      rillig   1577: </li>
1.128     wiz      1578: <li class="listitem">
1.110     hubertf  1579: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1580:          <code class="filename">/etc/mk.conf.example</code> file
                   1581:          when you use the bootstrap script. OpenBSD's make program uses
1.110     hubertf  1582:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87      wiz      1583:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1584:          of the file with:</p>
                   1585: <pre class="programlisting">
1.100     rillig   1586: .ifdef BSD_PKG_MK
                   1587: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1588: .else
                   1589: # OpenBSD stuff
                   1590: .endif
1.87      wiz      1591:          </pre>
1.75      rillig   1592: </li>
                   1593: </ol></div>
                   1594: </div>
1.148     asau     1595: <div class="sect2">
1.75      rillig   1596: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1597: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142     wiz      1598: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
                   1599:       You will need a working C compiler. Both gcc 4.5.3 and
1.87      wiz      1600:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1601: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1602:       process and to build packages.</p>
1.148     asau     1603: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1604: <li class="listitem"><p>SUNWsprot</p></li>
                   1605: <li class="listitem"><p>SUNWarc</p></li>
                   1606: <li class="listitem"><p>SUNWbtool</p></li>
                   1607: <li class="listitem"><p>SUNWtoo</p></li>
                   1608: <li class="listitem"><p>SUNWlibm</p></li>
1.75      rillig   1609: </ul></div>
1.78      rillig   1610: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1611:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1612: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1613:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1614:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1615:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148     asau     1616: <div class="sect3">
1.75      rillig   1617: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1618: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1619: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1620:        for building all packages.</p>
1.75      rillig   1621: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1622:        then either build gcc from
1.189     snj      1623:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.87      wiz      1624:        package, then remove gcc used during bootstrapping.</p>
1.110     hubertf  1625: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75      rillig   1626: </div>
1.148     asau     1627: <div class="sect3">
1.75      rillig   1628: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1629: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1630: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1631:        5.0)</p>
1.148     asau     1632: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1633: <li class="listitem"><p>SPROcc
1.87      wiz      1634:          - Sun WorkShop Compiler C 5.0</p></li>
1.128     wiz      1635: <li class="listitem"><p>SPROcpl
1.87      wiz      1636:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.128     wiz      1637: <li class="listitem"><p>SPROild
1.87      wiz      1638:          - Sun WorkShop Incremental Linker</p></li>
1.128     wiz      1639: <li class="listitem"><p>SPROlang
1.87      wiz      1640:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1641: </ul></div>
1.96      rillig   1642: <p>You should set the following variables in your
1.110     hubertf  1643:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96      rillig   1644: <pre class="programlisting">
1.100     rillig   1645: CC=     cc
                   1646: CXX=    CC
                   1647: CPP=    cc -E
                   1648: CXXCPP= CC -E
1.96      rillig   1649: </pre>
1.148     asau     1650: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96      rillig   1651: <h3 class="title">Note</h3>
                   1652: <p>The <code class="varname">CPP</code> setting might break some
                   1653:        packages that use the C preprocessor for processing things other
                   1654:        than C source code.</p>
                   1655: </div>
1.75      rillig   1656: </div>
1.148     asau     1657: <div class="sect3">
1.75      rillig   1658: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1659: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1660: <p>To build 64-bit packages, you just need to have the
1.110     hubertf  1661:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75      rillig   1662: <pre class="programlisting">
1.100     rillig   1663: PKGSRC_COMPILER=        sunpro
                   1664: ABI=                    64
1.96      rillig   1665: </pre>
1.148     asau     1666: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96      rillig   1667: <h3 class="title">Note</h3>
                   1668: <p>This setting has been tested for the SPARC
                   1669:        architecture. Intel and AMD machines need some more
                   1670:        work.</p>
                   1671: </div>
1.75      rillig   1672: </div>
1.148     asau     1673: <div class="sect3">
1.75      rillig   1674: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1675: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110     hubertf  1676: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87      wiz      1677:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1678:       The workaround is to use another shell for the configure
1.189     snj      1679:       scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.110     hubertf  1680:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87      wiz      1681: <pre class="programlisting">
1.100     rillig   1682: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1683: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1.87      wiz      1684:       </pre>
1.189     snj      1685: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1.75      rillig   1686: </div>
                   1687: </div>
                   1688: </div>
                   1689: </div>
1.148     asau     1690: <div class="chapter">
1.75      rillig   1691: <div class="titlepage"><div><div><h2 class="title">
                   1692: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1693: <div class="toc">
                   1694: <p><b>Table of Contents</b></p>
1.210     leot     1695: <dl class="toc">
1.75      rillig   1696: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1697: <dd><dl>
                   1698: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1699: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1700: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1701: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1702: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1703: <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>
                   1704: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1705: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1706: </dl></dd>
                   1707: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1708: <dd><dl>
                   1709: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1710: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1711: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1712: </dl></dd>
                   1713: </dl>
                   1714: </div>
                   1715: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1716: is to only install the package tools and to use binary packages
1.128     wiz      1717: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1718: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1719: of pkgsrc, too. Then you are able to build your own packages,
                   1720: and you can still use binary packages from someone else.</p>
1.148     asau     1721: <div class="sect1">
1.75      rillig   1722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1723: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1724: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1725:   server and its mirrors, there are collections of binary packages,
                   1726:   ready to be installed. These binary packages have been built using the
                   1727:   default settings for the directories, that is:</p>
1.148     asau     1728: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1729: <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>
                   1730: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1731: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.109     rillig   1732: </ul></div>
                   1733: <p>If you cannot use these directories for whatever reasons (maybe
                   1734:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1735:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.148     asau     1736: <div class="sect2">
1.75      rillig   1737: <div class="titlepage"><div><div><h3 class="title">
                   1738: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1739: <p>To install binary packages, you first need to know from where
                   1740:     to get them. The first place where you should look is on the main
1.110     hubertf  1741:     pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105     weinem   1742: <p>This directory contains binary packages for multiple
                   1743:     platforms. First, select your operating system. (Ignore the
                   1744:     directories with version numbers attached to it, they just exist for
                   1745:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1746:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1747: <p>In this directory, you often find a file called
                   1748:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1749:     management tools. If the file is missing, it is likely that your
                   1750:     operating system already provides those tools. Download the file and
                   1751:     extract it in the <code class="filename">/</code> directory. It will create
                   1752:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1753:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1754:     (the database of installed packages).</p>
1.75      rillig   1755: </div>
1.148     asau     1756: <div class="sect2">
1.75      rillig   1757: <div class="titlepage"><div><div><h3 class="title">
                   1758: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1759: <p>In the directory from the last section, there is a
1.196     wiz      1760:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1761:     binary packages that are available for the platform, excluding those
                   1762:     that may not be distributed via FTP or CDROM (depending on which
1.128     wiz      1763:     medium you are using).</p>
1.109     rillig   1764: <p>To install packages directly from an FTP or HTTP server, run
                   1765:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1766:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1767: <pre class="screen">
                   1768: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.196     wiz      1769: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.109     rillig   1770: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1771: </pre>
                   1772: <p>Instead of URLs, you can also use local paths, for example if
                   1773:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1774:     repository. If you want to install packages from multiple sources,
                   1775:     you can separate them by a semicolon in
                   1776:     <code class="varname">PKG_PATH</code>.</p>
                   1777: <p>After these preparations, installing a package is very
                   1778:     easy:</p>
                   1779: <pre class="screen">
                   1780: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1781: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1782: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1783: </pre>
1.75      rillig   1784: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1785:     package in question will be installed, too, assuming they are
                   1786:     present where you install from.</p>
1.128     wiz      1787: <p>Adding packages might install vulnerable packages.
                   1788:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
                   1789:     regularly, especially after installing new packages, and verify
                   1790:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1791: <p>After you've installed packages, be sure to have
1.88      wiz      1792:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1793:     <code class="varname">PATH</code> so you can actually start the just
                   1794:     installed program.</p>
1.75      rillig   1795: </div>
1.148     asau     1796: <div class="sect2">
1.75      rillig   1797: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1798: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1799: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1800:     installed from source code or from a binary package. The
1.110     hubertf  1801:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1802:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1803:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1804:     name can be given with or without version number. Wildcards can
                   1805:     also be used to deinstall a set of packages, for example
                   1806:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1807:     so that the shell does not expand them before
                   1808:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1809: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1810:     removes all the packages that require the package in question
                   1811:     and then removes the package itself. For example:
1.82      rillig   1812: 
1.88      wiz      1813:     </p>
1.82      rillig   1814: <pre class="screen">
1.88      wiz      1815: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1816:     </pre>
1.82      rillig   1817: <p>
                   1818: 
1.88      wiz      1819:     will remove jpeg and all the packages that used it; this allows
                   1820:     upgrading the jpeg package.</p>
1.82      rillig   1821: </div>
1.148     asau     1822: <div class="sect2">
1.82      rillig   1823: <div class="titlepage"><div><div><h3 class="title">
                   1824: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1825: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1826:     installed packages or binary package files.</p>
1.82      rillig   1827: </div>
1.148     asau     1828: <div class="sect2">
1.82      rillig   1829: <div class="titlepage"><div><div><h3 class="title">
                   1830: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1831: <p>
1.88      wiz      1832:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1833:       known security vulnerabilities to packages which are (or have been)
                   1834:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1835:       FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.88      wiz      1836:     </p>
1.82      rillig   1837: <p>
1.125     wiz      1838:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1839:       this list can be downloaded
                   1840:       automatically, and a security audit of all packages installed on a system
                   1841:       can take place.
                   1842:     </p>
1.82      rillig   1843: <p>
1.125     wiz      1844:       There are two components to auditing.  The first
                   1845:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1846:       is for downloading
1.88      wiz      1847:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1848:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1849:       installed packages are vulnerable.  If a package is vulnerable, you
                   1850:       will see output similar to the following:
                   1851:     </p>
1.82      rillig   1852: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1853:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1854: <p>
1.125     wiz      1855:       You may wish to have the
1.110     hubertf  1856:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1857:       file downloaded daily so that
                   1858:       it remains current.  This may be done by adding an appropriate entry
1.189     snj      1859:       to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1860:       </p>
                   1861: <pre class="screen">
                   1862: # download vulnerabilities file
                   1863: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
                   1864:       </pre>
                   1865: <p>
                   1866:       will update the vulnerability list every day at 3AM. You may wish to do
                   1867:       this more often than once a day.
                   1868: 
                   1869:       In addition, you may wish to run the package audit from the daily
                   1870:       security script.  This may be accomplished by adding the following
                   1871:       line to <code class="filename">/etc/security.local</code>:
                   1872:       </p>
                   1873: <pre class="screen">
                   1874: /usr/sbin/pkg_admin audit
                   1875:       </pre>
                   1876: <p>
1.88      wiz      1877:     </p>
1.82      rillig   1878: </div>
1.148     asau     1879: <div class="sect2">
1.82      rillig   1880: <div class="titlepage"><div><div><h3 class="title">
                   1881: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1882: <p>
1.189     snj      1883:       Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128     wiz      1884:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.88      wiz      1885:       argument to check if your packages are up-to-date, e.g.
                   1886:     </p>
                   1887: <pre class="screen">
                   1888: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1889: ...
1.88      wiz      1890: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1891:     </pre>
1.110     hubertf  1892: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1893:     package on your system and rebuild any dependencies.
                   1894:     </p>
1.82      rillig   1895: </div>
1.148     asau     1896: <div class="sect2">
1.82      rillig   1897: <div class="titlepage"><div><div><h3 class="title">
                   1898: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1899: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1900:     administrative functions on the package system.</p>
1.82      rillig   1901: </div>
1.148     asau     1902: <div class="sect2">
1.82      rillig   1903: <div class="titlepage"><div><div><h3 class="title">
                   1904: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   1905: <p>Please pay very careful attention to the warnings
1.189     snj      1906:     expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88      wiz      1907:     inherent dangers of installing binary packages which you did
                   1908:     not create yourself, and the security holes that can be
                   1909:     introduced onto your system by indiscriminate adding of such
                   1910:     files.</p>
1.75      rillig   1911: <p>The same warning of course applies to every package you
1.88      wiz      1912:     install from source when you haven't completely read and
                   1913:     understood the source code of the package, the compiler that
                   1914:     is used to build the package and all the other tools that are
                   1915:     involved.</p>
1.75      rillig   1916: </div>
                   1917: </div>
1.148     asau     1918: <div class="sect1">
1.75      rillig   1919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1920: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1921: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1922:   directory now contains a set of packages, organized into
                   1923:   categories. You can browse the online index of packages, or run
1.110     hubertf  1924:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1925:   directory to build local <code class="filename">README.html</code> files for
1.189     snj      1926:   all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1927: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1928:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1929:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1930:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1931:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1932:   system (inside a chroot is an exception). </p>
                   1933: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1934:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.88      wiz      1935:   instructions how to create your own packages.</p>
1.148     asau     1936: <div class="sect2">
1.75      rillig   1937: <div class="titlepage"><div><div><h3 class="title">
                   1938: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1939: <p>To build packages from source, you need a working C
1.88      wiz      1940:     compiler. On NetBSD, you need to install the
1.128     wiz      1941:     <span class="quote">&#8220;<span class="quote">comp</span>&#8221;</span> and the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> distribution
1.88      wiz      1942:     sets. If you want to build X11-related packages, the
1.128     wiz      1943:     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1.88      wiz      1944:     sets are required, too.</p>
1.75      rillig   1945: </div>
1.148     asau     1946: <div class="sect2">
1.75      rillig   1947: <div class="titlepage"><div><div><h3 class="title">
                   1948: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1949: <p>The first step for building a package is downloading the
1.88      wiz      1950:     distfiles (i.e. the unmodified source). If they have not yet been
                   1951:     downloaded, pkgsrc will fetch them automatically.</p>
                   1952: <p>If you have all files that you need in the
                   1953:     <code class="filename">distfiles</code> directory,
                   1954:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1955:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1956:     </p>
1.82      rillig   1957: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1958: <p>
1.110     hubertf  1959:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1960: <p>By default a list of distribution sites will be randomly
                   1961:     intermixed to prevent huge load on servers which holding popular
                   1962:     packages (for example, SourceForge.net mirrors). Thus, every
                   1963:     time when you need to fetch yet another distfile all the mirrors
                   1964:     will be tried in new (random) order. You can turn this feature
                   1965:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1966:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1967: <p>You can overwrite some of the major distribution sites to
                   1968:     fit to sites that are close to your own.  By setting one or two
                   1969:     variables you can modify the order in which the master sites are
                   1970:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1971:     delimited list of domain suffixes.
                   1972:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1973:     contains a whitespace delimited list of regular expressions.  It
                   1974:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1975:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1976:     some examples.  This may save some of your bandwidth and
                   1977:     time.</p>
1.75      rillig   1978: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1979:     if you want to keep the settings, by editing the
1.110     hubertf  1980:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1981:     and adding the definitions there.</p>
1.82      rillig   1982: <p>
1.88      wiz      1983:       If a package depends on many other packages (such as
1.189     snj      1984:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.88      wiz      1985:       alternate between periods of
                   1986:       downloading source, and compiling. To ensure you have all the source
                   1987:       downloaded initially you can run the command:
                   1988:       </p>
1.82      rillig   1989: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1990: <p>
1.88      wiz      1991:       which will output and run a set of shell commands to fetch the
                   1992:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1993:       also choose to download the files manually.
                   1994:     </p>
1.75      rillig   1995: </div>
1.148     asau     1996: <div class="sect2">
1.75      rillig   1997: <div class="titlepage"><div><div><h3 class="title">
                   1998: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1999: <p>
1.88      wiz      2000:       Once the software has downloaded, any patches will be applied, then it
                   2001:       will be compiled for you. This may take some time depending on your
                   2002:       computer, and how many other packages the software depends on and their
                   2003:       compile time.
                   2004:     </p>
1.148     asau     2005: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   2006: <h3 class="title">Note</h3>
                   2007: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  2008:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      2009:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   2010: </div>
1.87      wiz      2011: <p>For example, type</p>
1.88      wiz      2012: <pre class="screen">
                   2013: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2014: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   2015:     </pre>
1.75      rillig   2016: <p>at the shell prompt to build the various components of the
1.88      wiz      2017:     package.</p>
1.82      rillig   2018: <p>The next stage is to actually install the newly compiled
1.88      wiz      2019:     program onto your system. Do this by entering:
1.82      rillig   2020: 
1.88      wiz      2021:     </p>
1.82      rillig   2022: <pre class="screen">
1.88      wiz      2023: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   2024:     </pre>
1.82      rillig   2025: <p>
                   2026: 
1.88      wiz      2027:     while you are still in the directory for whatever package you
                   2028:     are installing.</p>
1.82      rillig   2029: <p>Installing the package on your system may require you to
1.88      wiz      2030:     be root.  However, pkgsrc has a
                   2031:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   2032:     to only become root for the actual installation step.</p>
1.82      rillig   2033: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      2034:     You can now enter:
1.82      rillig   2035: 
1.88      wiz      2036:     </p>
1.82      rillig   2037: <pre class="screen">
1.88      wiz      2038: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   2039:     </pre>
1.82      rillig   2040: <p>
                   2041: 
1.88      wiz      2042:     to remove the compiled files in the work directory, as you shouldn't need
                   2043:     them any more. If other packages were also added to your system
                   2044:     (dependencies) to allow your program to compile, you can tidy these up
                   2045:     also with the command:</p>
1.82      rillig   2046: <pre class="screen">
1.88      wiz      2047: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2048:     </pre>
1.75      rillig   2049: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  2050:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88      wiz      2051: <p>The program is installed under the default root of the
                   2052:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2053:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2054:     variable in your environment, and it will use that value as the
                   2055:     root of your packages tree. So, to use
                   2056:     <code class="filename">/usr/local</code>, set
                   2057:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2058:     Please note that you should use a directory which is dedicated to
                   2059:     packages and not shared with other programs (i.e., do not try and
                   2060:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2061:     to add any of your own files or directories (such as
                   2062:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2063:     <code class="filename">pkgsrc/</code>) below the
                   2064:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2065:     conflicts between programs and other files installed by the
                   2066:     package system and whatever else may have been installed
                   2067:     there.</p>
1.110     hubertf  2068: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      2069:     alter some configuration options at build time.  Have a look at
                   2070:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2071:     of what will be set there by default.  Environment variables such
                   2072:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  2073:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      2074:     set them each time you want to use pkgsrc.</p>
1.128     wiz      2075: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   2076:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      2077:     or being installed. This may be for debugging purposes, or out of
                   2078:     simple curiosity. A number of utility values have been added to
                   2079:     help with this.</p>
1.128     wiz      2080: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2081: <li class="listitem">
1.189     snj      2082: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      2083:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2084:        information will be displayed. For example,</p>
1.75      rillig   2085: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2086: <p>will show all the commands that are invoked, up to and
1.128     wiz      2087:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   2088: </li>
1.128     wiz      2089: <li class="listitem">
1.189     snj      2090: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2091:        definition, then the <code class="varname">VARNAME</code> definition
                   2092:        should be used, in conjunction with the show-var
1.189     snj      2093:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2094:        variable <code class="varname">LOCALBASE</code>:</p>
                   2095: <pre class="screen">
                   2096: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2097: /usr/pkg
                   2098: <code class="prompt">%</code>
1.88      wiz      2099:        </pre>
1.75      rillig   2100: </li>
                   2101: </ol></div>
                   2102: <p>If you want to install a binary package that you've either
1.88      wiz      2103:     created yourself (see next section), that you put into
                   2104:     pkgsrc/packages manually or that is located on a remote FTP
                   2105:     server, you can use the "bin-install" target. This target will
1.189     snj      2106:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  2107:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      2108:     sites searched is kept in the variable
                   2109:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.189     snj      2110:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      2111:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2112:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2113:     details.</p>
                   2114: <p>A final word of warning: If you set up a system that has a
                   2115:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2116:     set that before any packages are installed, as you cannot use
                   2117:     several directories for the same purpose. Doing so will result in
                   2118:     pkgsrc not being able to properly detect your installed packages,
                   2119:     and fail miserably. Note also that precompiled binary packages are
                   2120:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2121:     <code class="filename">/usr/pkg</code>, and that you should
                   2122:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2123:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2124: </div>
                   2125: </div>
                   2126: </div>
1.148     asau     2127: <div class="chapter">
1.75      rillig   2128: <div class="titlepage"><div><div><h2 class="title">
                   2129: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2130: <div class="toc">
                   2131: <p><b>Table of Contents</b></p>
1.210     leot     2132: <dl class="toc">
1.75      rillig   2133: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2134: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   2135: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      2136: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2137: <dd><dl>
1.103     wiz      2138: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz      2139: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2140: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      2141: </dl></dd>
1.103     wiz      2142: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2143: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   2144: </dl>
                   2145: </div>
1.104     rillig   2146: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   2147: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2148: that file depends on the installation. On NetBSD, when you use
1.189     snj      2149: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   2150: <code class="filename">/etc/</code>. In all other cases the default location is
                   2151: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2152: bootstrap program to install the binary packages.</p>
                   2153: <p>During the bootstrap, an example configuration file is created. To
                   2154: use that, you have to create the directory
                   2155: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2156: there.</p>
                   2157: <p>The format of the configuration file is that of the usual
                   2158: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2159: is done by setting variables in this file. Note that you can define all
                   2160: kinds of variables, and no special error checking (for example for
                   2161: spelling mistakes) takes place, so you have to try it out to see if it
                   2162: works.</p>
1.148     asau     2163: <div class="sect1">
1.75      rillig   2164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2165: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2166: <p>In this section, you can find some variables that apply to all
1.89      rillig   2167:     pkgsrc packages. A complete list of the variables that can be
                   2168:     configured by the user is available in
                   2169:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2170:     comments that describe each variable's intent.</p>
1.148     asau     2171: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2172: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   2173:            packages will be installed. The default is
1.76      rillig   2174:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2175:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      2176: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   2177:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   2178:            installed. The default is
1.76      rillig   2179:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      2180: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   2181:            X11 is installed on the system. The default is
1.194     bsiegert 2182:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      2183: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   2184:            downloaded copies of the original source distributions used
                   2185:            for building pkgsrc packages. The default is
1.76      rillig   2186:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      2187: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   2188:            database about installed packages is stored.  The default is
                   2189:            <code class="filename">/var/db/pkg</code>.</p></li>
1.128     wiz      2190: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   2191:            If set, override the packages'
                   2192:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      2193: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   2194:            Backup location(s) for distribution files and patch files
                   2195:            if not found locally or in
1.76      rillig   2196:            <code class="filename">${MASTER_SITES}</code> or
                   2197:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2198:            The defaults are
1.132     spz      2199:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2200:            and
1.76      rillig   2201:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      2202: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2203:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2204:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      2205:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   2206:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   2207: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      2208:            List of acceptable licenses. License names are case-sensitive.
                   2209:            Whenever you try to build a package whose license is not in this
                   2210:            list, you will get an error message. If the license condition is
                   2211:            simple enough, the error message will include specific
                   2212:            instructions on how to change this variable.</p></li>
1.75      rillig   2213: </ul></div>
                   2214: </div>
1.148     asau     2215: <div class="sect1">
1.75      rillig   2216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2217: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2218: <p>XXX
                   2219:       </p>
1.148     asau     2220: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2221: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   2222:            directory for the binary packages. The default is
1.76      rillig   2223:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      2224: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   2225:            The top level directory where, if defined, the separate
                   2226:            working directories will get created, and symbolically
1.76      rillig   2227:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2228:            This is useful for building packages on several
1.76      rillig   2229:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2230:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2231:            is local to every architecture. (It should be noted that
                   2232:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 2233:            &mdash; it is an internal definition which refers to the
1.75      rillig   2234:            root of the pkgsrc tree. It is possible to have many
                   2235:            pkgsrc tree instances.)</p></li>
1.128     wiz      2236: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   2237:            Directory for local patches that aren't part of pkgsrc.
1.110     hubertf  2238:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2239:            information.</p></li>
1.128     wiz      2240: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  2241:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   2242:            BSD-style Makefile. If this is not set,
                   2243:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2244:            <code class="filename">/dev/null</code> to avoid picking up
                   2245:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128     wiz      2246: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82      rillig   2247:            By default, dependencies are only installed, and no binary
                   2248:            package is created for them. You can set this variable to
1.174     asau     2249:            <code class="literal">package-install</code> to automatically create binary
1.190     wiz      2250:            packages after installing dependencies. Please note that the
1.194     bsiegert 2251:            <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.190     wiz      2252:            <code class="literal">yes</code> to preserve binary packages when
                   2253:            using the <code class="literal">install</code> as well.</p></li>
1.75      rillig   2254: </ul></div>
                   2255: </div>
1.148     asau     2256: <div class="sect1">
1.75      rillig   2257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   2258: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.217     jnemeth  2259: <p>Packages have to support installation into a
1.103     wiz      2260:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2261:     to be built, before the actual filesystem is touched. DESTDIR
                   2262:     support exists in two variations:</p>
1.148     asau     2263: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2264: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      2265:       installation and packaging is still run as root.</p></li>
                   2266: <li class="listitem"><p>Full DESTDIR support can run the complete
                   2267:       build, installation and packaging as normal user. Root
                   2268:       privileges are only needed to add packages.</p></li>
                   2269: </ul></div>
1.103     wiz      2270: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2271:     clean</code></strong> needs to be run as root.</p>
1.118     imil     2272: <p>Considering the <code class="filename">foo/bar</code> package,
                   2273:     DESTDIR full support can be tested using the following commands
                   2274: 
                   2275: </p>
                   2276: <pre class="programlisting">
                   2277: <code class="prompt">$</code> id
                   2278: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   2279: <code class="prompt">$</code> mkdir $HOME/packages
                   2280: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   2281: </pre>
                   2282: <p>
                   2283: 
                   2284:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   2285:     should be needed
                   2286: 
                   2287: </p>
                   2288: <pre class="programlisting">
1.174     asau     2289: <code class="prompt">$</code> make stage-install
1.118     imil     2290: </pre>
                   2291: <p>
                   2292: 
                   2293:     Create a package without root privileges
                   2294: 
                   2295: </p>
                   2296: <pre class="programlisting">
1.174     asau     2297: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     2298: </pre>
                   2299: <p>
                   2300: 
                   2301:     For the following command, you must be able to gain root
1.189     snj      2302:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     2303: 
                   2304: </p>
                   2305: <pre class="programlisting">
1.174     asau     2306: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     2307: </pre>
                   2308: <p>
                   2309: 
                   2310:     Then, as a simple user
                   2311: 
                   2312: </p>
                   2313: <pre class="programlisting">
                   2314: <code class="prompt">$</code> make clean
                   2315: </pre>
                   2316: <p>
                   2317: 
                   2318:     </p>
1.103     wiz      2319: </div>
1.148     asau     2320: <div class="sect1">
1.103     wiz      2321: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2322: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     2323: <div class="sect2">
1.78      rillig   2324: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2325: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   2326: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2327:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     2328: <div class="variablelist"><dl class="variablelist">
1.89      rillig   2329: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2330: <dd>
                   2331: <p>This is a list of values specifying the chain of
                   2332:          compilers to invoke when building packages.  Valid values
                   2333:          are:</p>
1.148     asau     2334: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     2335: <li class="listitem"><p><code class="varname">ccc</code>:
                   2336:            Compaq C Compilers (Tru64)</p></li>
                   2337: <li class="listitem"><p><code class="varname">ccache</code>:
                   2338:            compiler cache (chainable)</p></li>
                   2339: <li class="listitem"><p><code class="varname">clang</code>:
                   2340:            Clang C and Objective-C compiler</p></li>
1.128     wiz      2341: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   2342:            distributed C/C++ (chainable)</p></li>
1.174     asau     2343: <li class="listitem"><p><code class="varname">f2c</code>:
                   2344:            Fortran 77 to C compiler (chainable)</p></li>
                   2345: <li class="listitem"><p><code class="varname">icc</code>:
                   2346:            Intel C++ Compiler (Linux)</p></li>
                   2347: <li class="listitem"><p><code class="varname">ido</code>:
                   2348:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      2349: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   2350:            GNU C/C++ Compiler</p></li>
1.174     asau     2351: <li class="listitem"><p><code class="varname">hp</code>:
                   2352:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      2353: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   2354:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     2355: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   2356:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      2357: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   2358:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     2359: <li class="listitem"><p><code class="varname">xlc</code>:
                   2360:            IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.89      rillig   2361: </ul></div>
                   2362: <p>The default is
1.128     wiz      2363:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   2364:          <code class="varname">ccache</code> and/or
                   2365:          <code class="varname">distcc</code> with an appropriate
                   2366:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      2367:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 2368:          variable should always be terminated with a value for
                   2369:          a real compiler.  Note that only one real compiler
1.128     wiz      2370:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 2371:          is not allowed).</p>
1.89      rillig   2372: </dd>
                   2373: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2374: <dd><p>This specifies the minimum version of GCC to use
                   2375:          when building packages.  If the system GCC doesn't
                   2376:          satisfy this requirement, then pkgsrc will build and
                   2377:          install one of the GCC packages to use instead.</p></dd>
                   2378: </dl></div>
                   2379: </div>
1.148     asau     2380: <div class="sect2">
1.89      rillig   2381: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2382: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   2383: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2384:        please make sure to use the <code class="literal">+=</code> operator
                   2385:        instead of the <code class="literal">=</code> operator:</p>
                   2386: <pre class="programlisting">
1.100     rillig   2387: CFLAGS+=        -your -flags
1.78      rillig   2388: </pre>
                   2389: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      2390:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  2391:        need to add their own flags.  You may want to take a look
1.189     snj      2392:        at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128     wiz      2393:        package if you're interested in optimization specifically
                   2394:        for the current CPU. </p>
1.78      rillig   2395: </div>
1.148     asau     2396: <div class="sect2">
1.88      wiz      2397: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2398: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      2399: <p>If you want to pass flags to the linker, both in the configure
                   2400: step and the build step, you can do this in two ways.  Either set
                   2401: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2402: between the two is that <code class="varname">LIBS</code> will be appended to
                   2403: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2404: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2405: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2406: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2407: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2408: settings, use the <code class="literal">+=</code> operator:</p>
                   2409: <pre class="programlisting">
1.100     rillig   2410: LDFLAGS+=        -your -linkerflags
1.88      wiz      2411: </pre>
                   2412: </div>
1.78      rillig   2413: </div>
1.148     asau     2414: <div class="sect1">
1.78      rillig   2415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2416: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 2417: <p>
1.75      rillig   2418:       </p>
1.148     asau     2419: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2420: <li class="listitem">
1.75      rillig   2421: <p><code class="varname">PKG_DEVELOPER</code>:
                   2422:            Run some sanity checks that package developers want:
                   2423:            </p>
1.148     asau     2424: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      2425: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      2426:              fuzz</p></li>
1.128     wiz      2427: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      2428:              binaries will find their shared libs.</p></li>
1.75      rillig   2429: </ul></div>
                   2430: <p>
1.87      wiz      2431:        </p>
1.75      rillig   2432: </li>
1.128     wiz      2433: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      2434:        of debugging output which is displayed whilst making and
                   2435:        installing the package.  The default value for this is 0,
                   2436:        which will not display the commands as they are executed
                   2437:        (normal, default, quiet operation); the value 1 will display
                   2438:        all shell commands before their invocation, and the value 2
                   2439:        will display both the shell commands before their invocation,
1.110     hubertf  2440:        and their actual execution progress with <span class="command"><strong>set
1.88      wiz      2441:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2442: </ul></div>
                   2443: <p>
                   2444:     </p>
                   2445: </div>
1.148     asau     2446: <div class="sect1">
1.75      rillig   2447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2448: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      2449: <p>Some packages have build time options, usually to select
                   2450:     between different dependencies, enable optional support for big
                   2451:     dependencies or enable experimental features.</p>
1.75      rillig   2452: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2453:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2454:     show-options</strong></span>, for example:</p>
1.75      rillig   2455: <pre class="programlisting">
                   2456:     The following options are supported by this package:
                   2457:         ssl      Enable SSL support.
                   2458:     Exactly one of the following gecko options is required:
                   2459:         firefox  Use firefox as gecko rendering engine.
                   2460:         mozilla  Use mozilla as gecko rendering engine.
                   2461:     At most one of the following database options may be selected:
                   2462:         mysql    Enable support for MySQL database.
                   2463:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2464: 
1.75      rillig   2465:     These options are enabled by default: firefox
                   2466:     These options are currently enabled: mozilla ssl
1.1       grant    2467: </pre>
1.75      rillig   2468: <p>The following variables can be defined in
1.110     hubertf  2469:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2470:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2471:     which can be used to select or disable options for all packages
                   2472:     that support them, and
                   2473:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2474:     which can be used to select or disable options specifically for
                   2475:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      2476:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      2477:     are disabled. A few examples:</p>
1.75      rillig   2478: <pre class="screen">
1.110     hubertf  2479: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75      rillig   2480: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2481: PKG_OPTIONS.kdebase=    debug -sasl
                   2482: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2483: <p>It is important to note that options that were specifically
1.120     snj      2484:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2485:     you do not wish to include the option.  If you are unsure you can view
                   2486:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2487: <p>The following settings are consulted in the order given, and
                   2488:     the last setting that selects or disables an option is
                   2489:     used:</p>
1.128     wiz      2490: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2491: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      2492:       maintainer</p></li>
1.128     wiz      2493: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      2494:       variables (see below)</p></li>
1.128     wiz      2495: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2496: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   2497: </ol></div>
                   2498: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2499:     selected is used, all others are automatically disabled.  If an
                   2500:     option of the group is explicitly disabled, the previously
                   2501:     selected option, if any, is used.  It is an error if no option
                   2502:     from a required group of options is selected, and building the
                   2503:     package will fail.</p>
                   2504: <p>Before the options framework was introduced, build options
                   2505:     were selected by setting a variable (often named
                   2506:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2507:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2508:     transition to the options framework for the user, these legacy
                   2509:     variables are converted to the appropriate options setting
                   2510:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2511:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2512:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2513:     directly.  Support for the legacy variables will be removed
                   2514:     eventually.</p>
1.75      rillig   2515: </div>
                   2516: </div>
1.148     asau     2517: <div class="chapter">
1.75      rillig   2518: <div class="titlepage"><div><div><h2 class="title">
                   2519: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2520: <div class="toc">
                   2521: <p><b>Table of Contents</b></p>
1.210     leot     2522: <dl class="toc">
1.75      rillig   2523: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2524: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2525: </dl>
                   2526: </div>
1.148     asau     2527: <div class="sect1">
1.75      rillig   2528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2529: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2530: <p>Once you have built and installed a package, you can create
                   2531:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.189     snj      2532:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2533:     the same package on a group of hosts and wasting CPU time. It also
                   2534:     provides a simple means for others to install your package, should
                   2535:     you distribute it.</p>
                   2536: <p>To create a binary package, change into the appropriate
1.110     hubertf  2537:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2538:     package</strong></span>:</p>
                   2539: <pre class="screen">
                   2540: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2541: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2542:     </pre>
                   2543: <p>This will build and install your package (if not already done),
                   2544:     and then build a binary package from what was installed. You can
1.110     hubertf  2545:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2546:     it. Binary packages are created by default in
                   2547:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2548:     gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.189     snj      2549:     continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.110     hubertf  2550: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.87      wiz      2551:     such a binary package.</p>
1.75      rillig   2552: </div>
1.148     asau     2553: <div class="sect1">
1.75      rillig   2554: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2555: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2556: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.106     rillig   2557: </div>
                   2558: </div>
1.148     asau     2559: <div class="chapter">
1.106     rillig   2560: <div class="titlepage"><div><div><h2 class="title">
                   2561: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2562: builds)</h2></div></div></div>
                   2563: <div class="toc">
                   2564: <p><b>Table of Contents</b></p>
1.210     leot     2565: <dl class="toc">
1.180     wiz      2566: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                   2567: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                   2568: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                   2569: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau     2570: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2571: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2572: </dl>
                   2573: </div>
1.180     wiz      2574: <p>For a number of reasons you may want to build binary packages
                   2575: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
                   2576: For instance, when you have multiple machines that should run the same software,
                   2577: it is wasted time if they all build their packages themselves from source.
                   2578: Or you may want to build a list of packages you want and check them before
                   2579: deploying onto production system.
                   2580: There is a way of getting a set of binary packages:
1.174     asau     2581: The bulk build system, or pbulk ("p" stands for "parallel).
                   2582: This chapter describes how to set it up so that the packages
1.106     rillig   2583: are most likely to be usable later.</p>
1.148     asau     2584: <div class="sect1">
1.106     rillig   2585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2586: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
                   2587: <p>First of all, you have to decide whether you build all packages
                   2588: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2589: both space and time, than builds for some practical sets of packages.
                   2590: There exists a number of particularly heavy packages that are not actually
                   2591: interesting to a wide audience.
                   2592: 
                   2593: For a limited bulk builds you need to make a list of packages you want to build.
                   2594: Note, that all their dependencies will be built, so you don't need to track them manually.
                   2595: </p>
                   2596: <p>During bulk builds various packages are installed and deinstalled
                   2597: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2598: so make sure that you don't need any package during the builds.
                   2599: Essentially, you should provide fresh system, either a chroot environment
                   2600: or something even more restrictive, depending on what the operating system provides,
                   2601: or dedicate the whole physical machine.
                   2602: As a useful side effect this makes sure that bulk builds cannot
                   2603: break anything in your system. There have been numerous cases where
1.106     rillig   2604: certain packages tried to install files outside the
                   2605: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2606: <code class="filename">/etc</code>.
                   2607: </p>
1.106     rillig   2608: </div>
1.148     asau     2609: <div class="sect1">
1.106     rillig   2610: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2611: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   2612: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148     asau     2613: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2614: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2615: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2616: </ul></div>
1.148     asau     2617: <div class="sect2">
1.116     rillig   2618: <div class="titlepage"><div><div><h3 class="title">
1.180     wiz      2619: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.178     asau     2620: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
                   2621: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2622: Configure network access to fetch distribution files.
                   2623: Create user with name "pbulk".</p>
                   2624: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2625: <pre class="screen">
1.181     wiz      2626: <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>
                   2627: <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>
                   2628: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178     asau     2629: </pre>
                   2630: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2631: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2632: <pre class="screen">
                   2633: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
                   2634: <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>
                   2635: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2636: </pre>
                   2637: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2638: <h3 class="title">Note</h3>
                   2639: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2640: <code class="filename">mk.conf</code> that contains settings you want to
                   2641: apply to packages you build. For instance,</p>
                   2642: <pre class="programlisting">
                   2643: PKG_DEVELOPER=         yes             # perform more checks
                   2644: X11_TYPE=              modular         # use pkgsrc X11
                   2645: SKIP_LICENSE_CHECK=    yes             # accept all licences (useful when building all packages)
                   2646: </pre>
                   2647: </div>
                   2648: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
                   2649: with your list of packages one per line without empty lines or comments. E.g.:</p>
                   2650: <pre class="programlisting">
                   2651: www/firefox
                   2652: mail/thunderbird
                   2653: misc/libreoffice4
                   2654: </pre>
1.179     asau     2655: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2656: and make final amendments, if wanted.</p>
1.178     asau     2657: <p>Start it:</p>
                   2658: <pre class="screen">
                   2659: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2660: </pre>
                   2661: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2662: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2663: </p>
                   2664: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2665: <h3 class="title">Note</h3>
                   2666: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2667: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2668: The script is kept small enough for better understanding.</p>
                   2669: </div>
                   2670: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2671: <h3 class="title">Note</h3>
                   2672: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2673: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2674: </div>
1.106     rillig   2675: </div>
                   2676: </div>
1.148     asau     2677: <div class="sect1">
1.106     rillig   2678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2679: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
                   2680: <p>A complete bulk build requires lots of disk space. Some of the
                   2681: disk space can be read-only, some other must be writable. Some can be on
                   2682: remote filesystems (such as NFS) and some should be local. Some can be
                   2683: temporary filesystems, others must survive a sudden reboot.</p>
                   2684: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2685: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2686: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2687: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2688: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2689: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2690: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2691: </ul></div>
                   2692: </div>
                   2693: <div class="sect1">
                   2694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174     asau     2695: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2696: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2697:     create a CD-ROM set of the resulting binary packages to assist
                   2698:     in installing packages on other machines.  The
1.189     snj      2699:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      2700:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2701:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2702:     way that keeps all the dependencies for a given package on the same
                   2703:     CD as that package.</p>
1.148     asau     2704: <div class="sect2">
1.75      rillig   2705: <div class="titlepage"><div><div><h3 class="title">
1.174     asau     2706: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2707: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2708:       man page. The following short example assumes that the binary
                   2709:       packages are left in
                   2710:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2711:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2712:       hold the ISO 9660 images.</p>
                   2713: <pre class="screen">
                   2714: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2715: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2716: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2717:       </pre>
                   2718: <p>If you wish to include a common set of files
                   2719:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2720:       etc.) on each CD in the collection, then you need to create a
                   2721:       directory which contains these files. e.g.</p>
                   2722: <pre class="screen">
                   2723: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2724: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2725: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2726: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2727: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2728: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2729: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2730:       </pre>
1.75      rillig   2731: <p>Now create the images:</p>
                   2732: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76      rillig   2733: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2734:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2735:       in their root directories.</p>
1.75      rillig   2736: </div>
                   2737: </div>
                   2738: </div>
1.148     asau     2739: <div class="chapter">
1.75      rillig   2740: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2741: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2742: <div class="toc">
                   2743: <p><b>Table of Contents</b></p>
1.210     leot     2744: <dl class="toc">
1.128     wiz      2745: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2746: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90      rillig   2747: </dl>
                   2748: </div>
                   2749: <p>The files that are installed by pkgsrc are organized in a way that
                   2750: is similar to what you find in the <code class="filename">/usr</code> directory
                   2751: of the base system. But some details are different. This is because
                   2752: pkgsrc initially came from FreeBSD and had adopted its file system
                   2753: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2754: which operating system you are using pkgsrc with, you can expect the
                   2755: same layout for pkgsrc.</p>
1.91      rillig   2756: <p>There are mainly four root directories for pkgsrc, which are all
                   2757: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2758: When pkgsrc has been installed as root, the default locations
                   2759: are:</p>
                   2760: <pre class="programlisting">
1.100     rillig   2761: LOCALBASE=              /usr/pkg
                   2762: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2763: VARBASE=                /var
                   2764: PKG_DBDIR=              /var/db/pkg
1.91      rillig   2765: </pre>
                   2766: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2767: user), the default locations are:</p>
                   2768: <pre class="programlisting">
1.100     rillig   2769: LOCALBASE=              ${HOME}/pkg
                   2770: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2771: VARBASE=                ${HOME}/pkg/var
                   2772: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   2773: </pre>
                   2774: <p>What these four directories are for, and what they look like is
                   2775: explained below.</p>
1.148     asau     2776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2777: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2778: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2779: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2780: the well-known subdirectories like <code class="filename">bin</code>,
                   2781: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2782: <code class="filename">share</code> and
                   2783: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2784: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2785: <code class="filename">/var</code> in the base system. Some programs (especially
                   2786: games, network daemons) need write access to it during normal
                   2787: operation.</p></li>
1.128     wiz      2788: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2789: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2790: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90      rillig   2791: itself.</p></li>
                   2792: </ul></div>
1.148     asau     2793: <div class="sect1">
1.90      rillig   2794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2795: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2796: </h2></div></div></div>
1.90      rillig   2797: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2798: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2799: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2800: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2801: <dd><p>Contains executable programs that are intended to be
                   2802: directly used by the end user.</p></dd>
                   2803: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2804: <dd><p>Contains files for the emulation layers of various other
                   2805: operating systems, especially for
                   2806: NetBSD.</p></dd>
                   2807: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2808: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2809: <dd><p>Contains
                   2810: the configuration files.</p></dd>
                   2811: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2812: <dd><p>Contains headers for the C and C++ programming
                   2813: languages.</p></dd>
                   2814: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2815: <dd><p>Contains GNU info files of various
                   2816: packages.</p></dd>
                   2817: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2818: <dd><p>Contains shared and static
                   2819: libraries.</p></dd>
                   2820: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2821: <dd><p>Contains data files that don't change after
                   2822: installation. Other data files belong into
                   2823: <code class="filename">${VARBASE}</code>.</p></dd>
                   2824: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2825: <dd><p>Contains programs that are not intended to be used by
                   2826: end users, such as helper programs or network
                   2827: daemons.</p></dd>
                   2828: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2829: <dd><p>Contains programs that are intended to be executed as
                   2830: CGI scripts by a web server.</p></dd>
                   2831: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2832: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2833: <dd><p>Contains brief
                   2834: documentation in form of manual pages.</p></dd>
                   2835: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2836: <dd><p>Contains programs that are intended to be used only by
                   2837: the super-user.</p></dd>
                   2838: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2839: <dd><p>Contains platform-independent data files that don't
                   2840: change after installation.</p></dd>
                   2841: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2842: <dd><p>Contains documentation files provided by the
                   2843: packages.</p></dd>
                   2844: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2845: <dd><p>Contains example files provided by the packages. Among
                   2846: others, the original configuration files are saved here and copied to
                   2847: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2848: installation.</p></dd>
                   2849: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2850: <dd><p>Contains the original files for rc.d
                   2851: scripts.</p></dd>
                   2852: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2853: <code class="filename">${VARBASE}</code>)</span></dt>
                   2854: <dd><p>Contains files
                   2855: that may be modified after
                   2856: installation.</p></dd>
                   2857: </dl></div>
                   2858: </div>
1.148     asau     2859: <div class="sect1">
1.90      rillig   2860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2861: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2862: </h2></div></div></div>
1.148     asau     2863: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2864: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2865: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2866: <dd><p>Contains
                   2867: information about the currently installed
                   2868: packages.</p></dd>
                   2869: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2870: <dd><p>Contains highscore
                   2871: files.</p></dd>
                   2872: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2873: <dd><p>Contains log files.</p></dd>
                   2874: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2875: <dd><p>Contains informational files about daemons that are
                   2876: currently running.</p></dd>
                   2877: </dl></div>
                   2878: </div>
                   2879: </div>
1.148     asau     2880: <div class="chapter">
1.90      rillig   2881: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2882: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2883: <div class="toc">
                   2884: <p><b>Table of Contents</b></p>
1.210     leot     2885: <dl class="toc">
1.106     rillig   2886: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194     bsiegert 2887: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                   2888: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                   2889: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2890: <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>
                   2891: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                   2892: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                   2893: <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>
                   2894: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                   2895: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      2896: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert 2897: <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>
                   2898: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2899: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   2900: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                   2901: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2902: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                   2903: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig   2904: </dl>
                   2905: </div>
                   2906: <p>This section contains hints, tips &amp; tricks on special things in
                   2907: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2908: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2909: <div class="sect1">
1.75      rillig   2910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2911: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2912: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2913: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2914: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   2915:          This is a general purpose list for most issues regarding
                   2916:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2917:          for pkgsrc configuration, unexpected build failures, using
                   2918:          particular packages, upgrading pkgsrc installations,
                   2919:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2920:          proposals for changes that impact the pkgsrc user community,
                   2921:          e.g. major infrastructure changes, new features, package
                   2922:          removals, etc., may also be posted.</p></li>
1.128     wiz      2923: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   2924:          A list where the results of pkgsrc bulk builds are sent and
                   2925:          discussed.</p></li>
1.128     wiz      2926: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   2927:          This list is for those who are interested in getting a
                   2928:          commit message for every change committed to pkgsrc. It is
                   2929:          also available in digest form, meaning one daily message
                   2930:          containing all commit messages for changes to the package
                   2931:          source tree in that 24 hour period.</p></li>
                   2932: </ul></div>
                   2933: <p>To subscribe, do:</p>
                   2934: <pre class="programlisting">
1.100     rillig   2935: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2936: </pre>
                   2937: <p>Archives for all these mailing lists are available from
1.110     hubertf  2938: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2939: </div>
1.148     asau     2940: <div class="sect1">
1.75      rillig   2941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2942: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2943: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2944: a number of useful utilities for both users and developers of pkgsrc.  This
                   2945: section attempts only to make the reader aware of the utilities and when
                   2946: they might be useful, and not to duplicate the documentation that comes
                   2947: with each package.</p>
                   2948: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.189     snj      2949: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   2950:       Symlinks for use by buildlink.</p></li></ul></div>
                   2951: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2953: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75      rillig   2954:       Calculates various kinds of checksums (including SHA1).</p></li>
1.189     snj      2955: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   2956:       Compatibility library for pkgsrc tools.</p></li>
1.189     snj      2957: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      2958:       non-BSD systems due to lack of native mtree.</p></li>
1.189     snj      2959: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   2960:       Up-to-date replacement for
1.76      rillig   2961:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2962:       systems where pkg_install is not present.</p></li>
                   2963: </ul></div>
                   2964: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2965: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2966: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   2967:       Create a binary package from an
1.110     hubertf  2968:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2969:       save the old package.</p></li>
1.189     snj      2970: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   2971:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2972:       from multiple locations. It currently supports the following
                   2973:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.189     snj      2974: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117     jnemeth  2975:       the best compiler flags to optimise code for your current
1.128     wiz      2976:       CPU and compiler. </p></li>
1.75      rillig   2977: </ul></div>
                   2978: <p>Utilities for keeping track of installed packages, being up to date,
                   2979: etc:</p>
1.148     asau     2980: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2981: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173     wiz      2982:     update tool similar to apt(1). Download, install, and upgrade
                   2983:     binary packages easily.</p></li>
1.189     snj      2984: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   2985:       packages whose installed versions do not match the latest pkgsrc
                   2986:       entries.</p></li>
1.189     snj      2987: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   2988:       dependency graphs of packages, to aid in choosing a strategy for
                   2989:       updating.</p></li>
1.189     snj      2990: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   2991:       graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   2992: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   2993:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.189     snj      2994: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   2995:       does various checks on the complete pkgsrc system.</p></li>
1.189     snj      2996: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   2997:       packages you have installed.</p></li>
                   2998: </ul></div>
                   2999: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     3000: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      3001: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   3002:       making and maintaining patches for a package (includes pkgdiff,
                   3003:       pkgvi, mkpatches, etc.).</p></li>
1.189     snj      3004: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   3005:       converting to pkgsrc.</p></li>
                   3006: </ul></div>
                   3007: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3008: utilities)</p>
1.148     asau     3009: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      3010: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   3011:       packages in a chrooted area.</p></li>
1.189     snj      3012: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   3013:       kernel version for chrooted cross builds.</p></li>
                   3014: </ul></div>
                   3015: </div>
1.148     asau     3016: <div class="sect1">
1.75      rillig   3017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3018: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3019: <p>If you want to use pkgsrc as non-root user, you can set some
                   3020: variables to make pkgsrc work under these conditions.  At the very least,
1.128     wiz      3021: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>; this
1.75      rillig   3022: will turn on unprivileged mode and set multiple related variables to allow
                   3023: installation of packages as non-root.</p>
                   3024: <p>In case the defaults are not enough, you may want to tune some other
                   3025: variables used.  For example, if the automatic user/group detection leads
                   3026: to incorrect values (or not the ones you would like to use), you can change
                   3027: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3028: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3029: <p>As regards bootstrapping, please note that the
1.110     hubertf  3030: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128     wiz      3031: given the <span class="quote">&#8220;<span class="quote">--ignore-user-check</span>&#8221;</span> flag, as it will choose and
1.76      rillig   3032: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3033: installation targets.  These directories can be overridden by the
1.128     wiz      3034: <span class="quote">&#8220;<span class="quote">--prefix</span>&#8221;</span> flag provided by the script, as well as some others
1.75      rillig   3035: that allow finer tuning of the tree layout.</p>
                   3036: </div>
1.148     asau     3037: <div class="sect1">
1.75      rillig   3038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3039: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3040: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3041: enable this feature by adding the option
                   3042: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  3043: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   3044: distfile is found, pkgsrc will try to resume it.</p>
                   3045: <p>You can also
1.168     wiz      3046: use a different program than the platform default program by changing the
1.117     jnemeth  3047: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3048: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3049: by using the value manual.  A value of custom disables the system defaults
                   3050: and dependency tracking for the fetch program.  In that case you have to
                   3051: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3052: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3053: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   3054: <p>For example, if you want to use
1.117     jnemeth  3055: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   3056: like:</p>
                   3057: <pre class="programlisting">
1.117     jnemeth  3058: FETCH_USING=   wget
1.1       grant    3059: </pre>
1.75      rillig   3060: </div>
1.148     asau     3061: <div class="sect1">
1.75      rillig   3062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3063: <a name="x.org-from-pkgsrc"></a>9.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103     wiz      3064: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3065: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3066: you will have to add the following line into
1.110     hubertf  3067: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   3068: <pre class="programlisting">
1.103     wiz      3069: X11_TYPE=modular
1.1       grant    3070: </pre>
1.148     asau     3071: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   3072: <h3 class="title">Note</h3>
1.103     wiz      3073: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3074: </p>
1.75      rillig   3075: </div>
                   3076: </div>
1.148     asau     3077: <div class="sect1">
1.75      rillig   3078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3079: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3080: <p>If you are sitting behind a firewall which does not allow direct
                   3081: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3082: relevant proxy hosts.  This is done using an environment variable in the
                   3083: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      3084: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   3085: port 80 as the proxy port number.  So the proxy environment variables
                   3086: are:</p>
                   3087: <pre class="programlisting">
1.100     rillig   3088: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3089: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3090: </pre>
1.75      rillig   3091: </div>
1.148     asau     3092: <div class="sect1">
1.75      rillig   3093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3094: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      3095: <p>Some fetch tools are not prepared to support HTTPS by default
                   3096: (for example, the one in NetBSD 6.0), or the one installed by the
                   3097: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   3098: dependency graph).</p>
                   3099: <p>Usually you won't notice, because distribution files are
                   3100: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   3101: be often enough if you are following pkgsrc-current. In that case, set
                   3102: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   3103: <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
                   3104: with HTTPS support by default. Of course, these tools need to be
                   3105: installed before you can use them this way.</p>
                   3106: </div>
                   3107: <div class="sect1">
                   3108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3109: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   3110: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3111: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3112: the first available command from the following list:</p>
1.148     asau     3113: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3114: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3115: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3116: </ul></div>
                   3117: <p>On a default NetBSD installation, this will be
1.76      rillig   3118: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3119: connections first, and falls back to active connections if the server
                   3120: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3121: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3122: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3123: <p>Having that option present will prevent
1.76      rillig   3124: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3125: transfers.</p>
                   3126: </div>
1.148     asau     3127: <div class="sect1">
1.75      rillig   3128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3129: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3130: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3131: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      3132: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   3133: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3134: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3135: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3136: resulting list to your machine at work/school and use it there.  If you
1.189     snj      3137: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   3138: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3139: URL:</p>
                   3140: <p>At home:</p>
                   3141: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3142: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3143: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3144: <p>At work:</p>
                   3145: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3146: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3147: home.</p>
                   3148: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3149: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3150: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3151: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3152: directly by running:</p>
1.75      rillig   3153: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3154: <p>If you even decide to ignore
                   3155: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3156: by running:</p>
                   3157: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3158: </div>
1.148     asau     3159: <div class="sect1">
1.75      rillig   3160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3161: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      3162: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.189     snj      3163: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   3164: package, you get the error from make that it doesn't know how to make
1.76      rillig   3165: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      3166: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   3167: the NetBSD base distribution on your machine.  It is recommended to do
                   3168: that to format man pages.</p>
1.189     snj      3169: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   3170: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3171: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3172: </div>
1.148     asau     3173: <div class="sect1">
1.75      rillig   3174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3175: <a name="bsd.own.mk-missing"></a>9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</h2></div></div></div>
1.87      wiz      3176: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3177: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3178: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3179: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3180: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3181: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3182: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3183: -r</strong></span>).</p>
                   3184: </div>
1.148     asau     3185: <div class="sect1">
1.75      rillig   3186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3187: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3188: <p>When installing packages as non-root user and using the just-in-time
1.189     snj      3189: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   3190: password for each required package installed.  To avoid this, the sudo
                   3191: package can be used, which does password caching over a limited time.  To
                   3192: use it, install sudo (either as binary package or from
1.189     snj      3193: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  3194: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3195: <span class="emphasis"><em>after</em></span> the definition of the
                   3196: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3197: <pre class="programlisting">
1.100     rillig   3198: .if exists(${LOCALBASE}/bin/sudo)
                   3199: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3200: .endif
1.1       grant    3201: </pre>
1.75      rillig   3202: </div>
1.148     asau     3203: <div class="sect1">
1.75      rillig   3204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3205: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3206: <p>As the system administrator, you can choose where configuration files
                   3207: are installed.  The default settings make all these files go into
1.76      rillig   3208: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3209: be suboptimal depending on your expectations (e.g., a read-only,
                   3210: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3211: configuration of the provided packages).</p>
                   3212: <p>In order to change the defaults, you can modify the
                   3213: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3214: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3215: directory; some common examples include <code class="filename">/etc</code> or
                   3216: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3217: <p>Furthermore, you can change this value on a per-package basis by
                   3218: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3219: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3220: package you would like to modify, that is, the contents of
                   3221: <code class="varname">PKGBASE</code>.</p>
                   3222: <p>Note that after changing these settings, you must rebuild and
                   3223: reinstall any affected packages.</p>
                   3224: </div>
1.148     asau     3225: <div class="sect1">
1.75      rillig   3226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3227: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75      rillig   3228: <p>Please be aware that there can often be bugs in third-party software,
                   3229: and some of these bugs can leave a machine vulnerable to exploitation by
                   3230: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3231: maintains a database of known-exploits to packages which have at one time
                   3232: been included in pkgsrc.  The database can be downloaded automatically, and
                   3233: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3234: do this, refer to the following two tools (installed as part of the
1.189     snj      3235: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128     wiz      3236: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3237: <li class="listitem">
1.122     reed     3238: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3239:     download a list of the security vulnerabilities information.  This list
1.132     spz      3240:     is kept up to date by the pkgsrc security team, and is distributed
                   3241:     from the NetBSD ftp server:</p>
                   3242: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.75      rillig   3243: </li>
1.128     wiz      3244: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3245:     current machine, checking each known vulnerability.  If a
1.75      rillig   3246:     vulnerable package is installed, it will be shown by output to stdout,
                   3247:     including a description of the type of vulnerability, and a URL
                   3248:     containing more information.</p></li>
                   3249: </ol></div>
1.114     jmcneill 3250: <p>Use of these tools is strongly recommended!  After
1.128     wiz      3251: <span class="quote">&#8220;<span class="quote">pkg_install</span>&#8221;</span> is installed, please read
1.75      rillig   3252: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114     jmcneill 3253: pkg_install</code></strong>.</p>
1.87      wiz      3254: <p>If this package is installed, pkgsrc builds will use it to
1.110     hubertf  3255: perform a security check before building any package.  See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, &#8220;Variables affecting the build process&#8221;</a> for ways to control this
1.87      wiz      3256: check.</p>
1.75      rillig   3257: </div>
1.148     asau     3258: <div class="sect1">
1.75      rillig   3259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3260: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3261: <p>When you add your own preferences to the
                   3262:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3263:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3264:        environment variables to the <code class="filename">./configure</code>
1.189     snj      3265:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3266:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3267:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3268:        package.</p>
                   3269: <p>Currently there is no solution to this problem. If you
                   3270:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3271:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3272:        directory and then inspect any <code class="filename">Makefile</code> and
                   3273:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3274:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      3275:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   3276:        programmers write so bad code that it only works for the
                   3277:        specific combination of <code class="varname">CFLAGS</code> they have
                   3278:        chosen.</p>
                   3279: </div>
1.148     asau     3280: <div class="sect1">
1.80      rillig   3281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3282: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      3283: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3284: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   3285:        case that occurs often is that people only update pkgsrc in
                   3286:        parts, because of performance reasons. Since pkgsrc is one large
                   3287:        system, not a collection of many small systems, there are
                   3288:        sometimes changes that only work when the whole pkgsrc tree is
                   3289:        updated.</p></li>
1.148     asau     3290: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      3291:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3292:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   3293:        files.</p></li>
1.148     asau     3294: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3295:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3296:        verify this.</p></li>
1.218   ! rillig   3297: <li class="step"><p>If you are a package developer who wants to invest
        !          3298:        some work, have a look at <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.148     asau     3299: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   3300:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3301: </ol></div>
                   3302: </div>
1.148     asau     3303: <div class="sect1">
1.88      wiz      3304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3305: <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</h2></div></div></div>
1.89      rillig   3306: <p>You have modified a file from pkgsrc, and someone else has
                   3307: modified that same file afterwards in the CVS repository. Both changes
                   3308: are in the same region of the file, so when you updated pkgsrc, the
                   3309: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3310: file. Because of these markers, the file is no longer a valid
                   3311: <code class="filename">Makefile</code>.</p>
                   3312: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3313: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3314: -dP</strong></span> in that directory to download the current version.</p>
                   3315: </div>
1.75      rillig   3316: </div>
                   3317: </div>
1.148     asau     3318: <div class="part">
1.75      rillig   3319: <div class="titlepage"><div><div><h1 class="title">
                   3320: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     3321: <div class="partintro">
1.77      rillig   3322: <div></div>
                   3323: <p>This part of the book deals with creating and
1.128     wiz      3324:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   3325:        guide on creating a new package. The remaining chapters are more
                   3326:        like a reference manual for pkgsrc.</p>
1.75      rillig   3327: <div class="toc">
                   3328: <p><b>Table of Contents</b></p>
1.210     leot     3329: <dl class="toc">
1.106     rillig   3330: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3331: <dd><dl>
1.106     rillig   3332: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3333: <dd><dl>
1.106     rillig   3334: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174     asau     3335: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118     imil     3336: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3337: </dl></dd>
1.106     rillig   3338: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3339: <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>
                   3340: </dl></dd>
                   3341: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3342: <dd><dl>
1.128     wiz      3343: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3344: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106     rillig   3345: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3346: <dd><dl>
                   3347: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3348: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3349: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3350: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3351: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3352: </dl></dd>
                   3353: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3354: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3355: <dd><dl>
                   3356: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3357: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3358: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3359: </dl></dd>
1.128     wiz      3360: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3361: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3362: </dl></dd>
1.128     wiz      3363: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3364: <dd><dl>
                   3365: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      3366: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   3367: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3368: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3369: <dd><dl>
                   3370: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3371: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3372: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3373: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3374: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3375: </dl></dd>
                   3376: </dl></dd>
                   3377: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3378: <dd><dl>
                   3379: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      3380: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3381: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106     rillig   3382: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3383: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      3384: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig   3385: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz      3386: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   3387: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106     rillig   3388: </dl></dd>
                   3389: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3390: <dd><dl>
                   3391: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      3392: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3393: <dd><dl>
                   3394: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      3395: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   3396:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3397:       and
                   3398:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3399:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3400: </dl></dd>
1.128     wiz      3401: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig   3402: <dd><dl>
1.128     wiz      3403: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106     rillig   3404: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3405: </dl></dd>
                   3406: </dl></dd>
                   3407: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3408: <dd><dl>
                   3409: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3410: <dd><dl>
                   3411: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3412: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3413: </dl></dd>
                   3414: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3415: <dd><dl>
1.128     wiz      3416: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig   3417: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3418: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3419: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3420: </dl></dd>
                   3421: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3422: <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>
                   3423: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3424: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3425: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3426: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3427: <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>
                   3428: </dl></dd>
                   3429: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3430: <dd><dl>
                   3431: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      3432: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106     rillig   3433: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   3434: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3435: </dl></dd>
                   3436: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3437: <dd><dl>
                   3438: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3439: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3440: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3441: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      3442: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   3443: <dd><dl>
                   3444: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3445: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3446: </dl></dd>
1.128     wiz      3447: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3448: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3449: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3450: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3451: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3452: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3453: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3454: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3455: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3456: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig   3457: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3458: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3459: </dl></dd>
                   3460: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3461: <dd><dl>
                   3462: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3463: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3464: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3465: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3466: </dl></dd>
                   3467: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3468: <dd><dl>
                   3469: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3470: <dd><dl>
1.218   ! rillig   3471: <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>
        !          3472: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
        !          3473: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
        !          3474: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
        !          3475: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
        !          3476: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
        !          3477: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
        !          3478: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
        !          3479: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
        !          3480: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
        !          3481: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.106     rillig   3482: </dl></dd>
1.218   ! rillig   3483: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   3484: <dd><dl>
                   3485: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3486: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.199     tnn      3487: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig   3488: </dl></dd>
1.218   ! rillig   3489: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig   3490: <dd><dl>
                   3491: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3492: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3493: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3494: </dl></dd>
                   3495: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3496: <dd><dl>
                   3497: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3498: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3499: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      3500: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   3501: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   3502: </dl></dd>
1.218   ! rillig   3503: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig   3504: <dd><dl>
                   3505: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3506: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      3507: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.106     rillig   3508: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3509: </dl></dd>
1.218   ! rillig   3510: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig   3511: <dd><dl>
                   3512: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3513: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3514: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3515: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3516: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3517: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3518: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3519: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   3520: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   3521: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   3522: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3523: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3524: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3525: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3526: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3527: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3528: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3529: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      3530:     emulation</a></span></dt>
1.106     rillig   3531: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3532: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3533: </dl></dd>
1.106     rillig   3534: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3535: </dl></dd>
1.106     rillig   3536: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3537: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   3538: <dd><dl>
1.106     rillig   3539: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3540: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3541: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140     wiz      3542: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig   3543: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     3544: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   3545: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig   3546: </dl></dd>
                   3547: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3548: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3549: <dd><dl>
                   3550: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3551: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3552: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3553: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     3554: </dl></dd>
1.75      rillig   3555: </dl>
                   3556: </div>
1.77      rillig   3557: </div>
1.148     asau     3558: <div class="chapter">
1.77      rillig   3559: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3560: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3561: <div class="toc">
                   3562: <p><b>Table of Contents</b></p>
1.210     leot     3563: <dl class="toc">
1.106     rillig   3564: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3565: <dd><dl>
1.106     rillig   3566: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174     asau     3567: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118     imil     3568: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3569: </dl></dd>
1.106     rillig   3570: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3571: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91      rillig   3572: </dl>
                   3573: </div>
1.77      rillig   3574: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3575: most likely have a URL from where you can download the source
                   3576: code. Starting with this URL, creating a package involves only a
                   3577: few steps.</p>
1.128     wiz      3578: <div class="procedure"><ol class="procedure" type="1">
1.189     snj      3579: <li class="step"><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.148     asau     3580: <li class="step"><p>Then, choose one of the top-level directories as the
1.91      rillig   3581: category in which you want to place your package. You can also create a
                   3582: directory of your own (maybe called <code class="filename">local</code>). In that
                   3583: category directory, create another directory for your package and change
                   3584: into it.</p></li>
1.148     asau     3585: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3586: you for a URL. Enter the URL of the distribution file (in most cases a
                   3587: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3588: of your package are created automatically. The distribution file is
                   3589: extracted automatically to fill in some details in the
                   3590: <code class="filename">Makefile</code> that would otherwise have to be done
                   3591: manually.</p></li>
1.148     asau     3592: <li class="step">
1.91      rillig   3593: <p>Examine the extracted files to determine the dependencies of
                   3594: your package. Ideally, this is mentioned in some
                   3595: <code class="filename">README</code> file, but things may differ. For each of
                   3596: these dependencies, look where it exists in pkgsrc, and if there is a
                   3597: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3598: line to your package <code class="filename">Makefile</code> which includes that
                   3599: file just before the last line. If the
1.132     spz      3600: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3601: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3602: <p>If you just need binaries from a package, add a
1.91      rillig   3603: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3604: version of the dependency and where it can be found in pkgsrc. This line
                   3605: should be placed in the third paragraph. If the dependency is only
                   3606: needed for building the package, but not when using it, use
                   3607: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3608: Your package may then look like this:</p>
1.77      rillig   3609: <pre class="programlisting">
1.100     rillig   3610: [...]
1.77      rillig   3611: 
1.174     asau     3612: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100     rillig   3613: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3614: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3615: 
1.100     rillig   3616: [...]
1.77      rillig   3617: 
1.100     rillig   3618: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3619: .include "../../devel/glib2/buildlink3.mk"
                   3620: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3621: </pre>
                   3622: </li>
1.148     asau     3623: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128     wiz      3624: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
1.110     hubertf  3625: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3626: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3627: -e</strong></span>, which outputs additional
                   3628: explanations.</p></li>
1.148     asau     3629: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  3630: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
1.91      rillig   3631: over there, you can hopefully continue here.</p></li>
1.148     asau     3632: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3633: directory from the extracted files. Besides these files, a lot of cache
                   3634: files and other system information has been saved in the working
                   3635: directory, which may become wrong after you edited the
                   3636: <code class="filename">Makefile</code>.</p></li>
1.148     asau     3637: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110     hubertf  3638: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.148     asau     3639: <li class="step"><p>When the package builds fine, the next step is to install
1.110     hubertf  3640: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3641: everything works.</p></li>
1.148     asau     3642: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91      rillig   3643: contains a list of the files that are installed by the package, is
1.110     hubertf  3644: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3645: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3646: the file using your preferred text editor to see if the list of
                   3647: files looks plausible.</p></li>
1.148     asau     3648: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3649: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148     asau     3650: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3651: has been registered in the database of installed files, but with an
1.110     hubertf  3652: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3653: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3654: registered with the list of files from
                   3655: <code class="filename">PLIST</code>.</p></li>
1.148     asau     3656: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3657: package from the set of installed files.</p></li>
1.77      rillig   3658: </ol></div>
1.148     asau     3659: <div class="sect1">
1.91      rillig   3660: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3661: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148     asau     3662: <div class="sect2">
1.91      rillig   3663: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3664: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   3665: <p>Simple Perl modules are handled automatically by
1.110     hubertf  3666: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   3667: </div>
1.148     asau     3668: <div class="sect2">
1.91      rillig   3669: <div class="titlepage"><div><div><h3 class="title">
1.174     asau     3670: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
                   3671: <p>KDE3 applications should always include
1.91      rillig   3672: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.174     asau     3673: settings that are typical of KDE3 packages.</p>
1.91      rillig   3674: </div>
1.148     asau     3675: <div class="sect2">
1.118     imil     3676: <div class="titlepage"><div><div><h3 class="title">
                   3677: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   3678: <p>Python modules and programs packages are easily created using a
                   3679: set of predefined variables.</p>
                   3680: <p>
1.171     wiz      3681: If some Python versions are not supported by the software, set the
                   3682: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   3683: that are not supported, e.g.
1.118     imil     3684: </p>
                   3685: <pre class="programlisting">
1.203     sevan    3686: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.118     imil     3687: </pre>
                   3688: <p>
1.213     wiz      3689: If the packaged software is a Python module, include one of
                   3690: <code class="filename">../../lang/python/egg.mk</code>,
                   3691: <code class="filename">../../lang/python/distutils.mk</code>, or
                   3692: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   3693: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3694: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3695: if the packaged software is using setuptools, you only need
                   3696: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   3697: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   3698: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>.
                   3699: so pkgsrc will use this framework.
                   3700: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3701: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   3702: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3703: to the name of the script.</p>
                   3704: <p>Either way, the package directory should be called
1.128     wiz      3705: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3706: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.118     imil     3707: </p>
                   3708: <pre class="programlisting">
                   3709: DISTNAME=   foopymodule-1.2.10
                   3710: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3711: </pre>
1.171     wiz      3712: <p>If it is an application, include
                   3713: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   3714: In order to correctly set the path to the Python interpreter, use the
1.118     imil     3715: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142     wiz      3716: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171     wiz      3717: For example:
1.118     imil     3718: </p>
                   3719: <pre class="programlisting">
1.142     wiz      3720: REPLACE_PYTHON=   *.py
1.118     imil     3721: </pre>
1.171     wiz      3722: <p>Some Python modules have separate distributions for Python-2.x
                   3723: and Python-3.x support. In pkgsrc this is handled by the
                   3724: <code class="filename">versioned_dependencies.mk</code> file. Set
                   3725: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   3726: packages that should be depended upon and include
                   3727: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   3728: then the pkgsrc infrastructure will depend on the appropriate package
                   3729: version. For example:
                   3730: </p>
                   3731: <pre class="programlisting">
                   3732: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
                   3733: </pre>
                   3734: <p>
                   3735: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   3736: of supported packages.</p>
1.118     imil     3737: </div>
1.91      rillig   3738: </div>
1.148     asau     3739: <div class="sect1">
1.91      rillig   3740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3741: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148     asau     3742: <div class="sect2">
1.91      rillig   3743: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3744: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148     asau     3745: <div class="sect3">
1.91      rillig   3746: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3747: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   3748: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128     wiz      3749: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.91      rillig   3750: pkgsrc. As the description says it has to do with the web, the obvious
1.128     wiz      3751: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.91      rillig   3752: <pre class="programlisting">
1.100     rillig   3753: <code class="prompt">$</code> mkdir www/nvu
                   3754: <code class="prompt">$</code> cd www/nvu
1.91      rillig   3755: </pre>
                   3756: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  3757: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   3758: <pre class="programlisting">
1.100     rillig   3759: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   3760: </pre>
                   3761: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3762: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128     wiz      3763: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
1.91      rillig   3764: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3765: <code class="varname">COMMENT</code> fields. Then the package
                   3766: <code class="filename">Makefile</code> looked like that:</p>
                   3767: <pre class="programlisting">
1.100     rillig   3768: # $NetBSD$
                   3769: #
1.91      rillig   3770: 
1.100     rillig   3771: DISTNAME=       nvu-1.0-sources
                   3772: PKGNAME=        nvu-1.0
                   3773: CATEGORIES=     www
                   3774: MASTER_SITES=   http://cvs.nvu.com/download/
                   3775: EXTRACT_SUFX=   .tar.bz2
                   3776: 
                   3777: MAINTAINER=     rillig@NetBSD.org
                   3778: HOMEPAGE=       http://cvs.nvu.com/
                   3779: COMMENT=        Web Authoring System
1.91      rillig   3780: 
1.100     rillig   3781: # url2pkg-marker (please do not remove this line.)
                   3782: .include "../../mk/bsd.pkg.mk"
1.91      rillig   3783: </pre>
                   3784: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3785: source archive:</p>
                   3786: <pre class="programlisting">
1.100     rillig   3787: url2pkg&gt; Running "make makesum" ...
                   3788: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3789: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3790: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3791: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3792: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3793: url2pkg&gt; Running "make extract" ...
                   3794: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3795: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3796: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3797: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3798: ===&gt; Installing dependencies for nvu-1.0
                   3799: ===&gt; Overriding tools for nvu-1.0
                   3800: ===&gt; Extracting for nvu-1.0
                   3801: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   3802: 
1.100     rillig   3803: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   3804: 
1.100     rillig   3805: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   3806: </pre>
                   3807: </div>
1.148     asau     3808: <div class="sect3">
1.91      rillig   3809: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3810: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91      rillig   3811: <p>Now that the package has been extracted, let's see what's inside
                   3812: it. The package has a <code class="filename">README.txt</code>, but that only
                   3813: says something about mozilla, so it's probably useless for seeing what
                   3814: dependencies this package has. But since there is a GNU configure script
                   3815: in the package, let's hope that it will complain about everything it
                   3816: needs.</p>
                   3817: <pre class="programlisting">
1.100     rillig   3818: <code class="prompt">$</code> bmake
                   3819: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3820: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3821: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3822: ===&gt; Patching for nvu-1.0
                   3823: ===&gt; Creating toolchain wrappers for nvu-1.0
                   3824: ===&gt; Configuring for nvu-1.0
                   3825: [...]
                   3826: configure: error: Perl 5.004 or higher is required.
                   3827: [...]
                   3828: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3829: [...]
1.91      rillig   3830: </pre>
                   3831: <p>That worked quite well. So I opened the package Makefile in my
                   3832: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128     wiz      3833: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.91      rillig   3834: package have changed now, and since a perl wrapper is automatically
1.128     wiz      3835: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.91      rillig   3836: from scratch.</p>
                   3837: <pre class="programlisting">
1.100     rillig   3838: <code class="prompt">$</code> bmake clean
                   3839: ===&gt; Cleaning for nvu-1.0
                   3840: <code class="prompt">$</code> bmake
                   3841: [...]
                   3842: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   3843: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   3844: [...]
1.91      rillig   3845: </pre>
1.128     wiz      3846: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.91      rillig   3847: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   3848: <pre class="programlisting">
1.100     rillig   3849: [...]
                   3850: checking for GTK - version &gt;= 1.2.0... no
                   3851: *** Could not run GTK test program, checking why...
                   3852: [...]
1.91      rillig   3853: </pre>
                   3854: <p>Now to the other dependencies. The first question is: Where is the
                   3855: GTK package hidden in pkgsrc?</p>
                   3856: <pre class="programlisting">
1.100     rillig   3857: <code class="prompt">$</code> echo ../../*/gtk*
                   3858: [many packages ...]
                   3859: <code class="prompt">$</code> echo ../../*/gtk
                   3860: ../../x11/gtk
                   3861: <code class="prompt">$</code> echo ../../*/gtk2
                   3862: ../../x11/gtk2
                   3863: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   3864: ../../x11/gtk2/buildlink3.mk
1.91      rillig   3865: </pre>
                   3866: <p>The first try was definitely too broad. The second one had exactly
                   3867: one result, which is very good. But there is one pitfall with GNOME
                   3868: packages. Before GNOME 2 had been released, there were already many
                   3869: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   3870: packages, the GNOME 2 packages were imported as separate packages, and
1.128     wiz      3871: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.91      rillig   3872: whether this was the case here, and indeed it was.</p>
                   3873: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   3874: file, adding the dependency is very easy. I just inserted an
                   3875: <code class="literal">.include</code> line before the last line of the package
                   3876: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   3877: <pre class="programlisting">
1.100     rillig   3878: [...]
                   3879: .include "../../x11/gtk2/buildlink3.mk"
                   3880: .include "../../mk/bsd.pkg.mk
1.91      rillig   3881: </pre>
1.110     hubertf  3882: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   3883: was:</p>
                   3884: <pre class="programlisting">
1.100     rillig   3885: [...]
                   3886: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   3887: checking for GTK - version &gt;= 1.2.0... no
                   3888: *** Could not run GTK test program, checking why...
                   3889: *** The test program failed to compile or link. See the file config.log for the
                   3890: *** exact error that occured. This usually means GTK was incorrectly installed
                   3891: *** or that you have moved GTK since it was installed. In the latter case, you
                   3892: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   3893: configure: error: Test for GTK failed.
                   3894: [...]
1.91      rillig   3895: </pre>
1.128     wiz      3896: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   3897: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.91      rillig   3898: told me that this package really wanted to have the GNOME 1 version of
                   3899: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  3900: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   3901: So I changed the <code class="literal">x11/gtk2</code> to
                   3902: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   3903: and tried again.</p>
                   3904: <pre class="programlisting">
1.100     rillig   3905: [...]
1.166     jnemeth  3906: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
1.100     rillig   3907: In file included from xpidl.c:42:
                   3908: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   3909: In file included from xpidl.c:42:
                   3910: xpidl.h:132: error: parse error before "IDL_ns"
                   3911: [...]
1.91      rillig   3912: </pre>
                   3913: <p>The package still does not find all of its dependencies. Now the
                   3914: question is: Which package provides the
                   3915: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   3916: <pre class="programlisting">
1.100     rillig   3917: <code class="prompt">$</code> echo ../../*/*idl*
                   3918: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   3919: <code class="prompt">$</code> echo ../../*/*IDL*
                   3920: ../../net/libIDL
1.91      rillig   3921: </pre>
                   3922: <p>Let's take the one from the second try. So I included the
                   3923: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   3924: again. But the error didn't change. After digging through some of the
                   3925: code, I concluded that the build process of the package was broken and
                   3926: couldn't have ever worked, but since the Mozilla source tree is quite
                   3927: large, I didn't want to fix it. So I added the following to the package
                   3928: <code class="filename">Makefile</code> and tried again:</p>
                   3929: <pre class="programlisting">
1.100     rillig   3930: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   3931: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   3932: </pre>
                   3933: <p>The latter line is needed because the package expects the library
                   3934: <code class="filename">libIDL.so</code>, but only
                   3935: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   3936: wrapper to rewrite that on the fly.</p>
                   3937: <p>The next problem was related to a recent change of the FreeType
1.189     snj      3938: interface. I looked up in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.91      rillig   3939: which patch files were relevant for this issue and copied them to the
                   3940: <code class="filename">patches</code> directory. Then I retried, fixed the
                   3941: patches so that they applied cleanly and retried again. This time,
                   3942: everything worked.</p>
                   3943: </div>
1.148     asau     3944: <div class="sect3">
1.91      rillig   3945: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3946: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   3947: <pre class="programlisting">
1.100     rillig   3948: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   3949: [...]
                   3950: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   3951: <code class="prompt">$</code> bmake deinstall
                   3952: <code class="prompt">$</code> bmake install
1.91      rillig   3953: </pre>
                   3954: </div>
                   3955: </div>
                   3956: </div>
1.77      rillig   3957: </div>
1.148     asau     3958: <div class="chapter">
1.75      rillig   3959: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3960: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   3961: <div class="toc">
                   3962: <p><b>Table of Contents</b></p>
1.210     leot     3963: <dl class="toc">
1.128     wiz      3964: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3965: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106     rillig   3966: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3967: <dd><dl>
                   3968: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3969: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3970: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3971: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3972: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3973: </dl></dd>
                   3974: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3975: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3976: <dd><dl>
                   3977: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3978: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3979: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   3980: </dl></dd>
1.128     wiz      3981: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3982: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   3983: </dl>
                   3984: </div>
1.87      wiz      3985: <p>Whenever you're preparing a package, there are a number of
                   3986: files involved which are described in the following
                   3987: sections.</p>
1.148     asau     3988: <div class="sect1">
1.75      rillig   3989: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3990: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93      rillig   3991: </h2></div></div></div>
1.75      rillig   3992: <p>Building, installation and creation of a binary package are all
1.87      wiz      3993:   controlled by the package's <code class="filename">Makefile</code>.
                   3994:   The <code class="filename">Makefile</code> describes various things about
                   3995:   a package, for example from where to get it, how to configure,
                   3996:   build, and install it.</p>
1.76      rillig   3997: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      3998:   sections that describe the package.</p>
1.75      rillig   3999: <p>In the first section there are the following variables, which
1.87      wiz      4000:   should appear exactly in the order given here.  The order and
                   4001:   grouping of the variables is mostly historical and has no further
                   4002:   meaning.</p>
1.148     asau     4003: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4004: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4005:     distribution file to be downloaded from the package's
                   4006:     website.</p></li>
1.128     wiz      4007: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174     asau     4008:     package, as used by pkgsrc. You need to provide it if
1.87      wiz      4009:     <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174     asau     4010:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   4011:     provided (no distribution file is required).  Usually it is the pkgsrc
1.87      wiz      4012:     directory name together with the version number. It must match the
                   4013:     regular expression
                   4014:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4015:     starts with a letter or digit, and contains only letters, digits,
                   4016:     dashes, underscores, dots and plus signs.</p></li>
1.128     wiz      4017: <li class="listitem">
1.75      rillig   4018: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4019:     which the package fits in. You can choose any of the top-level
                   4020:     directories of pkgsrc for it.</p>
1.75      rillig   4021: <p>Currently the following values are available for
1.87      wiz      4022:     <code class="varname">CATEGORIES</code>. If more than
                   4023:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4024: <pre class="programlisting">
1.100     rillig   4025: archivers     cross         geography     meta-pkgs     security
                   4026: audio         databases     graphics      misc          shells
                   4027: benchmarks    devel         ham           multimedia    sysutils
                   4028: biology       editors       inputmethod   net           textproc
                   4029: cad           emulators     lang          news          time
                   4030: chat          finance       mail          parallel      wm
                   4031: comms         fonts         math          pkgtools      www
                   4032: converters    games         mbone         print         x11
                   4033: </pre>
1.75      rillig   4034: </li>
1.128     wiz      4035: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4036:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4037:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4038:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.128     wiz      4039:     <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
1.75      rillig   4040: </ul></div>
                   4041: <p>The second section contains information about separately
1.87      wiz      4042:   downloaded patches, if any.
                   4043:   </p>
1.148     asau     4044: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190     wiz      4045: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87      wiz      4046:     Name(s) of additional files that contain distribution patches.
                   4047:     There is no default. pkgsrc will look for them at
                   4048:     <code class="varname">PATCH_SITES</code>.
                   4049:     They will automatically be uncompressed before patching if
                   4050:     the names end with <code class="filename">.gz</code> or
                   4051:     <code class="filename">.Z</code>.</p></li>
1.128     wiz      4052: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4053:     Primary location(s) for distribution patch files (see
1.190     wiz      4054:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   4055: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
                   4056:     an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
                   4057:     help find the correct files to patch. It defaults to
                   4058:     <span class="command"><strong>-p0</strong></span>.</p></li>
1.75      rillig   4059: </ul></div>
                   4060: <p>The third section contains the following variables.
1.87      wiz      4061:   </p>
1.148     asau     4062: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4063: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114     jmcneill 4064:     address of the person who feels responsible for this package,
                   4065:     and who is most likely to look at problems or questions regarding
1.189     snj      4066:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114     jmcneill 4067:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4068:     before making changes to the package, but are not required to
                   4069:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4070:     to yourself. If you really can't maintain the package for future
                   4071:     updates, set it to
1.110     hubertf  4072:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.128     wiz      4073: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114     jmcneill 4074:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4075:     developers to update or change the package without contacting
                   4076:     you first. A package Makefile should contain one of
                   4077:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4078:     not both.  </p></li>
1.128     wiz      4079: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4080:     find more information about the package.</p></li>
1.128     wiz      4081: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4082:     description of the package (should not include the package
                   4083:     name).</p></li>
1.75      rillig   4084: </ul></div>
                   4085: <p>Other variables that affect the build:
1.87      wiz      4086:   </p>
1.148     asau     4087: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75      rillig   4088: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4089:       interesting distribution files of the package are found. The
                   4090:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4091:       works for most packages.</p>
1.75      rillig   4092: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4093:       (most GNU software does, for instance), but extracts itself in
                   4094:       the current directory, you should set
                   4095:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4096: <p>If a package doesn't create a subdirectory with the
                   4097:       name of <code class="varname">DISTNAME</code> but some different name,
                   4098:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4099:       <code class="filename">${WRKDIR}</code>, for example
                   4100:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.189     snj      4101:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75      rillig   4102: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4103:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4104:       variable. By default, its value is
                   4105:       <code class="filename">work</code>. If you want to use the same
                   4106:       pkgsrc tree for building different kinds of binary packages,
                   4107:       you can change the variable according to your needs. Two
                   4108:       other variables handle common cases of setting
                   4109:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4110:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  4111:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      4112:       the host's name is attached to the directory name. If
                   4113:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4114:       is attached, which might look like
                   4115:       <code class="filename">work.i386</code> or
                   4116:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4117: </li></ul></div>
                   4118: <p>Please pay attention to the following gotchas:</p>
1.148     asau     4119: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4120: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4121:       installed in compressed form by the package.  For packages using
                   4122:       BSD-style makefiles which honor MANZ, there is
                   4123:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128     wiz      4124: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   4125:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.88      wiz      4126:       below).</p></li>
1.128     wiz      4127: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.75      rillig   4128: </ul></div>
                   4129: </div>
1.148     asau     4130: <div class="sect1">
1.75      rillig   4131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4132: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   4133: </h2></div></div></div>
1.76      rillig   4134: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4135:   digest, or checksum, of each distfile needed for the package. This
                   4136:   ensures that the distfiles retrieved from the Internet have not been
                   4137:   corrupted during transfer or altered by a malign force to introduce
                   4138:   a security hole. Due to recent rumor about weaknesses of digest
                   4139:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4140:   message digests, as well as the file size.</p>
1.76      rillig   4141: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4142:   checksums for all the patches found in the
1.110     hubertf  4143:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a>).</p>
1.76      rillig   4144: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110     hubertf  4145:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87      wiz      4146:   command.</p>
1.75      rillig   4147: <p>Some packages have different sets of distfiles depending on
1.189     snj      4148:   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.87      wiz      4149:   <code class="filename">distinfo</code> file and care should be taken when
                   4150:   upgrading such a package to ensure distfile information is not
                   4151:   lost.</p>
1.75      rillig   4152: </div>
1.148     asau     4153: <div class="sect1">
1.75      rillig   4154: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4155: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93      rillig   4156: <p>Many packages still don't work out-of-the box on the various
                   4157:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4158:   patch files are needed to make the package work. These patch files are
                   4159:   found in the <code class="filename">patches/</code> directory.</p>
                   4160: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4161:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.110     hubertf  4162:   extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.130     wiz      4163:   order</a>.</p>
1.148     asau     4164: <div class="sect2">
1.93      rillig   4165: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4166: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4167: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  4168:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4169:   problems. (To force patches to apply with fuzz you can set
                   4170:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4171:   should contain only changes for a single file, and no file should be
1.93      rillig   4172:   patched by more than one patch file. This helps to keep future
                   4173:   modifications simple.</p>
                   4174: <p>Each patch file is structured as follows: In the first line,
                   4175:   there is the RCS Id of the patch itself. The second line should be
                   4176:   empty for aesthetic reasons. After that, there should be a comment for
                   4177:   each change that the patch does. There are a number of standard
                   4178:   cases:</p>
1.148     asau     4179: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4180: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93      rillig   4181:   mention the vulnerability ID (CAN, CVE).</p></li>
1.128     wiz      4182: <li class="listitem"><p>Patches that change source code should mention the
1.93      rillig   4183:   platform and other environment (for example, the compiler) that the
                   4184:   patch is needed for.</p></li>
                   4185: </ul></div>
1.130     wiz      4186: <p>In all, the patch should be commented so that any
1.93      rillig   4187:   developer who knows the code of the application can make some use of
                   4188:   the patch. Special care should be taken for the upstream developers,
                   4189:   since we generally want that they accept our patches, so we have less
                   4190:   work in the future.</p>
                   4191: </div>
1.148     asau     4192: <div class="sect2">
1.93      rillig   4193: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4194: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   4195: <p>One important thing to mention is to pay attention that no RCS
                   4196:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4197:   later checked into the NetBSD CVS tree. Use the
1.189     snj      4198:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93      rillig   4199:   problems.</p>
1.87      wiz      4200: <p>For even more automation, we recommend using
1.110     hubertf  4201:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      4202:   whole set of patches. You just have to backup files before you
                   4203:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  4204:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4205:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      4206:   you upgrade a package this way, you can easily compare the new
                   4207:   set of patches with the previously existing one with
1.130     wiz      4208:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   4209:   are replaced by new files, so carefully check if you want to take all
                   4210:   the changes.</p>
1.87      wiz      4211: <p>When you have finished a package, remember to generate
1.110     hubertf  4212:   the checksums for the patch files by using the <span class="command"><strong>make
1.128     wiz      4213:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
1.87      wiz      4214: <p>When adding a patch that corrects a problem in the
                   4215:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4216:   man pages should go), send the patch as a bug report to the
                   4217:   maintainer.  This benefits non-pkgsrc users of the package,
                   4218:   and usually makes it possible to remove the patch in future
                   4219:   version.</p>
1.101     rillig   4220: <p>The file names of the patch files are usually of the form
1.130     wiz      4221:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   4222:   Many packages still use the previous convention
                   4223:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   4224:   but new patches should be of the form containing the filename.
1.189     snj      4225:   <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.130     wiz      4226:   automatically.</p>
1.93      rillig   4227: </div>
1.148     asau     4228: <div class="sect2">
1.93      rillig   4229: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4230: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4231: <p>If you want to share patches between multiple packages
                   4232:   in pkgsrc, e.g. because they use the same distfiles, set
                   4233:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4234:   can be found, e.g.:</p>
                   4235: <pre class="programlisting">
1.100     rillig   4236: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4237: </pre>
1.75      rillig   4238: <p>Patch files that are distributed by the author or other
1.87      wiz      4239:     maintainers can be listed in
                   4240:     <code class="varname">PATCHFILES</code>.</p>
                   4241: <p>If it is desired to store any patches that should not be
                   4242:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4243:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4244:     directory tree there is expected to have the same
1.128     wiz      4245:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.87      wiz      4246:     patches are expected to be stored inside these dirs (also
                   4247:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4248:     example, if you want to keep a private patch for
                   4249:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4250:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4251:     files in the named directory are expected to be patch files,
                   4252:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4253:     applied</em></span>.</p>
1.93      rillig   4254: </div>
1.148     asau     4255: <div class="sect2">
1.85      jmmv     4256: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4257: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4258: <p>When fixing a portability issue in the code do not use
                   4259:       preprocessor magic to check for the current operating system nor
                   4260:       platform.  Doing so hurts portability to other platforms because
                   4261:       the OS-specific details are not abstracted appropriately.</p>
                   4262: <p>The general rule to follow is: instead of checking for the
                   4263:       operating system the application is being built on, check for the
                   4264:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4265:       instead of assuming that kqueue is available under NetBSD and
                   4266:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126     jakllsch 4267:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     4268:       yes, this generally involves patching the
1.110     hubertf  4269:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     4270:       that prevents some OSes from adopting interfaces from other OSes
                   4271:       (e.g. Linux implementing kqueue), something that the above checks
                   4272:       cannot take into account.</p>
                   4273: <p>Of course, checking for features generally involves more
                   4274:       work on the developer's side, but the resulting changes are
1.87      wiz      4275:       cleaner and there are chances they will work on many other
1.85      jmmv     4276:       platforms.  Not to mention that there are higher chances of being
                   4277:       later integrated into the mainstream sources.  Remember:
                   4278:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4279: <p>Some typical examples:</p>
                   4280: <div class="table">
1.106     rillig   4281: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.216     tnn      4282: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.85      jmmv     4283: <colgroup>
                   4284: <col>
                   4285: <col>
                   4286: <col>
                   4287: </colgroup>
                   4288: <thead><tr>
                   4289: <th>Where</th>
                   4290: <th>Incorrect</th>
                   4291: <th>Correct</th>
                   4292: </tr></thead>
                   4293: <tbody>
                   4294: <tr>
                   4295: <td>configure script</td>
                   4296: <td>
1.100     rillig   4297: <pre class="programlisting">
                   4298: case ${target_os} in
                   4299: netbsd*) have_kvm=yes ;;
                   4300: *)       have_kvm=no  ;;
                   4301: esac
                   4302: </pre>
1.85      jmmv     4303:              </td>
                   4304: <td>
1.100     rillig   4305: <pre class="programlisting">
                   4306: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4307: </pre>
1.85      jmmv     4308:              </td>
                   4309: </tr>
                   4310: <tr>
                   4311: <td>C source file</td>
                   4312: <td>
1.100     rillig   4313: <pre class="programlisting">
                   4314: #if defined(__NetBSD__)
                   4315: #  include &lt;sys/event.h&gt;
                   4316: #endif
                   4317: </pre>
1.85      jmmv     4318:              </td>
                   4319: <td>
1.100     rillig   4320: <pre class="programlisting">
                   4321: #if defined(HAVE_SYS_EVENT_H)
                   4322: #  include &lt;sys/event.h&gt;
                   4323: #endif
                   4324: </pre>
1.85      jmmv     4325:              </td>
                   4326: </tr>
                   4327: <tr>
                   4328: <td>C source file</td>
                   4329: <td>
1.100     rillig   4330: <pre class="programlisting">
                   4331: int
                   4332: monitor_file(...)
                   4333: {
                   4334: #if defined(__NetBSD__)
                   4335:         int fd = kqueue();
                   4336:         ...
                   4337: #else
                   4338:         ...
                   4339: #endif
                   4340: }
                   4341: </pre>
1.85      jmmv     4342:              </td>
                   4343: <td>
1.100     rillig   4344: <pre class="programlisting">
                   4345: int
                   4346: monitor_file(...)
                   4347: {
                   4348: #if defined(HAVE_KQUEUE)
                   4349:         int fd = kqueue();
                   4350:         ...
                   4351: #else
                   4352:        ...
                   4353: #endif
                   4354: }
                   4355: </pre>
1.85      jmmv     4356:              </td>
                   4357: </tr>
                   4358: </tbody>
1.91      rillig   4359: </table></div>
1.85      jmmv     4360: </div>
1.91      rillig   4361: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110     hubertf  4362:       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
                   4363:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85      jmmv     4364:       2</a>).  It summarizes multiple details on how to make
                   4365:       software easier to package; all the suggestions in it were
                   4366:       collected from our experience in pkgsrc work, so they are possibly
                   4367:       helpful when creating patches too.</p>
                   4368: </div>
1.148     asau     4369: <div class="sect2">
1.85      jmmv     4370: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4371: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4372: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4373:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4374:       improvements you do to a package to the mainstream developers.
                   4375:       This is the only way to get their attention on portability issues
                   4376:       and to ensure that future versions can be built out-of-the box on
                   4377:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4378:       the fixes straight from the packaged code.</p>
1.93      rillig   4379: <p>This generally involves cleaning up the patches
                   4380:       (because sometimes the patches that are
1.147     wiz      4381:       added to pkgsrc are quick hacks), filing bug reports in the
1.85      jmmv     4382:       appropriate trackers for the projects and working with the
                   4383:       mainstream authors to accept your changes.  It is
                   4384:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4385:       the packages in pkgsrc are kept simple and thus further changes
                   4386:       can be done without much hassle.</p>
1.130     wiz      4387: <p>When you have done this, please add a URL to the upstream
                   4388:       bug report to the patch comment.</p>
1.85      jmmv     4389: <p>Support the idea of free software!</p>
                   4390: </div>
1.75      rillig   4391: </div>
1.148     asau     4392: <div class="sect1">
1.75      rillig   4393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4394: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148     asau     4395: <div class="variablelist"><dl class="variablelist">
1.76      rillig   4396: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4397: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4398:          any credits where they are due.  Please bear in mind that others do not
                   4399:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4400:          will read everything that you write here.</p></dd>
1.76      rillig   4401: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4402: <dd><p>This file governs the files that are installed on your
                   4403:          system: all the binaries, manual pages, etc. There are other
                   4404:          directives which may be entered in this file, to control the
                   4405:          creation and deletion of directories, and the location of
1.110     hubertf  4406:          inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87      wiz      4407:          information.</p></dd>
1.75      rillig   4408: </dl></div>
                   4409: </div>
1.148     asau     4410: <div class="sect1">
1.75      rillig   4411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4412: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148     asau     4413: <div class="sect2">
1.78      rillig   4414: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4415: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148     asau     4416: <div class="variablelist"><dl class="variablelist">
1.76      rillig   4417: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135     wiz      4418: <dd>
1.189     snj      4419: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      4420:            First time after package extraction and before files are
                   4421:            moved in place, the second time after the files to install
                   4422:            are moved in place. This can be used to do any custom
                   4423:            procedures not possible with @exec commands in
1.189     snj      4424:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   4425:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.
1.135     wiz      4426:            Please note that you can modify variables in it easily by using
                   4427:            <code class="varname">FILES_SUBST</code> in the package's
                   4428:            <code class="filename">Makefile</code>:</p>
                   4429: <pre class="programlisting">
                   4430: FILES_SUBST+=  SOMEVAR="somevalue"
                   4431: </pre>
                   4432: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   4433:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4434:            performed for <code class="varname">PREFIX</code>,
                   4435:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4436:            <code class="varname">VARBASE</code>, and a few others, type
                   4437:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4438:            complete list.</p>
                   4439: </dd>
1.76      rillig   4440: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4441: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4442:            this script's responsibility to clean up any additional messy details
                   4443:            around the package's installation, since all pkg_delete knows is how to
                   4444:            delete the files created in the original distribution.
1.189     snj      4445:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4446:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135     wiz      4447:            The same methods to replace variables can be used as for
                   4448:            the <code class="filename">INSTALL</code> file.</p></dd>
1.76      rillig   4449: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4450: <dd>
                   4451: <p>This file is displayed after installation of the package.
1.87      wiz      4452:            Useful for things like legal notices on almost-free
                   4453:            software and hints for updating config files after
                   4454:            installing modules for apache, PHP etc.
                   4455:            Please note that you can modify variables in it easily by using
                   4456:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4457:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4458: <pre class="programlisting">
1.100     rillig   4459: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4460: </pre>
1.128     wiz      4461: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.87      wiz      4462:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4463:            performed for <code class="varname">PKGNAME</code>,
                   4464:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.209     sevan    4465:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.87      wiz      4466:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4467:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  4468:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      4469: <p>You can display a different or additional files by
                   4470:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4471:            default is <code class="filename">MESSAGE</code>, if the file
                   4472:            exists.</p>
1.75      rillig   4473: </dd>
1.78      rillig   4474: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174     asau     4475: <dd>
                   4476: <p>This file is used by the alternatives framework.
                   4477:            It creates, configures, and destroys generic wrappers used to
                   4478:            run programs with similar interfaces.
                   4479:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   4480:             for more information.</p>
                   4481: <p>Each line of the file contains two filenames, first
                   4482:            the wrapper and then the alternative provided by the package.
                   4483:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   4484: </dd>
1.78      rillig   4485: </dl></div>
                   4486: </div>
1.148     asau     4487: <div class="sect2">
1.78      rillig   4488: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4489: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148     asau     4490: <div class="variablelist"><dl class="variablelist">
1.78      rillig   4491: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4492: <dd><p>This file contains arbitrary things that could
                   4493:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4494:        to be used by more than one package. This file should only be
                   4495:        used when the packages that will use the file are known in
                   4496:        advance. For other purposes it is often better to write a
                   4497:        <code class="filename">*.mk</code> file and give it a good name that
                   4498:        describes what it does.</p></dd>
                   4499: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4500: <dd><p>This file contains the dependency information
1.110     hubertf  4501:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.78      rillig   4502: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4503: <dd><p>This file contains workarounds for compiler bugs
                   4504:        and similar things. It is included automatically by the pkgsrc
                   4505:        infrastructure, so you don't need an extra
                   4506:        <code class="literal">.include</code> line for
                   4507:        it.</p></dd>
                   4508: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4509: <dd><p>This file contains the code for the
1.110     hubertf  4510:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.78      rillig   4511:        selected by the user. If a package has only one or two options,
                   4512:        it is equally acceptable to put the code directly into the
                   4513:        <code class="filename">Makefile</code>.</p></dd>
                   4514: </dl></div>
                   4515: </div>
1.148     asau     4516: <div class="sect2">
1.78      rillig   4517: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4518: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148     asau     4519: <div class="variablelist"><dl class="variablelist">
1.78      rillig   4520: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4521: <dd><p>These files do not take place in the creation of
                   4522:        a package and thus are purely informative to the package
                   4523:        developer.</p></dd>
                   4524: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4525: <dd><p>This file contains things that need to be done
                   4526:        to make the package even
                   4527:        better.</p></dd>
1.75      rillig   4528: </dl></div>
                   4529: </div>
1.78      rillig   4530: </div>
1.148     asau     4531: <div class="sect1">
1.75      rillig   4532: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4533: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   4534: </h2></div></div></div>
1.110     hubertf  4535: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      4536:     unpacked into the directory denoted by
                   4537:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  4538:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      4539:     directory is also used to keep various timestamp files.
                   4540:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4541:     The default is <code class="filename">${.CURDIR}/work</code>
                   4542:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4543:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4544: </div>
1.148     asau     4545: <div class="sect1">
1.75      rillig   4546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4547: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   4548: </h2></div></div></div>
1.75      rillig   4549: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4550:     to configuration or building, you could place these files here and use
1.110     hubertf  4551:     a <span class="command"><strong>${CP}</strong></span> command in the
1.128     wiz      4552:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.87      wiz      4553:     this. Alternatively, you could simply diff the file against
                   4554:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4555:     the creation of this file.</p>
                   4556: <p>If you want to share files in this way with other
                   4557:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4558:     to the other package's <code class="filename">files</code> directory,
                   4559:     e.g.:</p>
                   4560: <pre class="programlisting">
1.100     rillig   4561: FILESDIR=${.CURDIR}/../xemacs/files
                   4562: </pre>
1.75      rillig   4563: </div>
                   4564: </div>
1.148     asau     4565: <div class="chapter">
1.75      rillig   4566: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4567: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4568: <div class="toc">
                   4569: <p><b>Table of Contents</b></p>
1.210     leot     4570: <dl class="toc">
1.106     rillig   4571: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      4572: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   4573: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4574: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4575: <dd><dl>
                   4576: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4577: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4578: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4579: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4580: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75      rillig   4581: </dl></dd>
                   4582: </dl>
                   4583: </div>
1.76      rillig   4584: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4585:   each of which forms a well-defined part of the pkgsrc system. Using
1.189     snj      4586:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75      rillig   4587:   like pkgsrc requires some discipline to keep the code correct and
                   4588:   understandable.</p>
1.76      rillig   4589: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4590:   programming are variables (which are actually macros) and shell
                   4591:   commands. Among these shell commands may even be more complex ones
1.189     snj      4592:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75      rillig   4593:   as intended it is necessary to quote all variables correctly when they
                   4594:   are used.</p>
                   4595: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4596:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4597:   with them.</p>
1.148     asau     4598: <div class="sect1">
1.75      rillig   4599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4600: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148     asau     4601: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97      rillig   4602: <p>When you are creating a file as a
                   4603:     target of a rule, always write the data to a temporary file first
                   4604:     and finally rename that file. Otherwise there might occur an error
                   4605:     in the middle of generating the file, and when the user runs
1.189     snj      4606:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97      rillig   4607:     regenerated properly. Example:</p>
                   4608: <pre class="programlisting">
1.100     rillig   4609: wrong:
                   4610:         @echo "line 1" &gt; ${.TARGET}
                   4611:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4612:         @false
                   4613: 
                   4614: correct:
                   4615:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4616:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4617:         @false
                   4618:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4619: </pre>
1.110     hubertf  4620: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4621:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4622:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4623:     correct</strong></span> gives an error message twice, as expected.</p>
1.189     snj      4624: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97      rillig   4625:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4626:     happens when it is interrupted, for example by pressing
                   4627:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.189     snj      4628:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97      rillig   4629: </li></ul></div>
                   4630: </div>
1.148     asau     4631: <div class="sect1">
1.97      rillig   4632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4633: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4634: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4635:     can be processed using the five operators ``='', ``+='', ``?='',
1.189     snj      4636:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75      rillig   4637:     page.</p>
                   4638: <p>When a variable's value is parsed from a
1.76      rillig   4639:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4640:     backslash character ``\'' are handled specially. If a backslash is
                   4641:     followed by a newline, any whitespace immediately in front of the
                   4642:     backslash, the backslash, the newline, and any whitespace
                   4643:     immediately behind the newline are replaced with a single space. A
                   4644:     backslash character and an immediately following hash character are
                   4645:     replaced with a single hash character. Otherwise, the backslash is
                   4646:     passed as is. In a variable assignment, any hash character that is
                   4647:     not preceded by a backslash starts a comment that continues upto the
                   4648:     end of the logical line.</p>
                   4649: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4650:     the only way to create a variable consisting of a single backslash
                   4651:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4652: <p>So far for defining variables. The other thing you can do with
                   4653:     variables is evaluating them. A variable is evaluated when it is
                   4654:     part of the right side of the ``:='' or the ``!='' operator, or
                   4655:     directly before executing a shell command which the variable is part
1.189     snj      4656:     of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75      rillig   4657:     is, variables are not evaluated until there's no other way. The
                   4658:     ``modifiers'' mentioned in the man page also evaluate the
                   4659:     variable.</p>
                   4660: <p>Some of the modifiers split the string into words and then
                   4661:     operate on the words, others operate on the string as a whole. When
                   4662:     a string is split into words, it is split as you would expect
1.189     snj      4663:     it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.126     jakllsch 4664: <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
1.75      rillig   4665:     loop does not follow the shell quoting rules but splits at sequences
                   4666:     of whitespace.</p>
                   4667: <p>There are several types of variables that should be handled
                   4668:     differently. Strings and two types of lists.</p>
1.148     asau     4669: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4670: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75      rillig   4671:       characters. Nevertheless, you should restrict yourself to only
                   4672:       using printable characters. Examples are
                   4673:       <code class="varname">PREFIX</code> and
                   4674:       <code class="varname">COMMENT</code>.</p></li>
1.128     wiz      4675: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75      rillig   4676:       are never exported to any shell command. Their elements are
                   4677:       separated by whitespace. Therefore, the elements themselves cannot
                   4678:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  4679:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   4680:       Examples are <code class="varname">DEPENDS</code> and
                   4681:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128     wiz      4682: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75      rillig   4683:       may be exported to a shell command. Their elements can contain any
                   4684:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  4685:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   4686:       <code class="varname">DISTFILES</code> and
                   4687:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4688: </ul></div>
1.148     asau     4689: <div class="sect2">
1.75      rillig   4690: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4691: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148     asau     4692: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4693: <li class="listitem"><p>All variable names starting with an underscore
1.75      rillig   4694:        are reserved for use by the pkgsrc infrastructure. They shall
                   4695:        not be used by package
1.76      rillig   4696:        <code class="filename">Makefile</code>s.</p></li>
1.128     wiz      4697: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4698:        lowercase variable names for the iteration
                   4699:        variables.</p></li>
1.128     wiz      4700: <li class="listitem"><p>All list variables should have a ``plural''
1.75      rillig   4701:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4702:        <code class="varname">DISTFILES</code>.</p></li>
                   4703: </ul></div>
                   4704: </div>
                   4705: </div>
1.148     asau     4706: <div class="sect1">
1.75      rillig   4707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4708: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75      rillig   4709: <p>This section presents you with some code snippets you should
                   4710:     use in your own code. If you don't find anything appropriate here,
                   4711:     you should test your code and add it here.</p>
1.148     asau     4712: <div class="sect2">
1.75      rillig   4713: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4714: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   4715: <pre class="programlisting">
1.100     rillig   4716: STRING=                 foo * bar `date`
                   4717: INT_LIST=               # empty
                   4718: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4719: EXT_LIST=               # empty
                   4720: ANOTHER_EXT_LIST=       a=b c=d
                   4721: 
                   4722: INT_LIST+=              ${STRING}               # 1
                   4723: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4724: EXT_LIST+=              ${STRING:Q}             # 3
                   4725: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    4726: </pre>
1.75      rillig   4727: <p>When you add a string to an external list (example 3), it
                   4728:       must be quoted. In all other cases, you must not add a quoting
                   4729:       level. You must not merge internal and external lists, unless you
                   4730:       are sure that all entries are correctly interpreted in both
                   4731:       lists.</p>
                   4732: </div>
1.148     asau     4733: <div class="sect2">
1.75      rillig   4734: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4735: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75      rillig   4736: <pre class="programlisting">
1.100     rillig   4737: EXT_LIST=       # empty
                   4738: .for i in ${INT_LIST}
                   4739: EXT_LIST+=      ${i:Q}""
                   4740: .endfor
1.1       grant    4741: </pre>
1.75      rillig   4742: <p>This code converts the internal list
                   4743:       <code class="varname">INT_LIST</code> into the external list
                   4744:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   4745:       are unquoted they must be quoted here. The reason for appending
                   4746:       <code class="varname">""</code> is explained below.</p>
                   4747: </div>
1.148     asau     4748: <div class="sect2">
1.75      rillig   4749: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4750: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   4751: <p>Sometimes you may want to print an arbitrary string. There
                   4752:        are many ways to get it wrong and only few that can handle every
                   4753:        nastiness.</p>
1.75      rillig   4754: <pre class="programlisting">
1.100     rillig   4755: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   4756: EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    4757: 
1.100     rillig   4758: all:
                   4759:         echo ${STRING}                  # 1
                   4760:         echo "${STRING}"                # 2
                   4761:         echo "${STRING:Q}"              # 3
                   4762:         echo ${STRING:Q}                # 4
                   4763:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   4764:         printf "%s\\n" ${STRING:Q}""    # 6
                   4765:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    4766: </pre>
1.75      rillig   4767: <p>Example 1 leads to a syntax error in the shell, as the
                   4768:       characters are just copied.</p>
                   4769: <p>Example 2 leads to a syntax error too, and if you leave out
                   4770:       the last " character from <code class="varname">${STRING}</code>,
1.189     snj      4771:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75      rillig   4772:       variable would be evaluated, too.</p>
                   4773: <p>Example 3 outputs each space character preceded by a
                   4774:       backslash (or not), depending on the implementation of the
1.189     snj      4775:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75      rillig   4776: <p>Example 4 handles correctly every string that does not start
                   4777:       with a dash. In that case, the result depends on the
1.189     snj      4778:       implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75      rillig   4779:       guarantee that your input does not start with a dash, this form is
                   4780:       appropriate.</p>
                   4781: <p>Example 5 handles even the case of a leading dash
                   4782:       correctly.</p>
1.79      rillig   4783: <p>Example 6 also works with every string and is the
                   4784:       light-weight solution, since it does not involve a pipe, which has
                   4785:       its own problems.</p>
1.75      rillig   4786: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   4787:       because the quoting has already been done when adding elements to
                   4788:       the list.</p>
                   4789: <p>As internal lists shall not be passed to the shell, there is
                   4790:       no example for it.</p>
                   4791: </div>
1.148     asau     4792: <div class="sect2">
1.75      rillig   4793: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4794: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75      rillig   4795: <p>There are many possible sources of wrongly quoted variables.
                   4796:       This section lists some of the commonly known ones.</p>
1.148     asau     4797: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4798: <li class="listitem">
1.75      rillig   4799: <p>Whenever you use the value of a list, think
                   4800:        about what happens to leading or trailing whitespace. If the
                   4801:        list is a well-formed shell expression, you can apply the
                   4802:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   4803:        whitespace from each word. The <code class="varname">:M</code> operator
                   4804:        first splits its argument according to the rules of the shell,
                   4805:        and then creates a new list consisting of all words that match
                   4806:        the shell glob expression <code class="varname">*</code>, that is: all.
                   4807:        One class of situations where this is needed is when adding a
                   4808:        variable like <code class="varname">CPPFLAGS</code> to
                   4809:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   4810:        invokes other configure scripts, it strips the leading and
                   4811:        trailing whitespace from the variable and then passes it to the
                   4812:        other configure scripts. But these configure scripts expect the
                   4813:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   4814:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   4815:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   4816:        here is how we do it:</p>
                   4817: <pre class="programlisting">
1.100     rillig   4818: CPPFLAGS=               # empty
                   4819: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   4820: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4821: 
                   4822: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4823: 
                   4824: all:
                   4825:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   4826:         echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    4827: </pre>
1.75      rillig   4828: </li>
1.128     wiz      4829: <li class="listitem"><p>The example above contains one bug: The
1.75      rillig   4830:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   4831:        expression, but there is the C compiler after it, which also
                   4832:        expects a properly quoted string (this time in C syntax). The
                   4833:        version above is therefore only correct if
                   4834:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   4835:        or double quotes. If you want to allow these, you have to add
                   4836:        another layer of quoting to each variable that is used as a C
                   4837:        string literal. You cannot use the <code class="varname">:Q</code>
                   4838:        operator for it, as this operator only works for the
                   4839:        shell.</p></li>
1.128     wiz      4840: <li class="listitem">
1.75      rillig   4841: <p>Whenever a variable can be empty, the
                   4842:        <code class="varname">:Q</code> operator can have surprising results. Here
                   4843:        are two completely different cases which can be solved with the
                   4844:        same trick.</p>
                   4845: <pre class="programlisting">
1.100     rillig   4846: EMPTY=                  # empty
                   4847: empty_test:
                   4848:         for i in a ${EMPTY:Q} c; do \
                   4849:             echo "$$i"; \
                   4850:         done
                   4851: 
                   4852: for_test:
                   4853: .for i in a:\ a:\test.txt
                   4854:         echo ${i:Q}
                   4855:         echo "foo"
                   4856: .endfor
1.1       grant    4857: </pre>
1.75      rillig   4858: <p>The first example will only print two of the three lines
                   4859:        we might have expected. This is because
                   4860:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   4861:        the shell cannot see. The workaround is to write
                   4862:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   4863:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   4864:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   4865: <p>The second example will only print three lines instead of
                   4866:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   4867:        This is because the backslash of the value
                   4868:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.189     snj      4869:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
                   4870:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75      rillig   4871:        <code class="varname">${i:Q}""</code>.</p>
                   4872: </li>
                   4873: </ul></div>
                   4874: </div>
1.148     asau     4875: <div class="sect2">
1.75      rillig   4876: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4877: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   4878: <p>The pkgsrc bmake program does not handle the following
                   4879:       assignment correctly. In case <code class="varname">_othervar_</code>
                   4880:       contains a ``-'' character, one of the closing braces is included
                   4881:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   4882: <pre class="programlisting">
1.100     rillig   4883: VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    4884: </pre>
1.75      rillig   4885: <p>For a more complex code snippet and a workaround, see the
1.189     snj      4886:       package <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/regress/make-quoting/README.html" target="_top"><code class="filename">regress/make-quoting</code></a>, testcase
1.75      rillig   4887:       <code class="varname">bug1</code>.</p>
                   4888: </div>
                   4889: </div>
                   4890: </div>
1.148     asau     4891: <div class="chapter">
1.75      rillig   4892: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4893: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   4894: <div class="toc">
                   4895: <p><b>Table of Contents</b></p>
1.210     leot     4896: <dl class="toc">
1.106     rillig   4897: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      4898: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   4899: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106     rillig   4900: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   4901: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      4902: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig   4903: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz      4904: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   4905: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.75      rillig   4906: </dl>
                   4907: </div>
1.87      wiz      4908: <p>The <code class="filename">PLIST</code> file contains a package's
1.128     wiz      4909:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.87      wiz      4910:   the package (relative to the <code class="filename">${PREFIX}</code>
                   4911:   directory it's been installed in) plus some additional statements
1.189     snj      4912:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87      wiz      4913:   This chapter addresses some issues that need attention when
                   4914:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   4915:   below!).</p>
1.148     asau     4916: <div class="sect1">
1.75      rillig   4917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4918: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      4919: <p>Be sure to add a RCS ID line as the first thing in any
                   4920:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   4921: <pre class="programlisting">
1.100     rillig   4922: @comment $NetBSD$
1.87      wiz      4923:     </pre>
1.75      rillig   4924: </div>
1.148     asau     4925: <div class="sect1">
1.75      rillig   4926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4927: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  4928: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      4929:     to output a PLIST that matches any new files since the package
1.110     hubertf  4930:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a> for
1.87      wiz      4931:     more information on this target.</p>
1.75      rillig   4932: </div>
1.148     asau     4933: <div class="sect1">
1.75      rillig   4934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  4935: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   4936: </h2></div></div></div>
1.87      wiz      4937: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   4938:     of AWK patterns and actions that are used to filter the output of
                   4939:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   4940:     scripting you like to it, but be careful with quoting.</p>
                   4941: <p>For example, to get all files inside the
                   4942:     <code class="filename">libdata/foo</code> directory removed from the
                   4943:     resulting PLIST:</p>
                   4944: <pre class="programlisting">
1.100     rillig   4945: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.87      wiz      4946:     </pre>
1.75      rillig   4947: </div>
1.148     asau     4948: <div class="sect1">
1.75      rillig   4949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4950: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      4951: <p>A number of variables are substituted automatically in
                   4952:     PLISTs when a package is installed on a system. This includes the
                   4953:     following variables:</p>
1.148     asau     4954: <div class="variablelist"><dl class="variablelist">
1.75      rillig   4955: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   4956: <dd>
                   4957: <p>Some packages like emacs and perl embed information
1.87      wiz      4958:          about which architecture they were built on into the
                   4959:          pathnames where they install their files. To handle this
                   4960:          case, PLIST will be preprocessed before actually used, and
                   4961:          the symbol
1.128     wiz      4962:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.110     hubertf  4963:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      4964:          same is done if the string
                   4965:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   4966:          PLIST somewhere - use this on packages that have GNU
                   4967:          autoconf-created configure scripts.</p>
1.148     asau     4968: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   4969: <h3 class="title">Legacy note</h3>
                   4970: <p>There used to be a symbol
1.128     wiz      4971:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.110     hubertf  4972:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      4973:            -m</strong></span>, but that's no longer supported and has
                   4974:            been removed.</p>
1.75      rillig   4975: </div>
                   4976: </dd>
                   4977: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   4978: <dd>
                   4979: <p>Some packages want to embed the OS name and version
1.87      wiz      4980:          into some paths.  To do this, use these variables in the
                   4981:          <code class="filename">PLIST</code>:
                   4982:          </p>
1.148     asau     4983: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4984: <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>
                   4985: <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>
                   4986: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</span></p></li>
1.75      rillig   4987: </ul></div>
                   4988: </dd>
                   4989: </dl></div>
1.199     tnn      4990: <p>For a list of values which are replaced by
                   4991:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   4992: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   4993: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87      wiz      4994: <p>If you want to change other variables not listed above, you
                   4995:     can add variables and their expansions to this variable in the
1.110     hubertf  4996:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, &#8220;Optional files&#8221;</a>):</p>
1.75      rillig   4997: <pre class="programlisting">
1.100     rillig   4998: PLIST_SUBST+=   SOMEVAR="somevalue"
1.87      wiz      4999:     </pre>
1.128     wiz      5000: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.87      wiz      5001:     in the <code class="filename">PLIST</code> with
1.128     wiz      5002:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.120     snj      5003: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119     mishka   5004:     the common case of conditionally including some
                   5005:     <code class="filename">PLIST</code> entries. It can be done by adding
                   5006:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120     snj      5007:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   5008:     to <code class="literal">yes</code> if the entry should be included.
1.128     wiz      5009:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.119     mishka   5010:     in the <code class="filename">PLIST</code> with either
1.128     wiz      5011:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   5012:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.119     mishka   5013:     For example, in <code class="filename">Makefile</code>:</p>
                   5014: <pre class="programlisting">
                   5015: PLIST_VARS+=   foo
                   5016: .if <em class="replaceable"><code>condition</code></em>
                   5017: PLIST.foo=     yes
                   5018: .else
                   5019:     </pre>
                   5020: <p>And then in <code class="filename">PLIST</code>:</p>
                   5021: <pre class="programlisting">
                   5022: @comment $NetBSD$
                   5023: bin/bar
                   5024: man/man1/bar.1
                   5025: ${PLIST.foo}bin/foo
                   5026: ${PLIST.foo}man/man1/foo.1
                   5027: ${PLIST.foo}share/bar/foo.data
                   5028:     </pre>
1.75      rillig   5029: </div>
1.148     asau     5030: <div class="sect1">
1.75      rillig   5031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5032: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   5033: <p>Man pages should be installed in compressed form if
1.87      wiz      5034:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5035:     and uncompressed otherwise. To handle this in the
1.128     wiz      5036:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.87      wiz      5037:     appended/removed automatically for man pages according to
                   5038:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5039:     or not, see above for details. This modification of the
                   5040:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5041:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5042: </div>
1.148     asau     5043: <div class="sect1">
1.75      rillig   5044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5045: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   5046: </h2></div></div></div>
1.76      rillig   5047: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5048:     in generating the binary package, set the variable
                   5049:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.189     snj      5050:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87      wiz      5051:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5052:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   5053: </div>
1.148     asau     5054: <div class="sect1">
1.75      rillig   5055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5056: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5057: <p>Some packages decide to install a different set of files based on
1.87      wiz      5058:     the operating system being used. These differences can be
                   5059:     automatically handled by using the following files:</p>
1.148     asau     5060: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5061: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   5062: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5063: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5064: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5065: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5066: </ul></div>
                   5067: </div>
1.148     asau     5068: <div class="sect1">
1.75      rillig   5069: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.197     wiz      5070: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
                   5071: <p>Some packages decide to generate hard-to-guess file names
                   5072:     during installation that are hard to wire down.</p>
                   5073: <p>In such cases, you can set the
                   5074:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   5075:     terminated (with a semicolon) that will output PLIST entries which
                   5076:     will be appended to the PLIST</p>
                   5077: <p>You can find one example in editors/xemacs:</p>
                   5078: <pre class="programlisting">
                   5079:       GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   5080:     </pre>
                   5081: <p>which will append something like
                   5082:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   5083:     <code class="filename">PLIST</code>.
                   5084:     </p>
                   5085: </div>
                   5086: <div class="sect1">
                   5087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5088: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.128     wiz      5089: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.87      wiz      5090:     multiple (and unrelated) packages install files.  These
1.125     wiz      5091:     directories were problematic because you had to add special
                   5092:     tricks in the PLIST to conditionally remove them, or have some
1.87      wiz      5093:     centralized package handle them.</p>
1.125     wiz      5094: <p>In pkgsrc, it is now easy: Each package should create
                   5095:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   5096:     will remove any directories left empty after uninstalling a
                   5097:     package.</p>
                   5098: <p>If a package needs an empty directory to work, create
                   5099:     the directory during installation as usual, and also add an
                   5100:     entry to the PLIST:
                   5101:     </p>
1.87      wiz      5102: <pre class="programlisting">
1.125     wiz      5103: @pkgdir path/to/empty/directory
1.87      wiz      5104:     </pre>
1.125     wiz      5105: <p>
1.197     wiz      5106:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   5107:     <code class="varname">OWN_DIRS</code>.
1.125     wiz      5108:     </p>
1.75      rillig   5109: </div>
                   5110: </div>
1.148     asau     5111: <div class="chapter">
1.75      rillig   5112: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5113: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   5114: <div class="toc">
                   5115: <p><b>Table of Contents</b></p>
1.210     leot     5116: <dl class="toc">
1.106     rillig   5117: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      5118: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5119: <dd><dl>
1.106     rillig   5120: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      5121: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   5122:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5123:       and
                   5124:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5125:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5126: </dl></dd>
1.128     wiz      5127: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75      rillig   5128: <dd><dl>
1.128     wiz      5129: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106     rillig   5130: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75      rillig   5131: </dl></dd>
                   5132: </dl>
                   5133: </div>
                   5134: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5135:   are seen by a package's configure and build processes.  This is implemented
                   5136:   in a two step process:</p>
1.128     wiz      5137: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5138: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87      wiz      5139:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5140:       of <code class="varname">WRKDIR</code>.</p></li>
1.128     wiz      5141: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5142:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5143:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5144:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5145:       native compiler on some operating systems look like GCC, so that
                   5146:       packages that expect GCC won't require modifications to build with
                   5147:       those native compilers.</p></li>
1.75      rillig   5148: </ol></div>
                   5149: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5150:   package may be built consistently despite what other software may be
                   5151:   installed. Please note that the normal system header and library paths,
                   5152:   e.g. <code class="filename">/usr/include</code>,
                   5153:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5154:   designed to insulate the package build from non-system-supplied
                   5155:   software.</p>
1.148     asau     5156: <div class="sect1">
1.75      rillig   5157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5158: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5159: <p>The process of converting packages to use the buildlink3
1.128     wiz      5160:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.87      wiz      5161:     The things to keep in mind are:</p>
1.128     wiz      5162: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5163: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87      wiz      5164:        instead of the actual toolchain.  Some packages are tricky,
                   5165:        and the only way to know for sure is the check
                   5166:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5167:        wrappers are being invoked.</p></li>
1.128     wiz      5168: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87      wiz      5169:        the package Makefile, e.g. Java VMs, standalone shells,
                   5170:        etc., because the code to symlink files into
                   5171:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128     wiz      5172:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
1.87      wiz      5173:        </p></li>
1.128     wiz      5174: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87      wiz      5175:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5176:        package's Makefile are added as dependencies for that package.
                   5177:        </p></li>
1.75      rillig   5178: </ol></div>
1.87      wiz      5179: <p>If a dependency on a particular package is required for its libraries and
                   5180:     headers, then we replace:</p>
1.75      rillig   5181: <pre class="programlisting">
1.100     rillig   5182: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5183: </pre>
1.75      rillig   5184: <p>with</p>
                   5185: <pre class="programlisting">
1.100     rillig   5186: .include "../../category/foo/buildlink3.mk"
                   5187: </pre>
1.75      rillig   5188: <p>The buildlink3.mk files usually define the required dependencies.
                   5189:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5190:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5191: <pre class="programlisting">
1.100     rillig   5192: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5193: .include "../../category/foo/buildlink3.mk"
                   5194: </pre>
1.76      rillig   5195: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5196:     files in <code class="filename">pkgsrc/mk</code>
                   5197:     that handle special package issues:</p>
1.148     asau     5198: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5199: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5200:        the native or a pkgsrc Berkeley DB implementation based on
                   5201:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5202:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128     wiz      5203: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5204:        comes with neither Curses nor NCurses, this will take care
1.189     snj      5205:        to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.128     wiz      5206: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5207:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5208:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5209:        require a Kerberos 5 implementation.</p></li>
1.128     wiz      5210: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88      wiz      5211:        system-provided Motif installation or adds a dependency on
1.189     snj      5212:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>.  The user can set
1.128     wiz      5213:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.151     obache   5214:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span> or
                   5215:        <span class="quote">&#8220;<span class="quote">openmotif</span>&#8221;</span> to choose
1.88      wiz      5216:        which Motif version will be used.</p></li>
1.161     ryoon    5217: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162     wiz      5218:        system-provided GNU readline or editline (libedit) installation,
1.189     snj      5219:        or adds a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
                   5220:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.161     ryoon    5221:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   5222:        If your package really needs GNU readline library, its Makefile
                   5223:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   5224:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128     wiz      5225: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5226:        variables that may be used by packages that use the
                   5227:        Open Sound System (OSS) API.</p></li>
1.128     wiz      5228: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142     wiz      5229:        any of the Postgres versions in the variable
                   5230:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   5231:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87      wiz      5232:        the file for more information.</p></li>
1.128     wiz      5233: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5234:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.189     snj      5235:        a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.128     wiz      5236: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5237:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5238:        library.</p></li>
1.75      rillig   5239: </ul></div>
1.76      rillig   5240: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5241:     files provide a more complete
                   5242:     description of how to use them properly.</p>
1.75      rillig   5243: </div>
1.148     asau     5244: <div class="sect1">
1.75      rillig   5245: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5246: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   5247: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      5248:     included by Makefiles to indicate the need to compile and link
                   5249:     against header files and libraries provided by the package.  A
                   5250:     <code class="filename">buildlink3.mk</code> file should always provide
                   5251:     enough information to add the correct type of dependency
                   5252:     relationship and include any other
                   5253:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5254:     headers and libraries that it needs in turn.</p>
                   5255: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.189     snj      5256:     file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87      wiz      5257:     package is highly recommended.  For most packages, the following
                   5258:     command will generate a good starting point for
                   5259:     <code class="filename">buildlink3.mk</code> files:</p>
                   5260: <pre class="screen">
                   5261: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5262: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5263:     </pre>
1.148     asau     5264: <div class="sect2">
1.75      rillig   5265: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5266: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5267: <p>The following real-life example
1.87      wiz      5268:       <code class="filename">buildlink3.mk</code> is taken
                   5269:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5270: <pre class="programlisting">
1.120     snj      5271: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       grant    5272: 
1.120     snj      5273: BUILDLINK_TREE+=       tiff
1.1       grant    5274: 
1.120     snj      5275: .if !defined(TIFF_BUILDLINK3_MK)
                   5276: TIFF_BUILDLINK3_MK:=
1.87      wiz      5277: 
1.120     snj      5278: BUILDLINK_API_DEPENDS.tiff+=   tiff&gt;=3.6.1
                   5279: BUILDLINK_ABI_DEPENDS.tiff+=   tiff&gt;=3.7.2nb1
                   5280: BUILDLINK_PKGSRCDIR.tiff?=     ../../graphics/tiff
1.87      wiz      5281: 
1.100     rillig   5282: .include "../../devel/zlib/buildlink3.mk"
                   5283: .include "../../graphics/jpeg/buildlink3.mk"
1.120     snj      5284: .endif # TIFF_BUILDLINK3_MK
1.87      wiz      5285: 
1.120     snj      5286: BUILDLINK_TREE+=       -tiff
1.100     rillig   5287: </pre>
1.87      wiz      5288: <p>The header and footer manipulate
1.120     snj      5289:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87      wiz      5290:       <code class="filename">buildlink3.mk</code> files and is used to track
1.120     snj      5291:       the dependency tree.</p>
                   5292: <p>The main section is protected from multiple inclusion
1.87      wiz      5293:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5294:       added.  Several important variables are set in the section:</p>
1.148     asau     5295: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5296: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5297:          is the actual dependency recorded in the installed
                   5298:          package; this should always be set using
1.110     hubertf  5299:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      5300:          we're appending to any pre-existing list of values.  This
                   5301:          variable should be set to the first version of the
1.133     wiz      5302:          package that had an backwards-incompatible API change.
1.87      wiz      5303:          </p></li>
1.128     wiz      5304: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5305:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5306:          pkgsrc directory.</p></li>
1.128     wiz      5307: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5308:          (not shown above) controls whether we use
                   5309:          <code class="varname">BUILD_DEPENDS</code> or
                   5310:          <code class="varname">DEPENDS</code> to add the dependency on
                   5311:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5312:          selected by setting
                   5313:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5314:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.87      wiz      5315:          used.</p></li>
1.128     wiz      5316: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5317:            and
                   5318:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5319:            (not shown above) are lists of subdirectories of
1.76      rillig   5320:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5321:            to add to the header and library search paths.  These
1.128     wiz      5322:            default to <span class="quote">&#8220;<span class="quote">include</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">lib</span>&#8221;</span>
1.87      wiz      5323:          respectively.</p></li>
1.128     wiz      5324: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5325:            (not shown above) is the list of preprocessor flags to add
                   5326:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128     wiz      5327:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.75      rillig   5328:            should be avoided and instead be handled using
                   5329:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5330:          above.</p></li>
1.75      rillig   5331: </ul></div>
1.87      wiz      5332: <p>The following variables are all optionally defined within
                   5333:       this second section (protected against multiple inclusion) and
                   5334:       control which package files are symlinked into
                   5335:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5336:       transformed during the symlinking:</p>
1.148     asau     5337: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5338: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5339:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5340:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5341:            to be symlinked into
1.76      rillig   5342:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5343:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.128     wiz      5344: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5345:            (not shown above) is a shell pipeline that
                   5346:            outputs to stdout a list of files relative to
                   5347:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5348:            The resulting files are to be symlinked
                   5349:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5350:            this takes the <code class="filename">+CONTENTS</code> of a
                   5351:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5352:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128     wiz      5353: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5354:            (not shown above) is a filter command that filters
1.76      rillig   5355:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5356:            relative to
1.76      rillig   5357:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194     bsiegert 5358:            on stdout.  By default,
1.75      rillig   5359:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5360:            outputs the contents of the <code class="filename">include</code>
                   5361:            and <code class="filename">lib</code> directories in the package
1.194     bsiegert 5362:            <code class="filename">+CONTENTS</code>.</p></li>
1.128     wiz      5363: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5364:            (not shown above) is a list of sed arguments used to
                   5365:            transform the name of the source filename into a
1.110     hubertf  5366:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      5367:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5368: </ul></div>
1.120     snj      5369: <p>This section can additionally include any
1.87      wiz      5370:       <code class="filename">buildlink3.mk</code> needed for
                   5371:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5372:       Including these <code class="filename">buildlink3.mk</code> files
                   5373:       means that the headers and libraries for these
                   5374:       dependencies are also symlinked into
                   5375:       <code class="filename">${BUILDLINK_DIR}</code>
                   5376:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5377:       <code class="filename">buildlink3.mk</code>
1.120     snj      5378:       file is included. Dependencies are only added for directly
                   5379:       include <code class="filename">buildlink3.mk</code> files.</p>
1.153     wiz      5380: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   5381:       including other <code class="filename">buildlink3.mk</code> files in it,
1.156     wiz      5382:       please only add necessary ones, i.e., those whose libraries or
1.153     wiz      5383:       header files are automatically exposed when the package is
                   5384:       use.</p>
                   5385: <p>In particular, if only an executable
                   5386:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   5387:       library does not need to be propagated in the
                   5388:       <code class="filename">buildlink3.mk</code> file.</p>
                   5389: <p>The following steps should help you decide if a
                   5390:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   5391:       </p>
                   5392: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5393: <li class="listitem"><p>Look at the installed header files: What
                   5394:        headers do they include? The packages providing these files
                   5395:        must be buildlinked.</p></li>
1.155     wiz      5396: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   5397:        libraries and look against what other libraries they link.
                   5398:        Some of the packages providing these probably need to be
                   5399:        buildlinked; however, it's not automatic, since e.g. GTK on
                   5400:        some systems pulls in the X libraries, so they will show up in
                   5401:        the <code class="filename">ldd</code> output, while on others (like OS
1.156     wiz      5402:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.155     wiz      5403:        used as a hint.</p></li>
1.153     wiz      5404: </ul></div>
                   5405: <p>
                   5406:       </p>
1.75      rillig   5407: </div>
1.148     asau     5408: <div class="sect2">
1.75      rillig   5409: <div class="titlepage"><div><div><h3 class="title">
1.133     wiz      5410: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87      wiz      5411:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      5412:       and
                   5413:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5414:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   5415: <p>These two variables differ in that one describes source
                   5416:       compatibility (API) and the other binary compatibility (ABI).
                   5417:       The difference is that a change in the API breaks compilation of
                   5418:       programs while changes in the ABI stop compiled programs from
                   5419:       running.</p>
                   5420: <p>Changes to the
1.134     wiz      5421:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      5422:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   5423:       very rarely. One possible reason is that all packages depending
                   5424:       on this already need a newer version. In case it is bumped see
                   5425:       the description below.</p>
                   5426: <p>The most common example of an ABI change is that the major
                   5427:       version of a shared library is increased. In this case,
                   5428:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5429:       should be adjusted to require at least the new package version.
                   5430:       Then the packages that depend on this package need their
                   5431:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   5432:       <code class="filename">buildlink3.mk</code> files, their
                   5433:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5434:       adjusted, too. This is needed so pkgsrc will require the correct
                   5435:       package dependency and not settle for an older one when building
                   5436:       the source.</p>
1.218   ! rillig   5437: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, &#8220;Handling dependencies&#8221;</a> for
1.133     wiz      5438:       more information about dependencies on other packages,
                   5439:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5440:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5441: <p>Please take careful consideration before adjusting
                   5442:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5443:       or
                   5444:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5445:       as we don't want to cause unneeded package deletions and
                   5446:       rebuilds.  In many cases, new versions of packages work just
                   5447:       fine with older dependencies.</p>
                   5448: <p>Also it is not needed to set
1.133     wiz      5449:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5450:       when it is identical to
1.87      wiz      5451:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5452: </div>
                   5453: </div>
1.148     asau     5454: <div class="sect1">
1.75      rillig   5455: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5456: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5457: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5458:       coincide with headers and libraries present in the base system.
1.76      rillig   5459:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5460:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5461:       file that includes the necessary checks to decide whether using
                   5462:       the built-in software or the pkgsrc software is
1.87      wiz      5463:     appropriate.</p>
                   5464: <p>The only requirements of a builtin.mk file for
                   5465:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.128     wiz      5466: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5467: <li class="listitem"><p>It should set
1.87      wiz      5468:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5469:        to either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>
1.87      wiz      5470:        after it is included.</p></li>
1.128     wiz      5471: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87      wiz      5472:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5473:        which is already set before the
                   5474:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.128     wiz      5475: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.87      wiz      5476:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5477:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5478: </ol></div>
1.148     asau     5479: <div class="sect2">
1.75      rillig   5480: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5481: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75      rillig   5482: <p>The following is the recommended template for builtin.mk
1.87      wiz      5483:       files:</p>
1.75      rillig   5484: <pre class="programlisting">
1.100     rillig   5485: .if !defined(IS_BUILTIN.foo)
                   5486: #
                   5487: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5488: # genuinely exists in the system or not.
                   5489: #
                   5490: IS_BUILTIN.foo?=        no
                   5491: 
                   5492: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5493: # version can be determined.
                   5494: #
                   5495: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5496: BUILTIN_PKG.foo?=       foo-1.0
                   5497: .  endif
                   5498: .endif  # IS_BUILTIN.foo
                   5499: 
                   5500: .if !defined(USE_BUILTIN.foo)
                   5501: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5502: .  if defined(BUILTIN_PKG.foo)
                   5503: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5504: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5505: USE_BUILTIN.foo!=                                                       \
                   5506:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5507:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5508: .      endif
                   5509: .    endfor
                   5510: .  endif
                   5511: .endif  # USE_BUILTIN.foo
                   5512: 
                   5513: CHECK_BUILTIN.foo?=     no
                   5514: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5515: #
                   5516: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5517: # "yes" or "no".
                   5518: #
                   5519: .endif  # CHECK_BUILTIN.foo
                   5520: </pre>
1.87      wiz      5521: <p>The first section sets
                   5522:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5523:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5524:       in the base system.  This should not be a base system software
                   5525:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128     wiz      5526:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.87      wiz      5527:       included as part of the base system.  This variable is only
                   5528:       used internally within the <code class="filename">builtin.mk</code>
                   5529:       file.</p>
                   5530: <p>The second section sets
                   5531:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5532:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5533:       system if it exists (if
                   5534:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5535:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.87      wiz      5536:       within the <code class="filename">builtin.mk</code> file.</p>
                   5537: <p>The third section sets
                   5538:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5539:       and is <span class="emphasis"><em>required</em></span> in all
                   5540:       <code class="filename">builtin.mk</code> files.  The code in this
                   5541:       section must make the determination whether the built-in
                   5542:       software is adequate to satisfy the dependencies listed in
                   5543:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5544:       This is typically done by comparing
                   5545:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5546:       against each of the dependencies in
                   5547:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5548:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5549:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5550:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5551:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5552:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.87      wiz      5553:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5554:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.87      wiz      5555:       that the built-in version of the software is similar enough to
                   5556:       be used as a replacement.</p>
                   5557: <p>The last section is guarded by
                   5558:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5559:       and includes code that uses the value of
                   5560:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5561:       set in the previous section.  This typically includes, e.g.,
                   5562:       adding additional dependency restrictions and listing additional
                   5563:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5564:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5565: </div>
1.148     asau     5566: <div class="sect2">
1.75      rillig   5567: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5568: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5569: <p>When building packages, it's possible to choose whether to set
                   5570:        a global preference for using either the built-in (native)
                   5571:        version or the pkgsrc version of software to satisfy a
                   5572:        dependency.  This is controlled by setting
                   5573:        <code class="varname">PREFER_PKGSRC</code> and
                   5574:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.128     wiz      5575:        of either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>, or a list of
1.87      wiz      5576:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5577:        use the pkgsrc versions of software, while
                   5578:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5579:        built-in versions.  Preferences are determined by the most
                   5580:        specific instance of the package in either
                   5581:        <code class="varname">PREFER_PKGSRC</code> or
                   5582:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5583:        in neither or in both variables, then
                   5584:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5585:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5586:        using pkgsrc versions of software for all but the most basic
                   5587:       bits on a NetBSD system, you can set:</p>
                   5588: <pre class="programlisting">
1.100     rillig   5589: PREFER_PKGSRC=  yes
                   5590: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5591: </pre>
1.87      wiz      5592: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5593:       <code class="filename">builtin.mk</code>
                   5594:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5595:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5596: </div>
                   5597: </div>
                   5598: </div>
1.148     asau     5599: <div class="chapter">
1.75      rillig   5600: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5601: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   5602: <div class="toc">
                   5603: <p><b>Table of Contents</b></p>
1.210     leot     5604: <dl class="toc">
1.106     rillig   5605: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75      rillig   5606: <dd><dl>
1.106     rillig   5607: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5608: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   5609: </dl></dd>
1.106     rillig   5610: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   5611: <dd><dl>
1.128     wiz      5612: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig   5613: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5614: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5615: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5616: </dl></dd>
                   5617: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5618: <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>
                   5619: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5620: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5621: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5622: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5623: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75      rillig   5624: </dl>
                   5625: </div>
                   5626: <p>This chapter describes the framework known as
                   5627: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148     asau     5628: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5629: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75      rillig   5630:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      5631: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75      rillig   5632:     provided that packages are correctly designed.</p></li>
1.128     wiz      5633: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5634: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5635: <li class="listitem"><p>Registration of system shells.</p></li>
                   5636: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75      rillig   5637: </ul></div>
                   5638: <p>The following sections inspect each of the above points in detail.</p>
                   5639: <p>You may be thinking that many of the things described here could be
                   5640: easily done with simple code in the package's post-installation target
                   5641: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5642: as the code in them is only executed when building from source.  Machines
                   5643: using binary packages could not benefit from it at all (as the code itself
                   5644: could be unavailable).  Therefore, the only way to achieve any of the items
                   5645: described above is by means of the installation scripts, which are
                   5646: automatically generated by pkginstall.</p>
1.148     asau     5647: <div class="sect1">
1.75      rillig   5648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5649: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5650: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5651: of files and directories that belong to a package.  The names used in it
1.76      rillig   5652: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5653: which means that it cannot register files outside this directory (absolute
                   5654: path names are not allowed).  Despite this restriction, some packages need
                   5655: to install files outside this location; e.g., under
1.76      rillig   5656: <code class="filename">${VARBASE}</code> or
1.87      wiz      5657: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5658: is to create such files during installation time by using
                   5659: installation scripts.</p>
                   5660: <p>The generic installation scripts are shell scripts that can
                   5661: contain arbitrary code.  The list of scripts to execute is taken from
                   5662: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5663: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5664: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5665: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5666: commands, so they have the potential to create and manage files
                   5667: anywhere in the file system.</p>
                   5668: <p>Using these general installation files is not recommended, but
                   5669: may be needed in some special cases.  One reason for avoiding them is
                   5670: that the user has to trust the packager that there is no unwanted or
                   5671: simply erroneous code included in the installation script. Also,
                   5672: previously there were many similar scripts for the same functionality,
                   5673: and fixing a common error involved finding and changing all of
                   5674: them.</p>
                   5675: <p>The pkginstall framework offers another, standardized way.  It
                   5676: provides generic scripts to abstract the manipulation of such files
                   5677: and directories based on variables set in the package's
                   5678: <code class="filename">Makefile</code>.  The rest of this section describes
                   5679: these variables.</p>
1.148     asau     5680: <div class="sect2">
1.75      rillig   5681: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5682: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5683: <p>The following variables can be set to request the creation of
                   5684: directories anywhere in the file system:</p>
1.148     asau     5685: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.218   ! rillig   5686: <li class="listitem">
        !          5687: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75      rillig   5688:     contain a list of directories that should be created and should attempt
                   5689:     to be destroyed by the installation scripts.  The difference between
                   5690:     the two is that the latter prompts the administrator to remove any
                   5691:     directories that may be left after deinstallation (because they were
1.218   ! rillig   5692:     not empty), while the former does not.  Example:</p>
        !          5693: <pre class="programlisting">
        !          5694: MAKE_DIRS+=             ${VARBASE}/foo/private
        !          5695: </pre>
        !          5696: </li>
1.128     wiz      5697: <li class="listitem">
1.75      rillig   5698: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5699:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5700:     which directories should be created and should attempt to be destroyed
                   5701:     by the installation scripts.  Each tuple holds the following values,
                   5702:     separated by spaces: the directory name, its owner, its group and its
                   5703:     numerical mode.  For example:</p>
                   5704: <pre class="programlisting">
1.218   ! rillig   5705: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
        !          5706:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5707: </pre>
1.75      rillig   5708: <p>The difference between the two is exactly the same as their
                   5709:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5710: </li>
                   5711: </ul></div>
                   5712: </div>
1.148     asau     5713: <div class="sect2">
1.75      rillig   5714: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5715: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5716: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5717: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5718: To overcome this problem, the only solution is to extract the file in the
                   5719: known place (i.e., inside the installation prefix) and copy it to the
                   5720: appropriate location during installation (done by the installation scripts
                   5721: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5722: file</em></span> in the following paragraphs, which describe the variables
                   5723: that can be used to automatically and consistently handle files outside the
                   5724: installation prefix:</p>
1.148     asau     5725: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5726: <li class="listitem">
1.75      rillig   5727: <p><code class="varname">CONF_FILES</code> and
1.137     wiz      5728:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75      rillig   5729:     During installation time, the master file is copied to the target one
                   5730:     if and only if the latter does not exist.  Upon deinstallation, the
                   5731:     target file is removed provided that it was not modified by the
                   5732:     installation.</p>
                   5733: <p>The difference between the two is that the latter prompts the
                   5734:     administrator to remove any files that may be left after
                   5735:     deinstallation (because they were not empty), while the former does
                   5736:     not.</p>
                   5737: </li>
1.128     wiz      5738: <li class="listitem">
1.75      rillig   5739: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137     wiz      5740:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75      rillig   5741:     files as well as their target locations.  For each of them, it also
                   5742:     specifies their owner, their group and their numeric permissions, in
                   5743:     this order.  For example:</p>
                   5744: <pre class="programlisting">
1.218   ! rillig   5745: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
        !          5746:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5747: </pre>
1.75      rillig   5748: <p>The difference between the two is exactly the same as their
                   5749:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5750: </li>
                   5751: </ul></div>
                   5752: </div>
                   5753: </div>
1.148     asau     5754: <div class="sect1">
1.75      rillig   5755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5756: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   5757: <p>Configuration files are special in the sense that they are installed
                   5758: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5759: need special treatment during installation (most of which is automated by
                   5760: pkginstall).  The main concept you must bear in mind is that files marked
                   5761: as configuration files are automatically copied to the right place (somewhere
                   5762: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5763: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5764: be removed if they have local modifications.  This ensures that
                   5765: administrators never lose any custom changes they may have made.</p>
1.148     asau     5766: <div class="sect2">
1.75      rillig   5767: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5768: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75      rillig   5769: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5770: specifies where configuration files shall be installed.  Its contents are
                   5771: set based upon the following variables:</p>
1.148     asau     5772: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5773: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5774:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5775:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5776:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5777:     Packages must not use it directly.</p></li>
1.128     wiz      5778: <li class="listitem">
1.75      rillig   5779: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5780:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5781:     for the package being built shall be installed.  The definition of this
                   5782:     variable only makes sense in the package's
1.76      rillig   5783:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5784: <p>As an example, consider the Apache package,
1.189     snj      5785:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.75      rillig   5786:     configuration files under the
1.76      rillig   5787:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5788:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5789:     Makefile.</p>
                   5790: </li>
1.128     wiz      5791: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75      rillig   5792:     variable that holds this package's configuration directory (if
                   5793:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5794:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5795:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128     wiz      5796: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75      rillig   5797:     directory where the configuration files for the package identified by
                   5798:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5799: </ul></div>
                   5800: <p>Based on the above variables, pkginstall determines the value of
                   5801: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5802: variable that can be used within a package to refer to its configuration
                   5803: directory.  The algorithm used to set its value is basically the
                   5804: following:</p>
1.128     wiz      5805: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5806: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75      rillig   5807:     its value is used.</p></li>
1.128     wiz      5808: <li class="listitem"><p>If the previous variable is not defined but
1.75      rillig   5809:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5810:     <code class="filename">Makefile</code>, the resulting value is
                   5811:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128     wiz      5812: <li class="listitem"><p>Otherwise, it is set to
1.76      rillig   5813:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5814: </ol></div>
1.76      rillig   5815: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117     jnemeth  5816: 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
                   5817: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   5818: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   5819: </div>
1.148     asau     5820: <div class="sect2">
1.75      rillig   5821: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5822: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   5823: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5824: known place, you need to teach each package where it shall install its
                   5825: files.  In some cases you will have to patch the package Makefiles to
                   5826: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5827: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5828: generated files:</p>
                   5829: <pre class="programlisting">
1.100     rillig   5830: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    5831: </pre>
1.75      rillig   5832: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5833: for</em></span> its configuration files, not where they will be originally
                   5834: installed (although the difference is never explicit,
                   5835: unfortunately).</p>
                   5836: </div>
1.148     asau     5837: <div class="sect2">
1.75      rillig   5838: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5839: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   5840: <p>As said before, pkginstall automatically handles configuration files.
                   5841: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   5842: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   5843: directly</strong></span>.  Bad news is that many software installation scripts
                   5844: will, out of the box, mess with the contents of that directory.  So what is
                   5845: the correct procedure to fix this issue?</p>
                   5846: <p>You must teach the package (usually by manually patching it) to
                   5847: install any configuration files under the examples hierarchy,
1.76      rillig   5848: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5849: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   5850: has the original copies available.</p>
                   5851: <p>Once the required configuration files are in place (i.e., under the
                   5852: examples hierarchy), the pkginstall framework can use them as master copies
                   5853: during the package installation to update what is in
1.76      rillig   5854: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   5855: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  5856: used.  Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, &#8220;File manipulation&#8221;</a> for information
1.75      rillig   5857: about their syntax and their purpose.  Here is an example, taken from the
1.189     snj      5858: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75      rillig   5859: <pre class="programlisting">
1.100     rillig   5860: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5861: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    5862: </pre>
1.75      rillig   5863: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5864: package and has no meaning outside it.</p>
                   5865: </div>
1.148     asau     5866: <div class="sect2">
1.75      rillig   5867: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5868: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   5869: <p>The automatic copying of config files can be toggled by setting the
                   5870: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5871: installation.</p>
                   5872: </div>
                   5873: </div>
1.148     asau     5874: <div class="sect1">
1.75      rillig   5875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5876: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   5877: <p>System startup scripts are special files because they must be
                   5878: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  5879: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.75      rillig   5880: can be used.  However, pkginstall provides a special mechanism to handle
                   5881: these files.</p>
                   5882: <p>In order to provide system startup scripts, the package has
                   5883: to:</p>
1.128     wiz      5884: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5885: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   5886:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.189     snj      5887:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.76      rillig   5888:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128     wiz      5889: <li class="listitem">
1.75      rillig   5890: <p>Tell pkginstall to handle it, appending the name of the script,
                   5891:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5892:     Continuing the previous example:</p>
                   5893: <pre class="programlisting">
1.100     rillig   5894: RCD_SCRIPTS+=   cupsd
1.1       grant    5895: </pre>
1.75      rillig   5896: </li>
                   5897: </ol></div>
                   5898: <p>Once this is done, pkginstall will do the following steps for each
                   5899: script in an automated fashion:</p>
1.128     wiz      5900: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5901: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76      rillig   5902:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   5903:     variable.</p></li>
1.128     wiz      5904: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76      rillig   5905:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   5906:     that this master file must be explicitly registered in the
1.76      rillig   5907:     <code class="filename">PLIST</code>.</p></li>
1.128     wiz      5908: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75      rillig   5909:     from the examples hierarchy into the system-wide startup scripts
                   5910:     directory.</p></li>
                   5911: </ol></div>
1.148     asau     5912: <div class="sect2">
1.75      rillig   5913: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5914: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   5915: <p>The automatic copying of config files can be toggled by setting the
                   5916: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   5917: installation.  Note that the scripts will be always copied inside the
1.76      rillig   5918: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   5919: matter what the value of this variable is.</p>
                   5920: </div>
                   5921: </div>
1.148     asau     5922: <div class="sect1">
1.75      rillig   5923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5924: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   5925: <p>If a package needs to create special users and/or groups during
                   5926: installation, it can do so by using the pkginstall framework.</p>
                   5927: <p>Users can be created by adding entries to the
                   5928: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   5929: syntax:</p>
                   5930: <pre class="programlisting">
1.100     rillig   5931: user:group
1.1       grant    5932: </pre>
1.87      wiz      5933: <p>Further specification of user details may be done by setting
                   5934: per-user variables.
                   5935: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   5936: numeric UID for the user.
                   5937: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   5938: user's description or comment.
                   5939: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   5940: user's home directory, and defaults to
                   5941: <code class="filename">/nonexistent</code> if not specified.
                   5942: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 5943: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      5944: not specified.</p>
1.75      rillig   5945: <p>Similarly, groups can be created by adding entries to the
                   5946: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   5947: <pre class="programlisting">
1.100     rillig   5948: group
1.1       grant    5949: </pre>
1.93      rillig   5950: <p>The numeric GID of the group may be set by defining
1.75      rillig   5951: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   5952: <p>If a package needs to create the users and groups at an earlier
                   5953: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   5954: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   5955: indicate the phase before which the users and groups are created.  In
                   5956: this case, the numeric UIDs and GIDs of the created users and groups
                   5957: are automatically hardcoded into the final installation scripts.</p>
                   5958: </div>
1.148     asau     5959: <div class="sect1">
1.75      rillig   5960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5961: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   5962: <p>Packages that install system shells should register them in the shell
1.76      rillig   5963: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   5964: administrator.  This must be done from the installation scripts to keep
                   5965: binary packages working on any system.  pkginstall provides an easy way to
                   5966: accomplish this task.</p>
                   5967: <p>When a package provides a shell interpreter, it has to set the
                   5968: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   5969: add some hooks to the installation scripts to handle it.  Consider the
1.189     snj      5970: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75      rillig   5971: <pre class="programlisting">
1.100     rillig   5972: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    5973: </pre>
1.148     asau     5974: <div class="sect2">
1.75      rillig   5975: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5976: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   5977: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   5978: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   5979: environment variable to <code class="literal">NO</code>.</p>
                   5980: </div>
                   5981: </div>
1.148     asau     5982: <div class="sect1">
1.75      rillig   5983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5984: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   5985: <p>Packages that install X11 fonts should update the database files
                   5986: that index the fonts within each fonts directory.  This can easily be
                   5987: accomplished within the pkginstall framework.</p>
                   5988: <p>When a package installs X11 fonts, it must list the directories in
                   5989: which fonts are installed in the
                   5990: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128     wiz      5991: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   5992: <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.  This will add hooks to the
1.75      rillig   5993: installation scripts to run the appropriate commands to update the fonts
                   5994: database files within each of those directories.  For convenience, if the
                   5995: directory path is relative, it is taken to be relative to the package's
1.189     snj      5996: installation prefix.  Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   5997: <pre class="programlisting">
1.175     wiz      5998: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       grant    5999: </pre>
1.148     asau     6000: <div class="sect2">
1.75      rillig   6001: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6002: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6003: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6004: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6005: environment variable to <code class="literal">NO</code>.</p>
                   6006: </div>
                   6007: </div>
                   6008: </div>
1.148     asau     6009: <div class="chapter">
1.75      rillig   6010: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6011: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   6012: <div class="toc">
                   6013: <p><b>Table of Contents</b></p>
1.210     leot     6014: <dl class="toc">
1.106     rillig   6015: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      6016: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106     rillig   6017: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   6018: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   6019: </dl>
                   6020: </div>
                   6021: <p>Many packages have the ability to be built to support different
1.76      rillig   6022: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6023: in pkgsrc that provides generic handling of those options that
                   6024: determine different ways in which the packages can be built.  It's
                   6025: possible for the user to specify exactly which sets of options will be
                   6026: built into a package or to allow a set of global default options
                   6027: apply.</p>
1.107     rillig   6028: <p>There are two broad classes of behaviors that one might want to
                   6029: control via options.  One is whether some particular feature is
                   6030: enabled in a program that will be built anyway, often by including or
                   6031: not including a dependency on some other package.  The other is
                   6032: whether or not an additional program will be built as part of the
                   6033: package.  Generally, it is better to make a split package for such
                   6034: additional programs instead of using options, because it enables
                   6035: binary packages to be built which can then be added separately.  For
                   6036: example, the foo package might have minimal dependencies (those
                   6037: packages without which foo doesn't make sense), and then the foo-gfoo
                   6038: package might include the GTK frontend program gfoo.  This is better
                   6039: than including a gtk option to foo that adds gfoo, because either that
                   6040: option is default, in which case binary users can't get foo without
                   6041: gfoo, or not default, in which case they can't get gfoo.  With split
                   6042: packages, they can install foo without having GTK, and later decide to
                   6043: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6044: source users too, avoiding the need for rebuilds.</p>
                   6045: <p>Plugins with widely varying dependencies should usually be split
                   6046: instead of options.</p>
                   6047: <p>It is often more work to maintain split packages, especially if
                   6048: the upstream package does not support this.  The decision of split
                   6049: vs. option should be made based on the likelihood that users will want
                   6050: or object to the various pieces, the size of the dependencies that are
                   6051: included, and the amount of work.</p>
                   6052: <p>A further consideration is licensing.  Non-free parts, or parts
                   6053: that depend on non-free dependencies (especially plugins) should
                   6054: almost always be split if feasible.</p>
1.148     asau     6055: <div class="sect1">
1.75      rillig   6056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6057: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   6058: <p>Global default options are listed in
                   6059: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6060: that should be built into every package if that option is supported.
1.110     hubertf  6061: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   6062: </div>
1.148     asau     6063: <div class="sect1">
1.75      rillig   6064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6065: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   6066: </h2></div></div></div>
1.75      rillig   6067: <p>The following example shows how
1.76      rillig   6068: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6069: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6070: <code class="filename">Makefile</code>, or in a file,
                   6071: e.g. <code class="filename">options.mk</code>, that is included by the
                   6072: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6073: <pre class="programlisting">
1.100     rillig   6074: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6075: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6076: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6077: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6078: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6079: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6080: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6081: 
                   6082: .include "../../mk/bsd.prefs.mk"
                   6083: 
                   6084: # this package was previously named wibble2
                   6085: .if defined(PKG_OPTIONS.wibble2)
                   6086: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6087: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6088:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6089: .endif
                   6090: 
                   6091: .include "../../mk/bsd.options.mk"
                   6092: 
                   6093: # Package-specific option-handling
                   6094: 
                   6095: ###
                   6096: ### FOO support
                   6097: ###
                   6098: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6099: CONFIGURE_ARGS+=    --enable-foo
                   6100: .endif
                   6101: 
                   6102: ###
                   6103: ### LDAP support
                   6104: ###
                   6105: .if !empty(PKG_OPTIONS:Mldap)
                   6106: .  include "../../databases/openldap-client/buildlink3.mk"
                   6107: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6108: .endif
                   6109: 
                   6110: ###
                   6111: ### database support
                   6112: ###
                   6113: .if !empty(PKG_OPTIONS:Mmysql)
                   6114: .  include "../../mk/mysql.buildlink3.mk"
                   6115: .endif
                   6116: .if !empty(PKG_OPTIONS:Mpgsql)
                   6117: .  include "../../mk/pgsql.buildlink3.mk"
                   6118: .endif
1.75      rillig   6119: </pre>
                   6120: <p>The first section contains the information about which build
                   6121: options are supported by the package, and any default options settings
                   6122: if needed.</p>
1.128     wiz      6123: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6124: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.189     snj      6125: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75      rillig   6126: options.  It should be set to
1.78      rillig   6127: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6128: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6129: at the point where the options are processed.</p></li>
1.128     wiz      6130: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75      rillig   6131: build options supported by the package.</p></li>
1.128     wiz      6132: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75      rillig   6133: list of names of groups of mutually exclusive options.  The options in
                   6134: each group are listed in
                   6135: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6136: The most specific setting of any option from the group takes
                   6137: precedence over all other options in the group.  Options from the
                   6138: groups will be automatically added to
                   6139: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128     wiz      6140: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75      rillig   6141: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6142: packages will fail if no option from the group is
                   6143: selected.</p></li>
1.128     wiz      6144: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75      rillig   6145: of names of sets of options.  At least one option from each set must
                   6146: be selected.  The options in each set are listed in
                   6147: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6148: Options from the sets will be automatically added to
                   6149: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6150: fail if no option from the set is selected.</p></li>
1.128     wiz      6151: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75      rillig   6152: build options which are enabled by default.</p></li>
1.128     wiz      6153: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75      rillig   6154: of
1.128     wiz      6155: <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;</span>
1.110     hubertf  6156: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   6157: their option counterparts.  Pairs should be added with
1.128     wiz      6158: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.75      rillig   6159: warning will be issued if the user uses a legacy
                   6160: variable.</p></li>
1.128     wiz      6161: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75      rillig   6162: of
1.128     wiz      6163: <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;</span>
1.75      rillig   6164: pairs that map options that have been renamed to their new
1.128     wiz      6165: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.75      rillig   6166: the listing of global legacy options.  A warning will be issued if
                   6167: the user uses a legacy option.</p></li>
1.128     wiz      6168: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75      rillig   6169: options implied by deprecated variables used.  This can be used for
                   6170: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6171: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6172: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128     wiz      6173: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75      rillig   6174: a list of warnings about deprecated variables or options used, and
                   6175: what to use instead.</p></li>
                   6176: </ol></div>
                   6177: <p>A package should never modify
                   6178: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6179: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6180: To suggest a default set of options, use
                   6181: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6182: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6183: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6184: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6185: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6186: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6187: happen with platform-specific options if none of them is supported on
                   6188: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6189: empty list and the package is otherwise treated as not using the
                   6190: options framework.</p>
1.76      rillig   6191: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6192: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6193: build options, properly filtered to remove unsupported and duplicate
                   6194: options.</p>
                   6195: <p>The remaining sections contain the logic that is specific to
                   6196: each option.  The correct way to check for an option is to check
                   6197: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6198: <pre class="programlisting">
1.100     rillig   6199: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   6200: </pre>
                   6201: </div>
1.148     asau     6202: <div class="sect1">
1.75      rillig   6203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6204: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   6205: <p>Options that enable similar features in different packages (like
                   6206: optional support for a library) should use a common name in all
                   6207: packages that support it (like the name of the library).  If another
                   6208: package already has an option with the same meaning, use the same
                   6209: name.</p>
                   6210: <p>Options that enable features specific to one package, where it's
                   6211: unlikely that another (unrelated) package has the same (or a similar)
                   6212: optional feature, should use a name prefixed with
                   6213: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6214: <p>If a group of related packages share an optional feature
                   6215: specific to that group, prefix it with the name of the
1.128     wiz      6216: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.75      rillig   6217: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6218: <p>For new options, add a line to
1.76      rillig   6219: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6220: fields, separated by tab.  The first field is the option name, the
                   6221: second its description.  The description should be a whole sentence
                   6222: (starting with an uppercase letter and ending with a period) that
1.128     wiz      6223: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   6224: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.75      rillig   6225: </div>
1.148     asau     6226: <div class="sect1">
1.107     rillig   6227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6228: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  6229: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107     rillig   6230: different dependencies based on the options with which the package was
                   6231: built. For querying these options, the file
                   6232: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6233: typical example looks like this:</p>
                   6234: <pre class="programlisting">
                   6235: pkgbase := libpurple
                   6236: .include "../../mk/pkg-build-options.mk"
                   6237: 
                   6238: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6239: ...
                   6240: .endif
                   6241: </pre>
                   6242: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6243: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6244: options of the libpurple package, which can then be queried like
                   6245: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6246: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6247: details.</p>
                   6248: </div>
1.75      rillig   6249: </div>
1.148     asau     6250: <div class="chapter">
1.75      rillig   6251: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6252: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   6253: <div class="toc">
                   6254: <p><b>Table of Contents</b></p>
1.210     leot     6255: <dl class="toc">
1.106     rillig   6256: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6257: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6258: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6259: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      6260: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   6261: <dd><dl>
                   6262: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6263: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6264: </dl></dd>
1.128     wiz      6265: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6266: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6267: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6268: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6269: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6270: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6271: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6272: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6273: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6274: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig   6275: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6276: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   6277: </dl>
                   6278: </div>
1.148     asau     6279: <div class="sect1">
1.75      rillig   6280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6281: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   6282: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6283:     built. Building a package is separated into different
                   6284:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6285:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120     snj      6286:     described in the following sections. Each phase is split into
1.87      wiz      6287:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6288:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6289:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6290:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6291:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   6292: <p>Never override the regular targets (like
                   6293:     <code class="varname">fetch</code>), if you have to, override the
                   6294:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6295: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6296:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6297:     the local system and then extracted. After any pkgsrc-specific patches
                   6298:     to compile properly are applied, the software can be configured, then
                   6299:     built (usually by compiling), and finally the generated binaries, etc.
                   6300:     can be put into place on the system.</p>
1.97      rillig   6301: <p>To get more details about what is happening at each step,
                   6302:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6303:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6304:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6305: </div>
1.148     asau     6306: <div class="sect1">
1.75      rillig   6307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6308: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   6309: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6310:     the next section, here's a brief discussion on where programs are
                   6311:     installed, and which variables influence this.</p>
1.75      rillig   6312: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6313:     where all files of the final program shall be installed. It is
                   6314:     usually set to <code class="varname">LOCALBASE</code>
                   6315:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6316:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6317:     <code class="varname">PREFIX</code> needs to be put
                   6318:     into the various places in the program's source where paths to
1.110     hubertf  6319:     these files are encoded.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.75      rillig   6320: <p>When choosing which of these variables to use,
1.87      wiz      6321:     follow the following rules:</p>
1.148     asau     6322: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6323: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88      wiz      6324:        where the current pkg will be installed.  When referring to a
                   6325:        pkg's own installation path, use
1.128     wiz      6326:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   6327: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88      wiz      6328:        are installed.  If you need to construct a -I or -L argument
                   6329:        to the compiler to find includes and libraries installed by
1.128     wiz      6330:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.87      wiz      6331:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6332:        installed all packages in <code class="filename">/usr/local</code>. As
                   6333:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6334:        administrator, this variable is a misnomer.</p></li>
1.128     wiz      6335: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88      wiz      6336:        distribution (from xsrc, etc.) is installed. When looking for
                   6337:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128     wiz      6338:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
1.209     sevan    6339: <li class="listitem"><p>X11-based packages using imake must set
                   6340:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   6341:        <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      6342: <li class="listitem">
1.209     sevan    6343: <p>To determine the prefix of an
1.88      wiz      6344:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6345:        definition can be used. It takes pairs in the format
1.189     snj      6346:        <span class="quote">&#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;</span>, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      6347:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6348:        of the installed package &lt;package&gt;, or
1.209     sevan    6349:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> if the package is not
1.88      wiz      6350:        installed.</p>
1.75      rillig   6351: <p>This is best illustrated by example.</p>
                   6352: <p>The following lines are taken from
1.87      wiz      6353:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6354: <pre class="programlisting">
1.100     rillig   6355: EVAL_PREFIX+=           GTKDIR=gtk+
                   6356: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6357: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6358: CONFIGURE_ARGS+=        --enable-multibyte
                   6359: </pre>
1.88      wiz      6360: <p>Specific defaults can be defined for the packages
                   6361:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6362:        definition of the form:</p>
1.75      rillig   6363: <pre class="programlisting">
1.100     rillig   6364: GTKDIR_DEFAULT= ${LOCALBASE}
                   6365: </pre>
1.75      rillig   6366: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6367:        to the first definition in
                   6368:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6369: </li>
1.128     wiz      6370: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.189     snj      6371:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87      wiz      6372:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6373:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6374: </ul></div>
                   6375: </div>
1.148     asau     6376: <div class="sect1">
1.75      rillig   6377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6378: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 6379: <p>When building a package, various directories are used to store
1.87      wiz      6380:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6381:     directories are explained here.</p>
1.75      rillig   6382: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6383:     are two common base directories for these relative directories:
                   6384:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6385:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6386:     inside the package itself.</p>
1.148     asau     6387: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6388: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6389: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6390:       root directory. Generally, you don't need
                   6391:       it.</p></dd>
1.97      rillig   6392: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6393: <dd><p>This is an absolute pathname that points to the
                   6394:       current package.</p></dd>
1.75      rillig   6395: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6396: <dd><p>This is a pathname relative to
1.87      wiz      6397:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6398:       package.</p></dd>
1.75      rillig   6399: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6400: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6401:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6402:       directory. It also contains temporary directories and log files used by
                   6403:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6404:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6405: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6406: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6407:       where the distfiles are extracted. It is usually a direct subdirectory
                   6408:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6409:       that isn't hidden. This variable may be changed by a package
                   6410:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6411: </dl></div>
1.114     jmcneill 6412: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6413:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   6414:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 6415:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6416:     If users would like to have their pkgsrc trees behave in a
                   6417:     read-only manner, then the value of
                   6418:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6419:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   6420: </div>
1.148     asau     6421: <div class="sect1">
1.75      rillig   6422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6423: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  6424: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      6425:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6426:     phase. This will automatically run all phases that are required for this
                   6427:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  6428:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      6429:     the package will be built, but not installed.</p>
1.75      rillig   6430: </div>
1.148     asau     6431: <div class="sect1">
1.75      rillig   6432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6433: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6434: <p>The first step in building a package is to fetch the
1.88      wiz      6435:     distribution files (distfiles) from the sites that are providing
                   6436:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6437:     phase.</p>
1.148     asau     6438: <div class="sect2">
1.81      rillig   6439: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6440: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88      wiz      6441: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6442:       defines all URLs from where the distfile, whose name is
                   6443:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6444:       fetched. The more complicated cases are described
                   6445:       below.</p>
                   6446: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6447:       the list of distfiles that have to be fetched. Its value
1.174     asau     6448:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   6449:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88      wiz      6450:       so that most packages don't need to define it at all.
                   6451:       <code class="varname">EXTRACT_SUFX</code> is
                   6452:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6453:       freely. Note that if your package requires additional
                   6454:       distfiles to the default one, you cannot just append the
                   6455:       additional filenames using the <code class="literal">+=</code>
                   6456:       operator, but you have write for example:</p>
1.81      rillig   6457: <pre class="programlisting">
1.174     asau     6458: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100     rillig   6459: </pre>
1.88      wiz      6460: <p>Each distfile is fetched from a list of sites, usually
                   6461:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6462:       <code class="varname">DISTFILES</code> or multiple
                   6463:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6464:       set
                   6465:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6466:       to the list of URLs where the file
                   6467:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6468:       (including the suffix) can be found.</p>
                   6469: <pre class="programlisting">
1.100     rillig   6470: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6471: DISTFILES+=     foo-file.tar.gz
                   6472: SITES.foo-file.tar.gz= \
                   6473: http://www.somewhere.com/somehow/ \
                   6474: http://www.somewhereelse.com/mirror/somehow/
                   6475: </pre>
1.81      rillig   6476: <p>When actually fetching the distfiles, each item from
1.88      wiz      6477:       <code class="varname">MASTER_SITES</code> or
                   6478:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6479:       appended to it, without an intermediate slash. Therefore,
                   6480:       all site values have to end with a slash or other separator
                   6481:       character. This allows for example to set
                   6482:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6483:       that gets the name of the distfile as a parameter. In this
                   6484:       case, the definition would look like:</p>
1.81      rillig   6485: <pre class="programlisting">
1.100     rillig   6486: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6487: </pre>
1.125     wiz      6488: <p> The exception to this rule are URLs starting with a dash.
1.174     asau     6489:       In that case the URL is taken as is, fetched and the result
                   6490:       stored under the name of the distfile. You can use this style
                   6491:       for the case when the download URL style does not match the
                   6492:       above common case. For example, if permanent download URL is a
                   6493:       redirector to the real download URL, or the download file name
                   6494:       is offered by an HTTP Content-Disposition header. In the
                   6495:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   6496:       created instead of the default
                   6497:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   6498: <pre class="programlisting">
                   6499: DISTNAME=       foo-1.0.0
                   6500: MASTER_SITES=   -http://www.example.com/archive/v1.0.0.tar.gz
                   6501: </pre>
1.81      rillig   6502: <p>There are some predefined values for
1.88      wiz      6503:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6504:       packages.  The names of the variables should speak for
                   6505:       themselves.</p>
                   6506: <pre class="programlisting">
1.100     rillig   6507: ${MASTER_SITE_APACHE}
                   6508: ${MASTER_SITE_BACKUP}
                   6509: ${MASTER_SITE_CYGWIN}
                   6510: ${MASTER_SITE_DEBIAN}
                   6511: ${MASTER_SITE_FREEBSD}
                   6512: ${MASTER_SITE_FREEBSD_LOCAL}
                   6513: ${MASTER_SITE_GENTOO}
                   6514: ${MASTER_SITE_GNOME}
                   6515: ${MASTER_SITE_GNU}
                   6516: ${MASTER_SITE_GNUSTEP}
1.174     asau     6517: ${MASTER_SITE_HASKELL_HACKAGE}
1.100     rillig   6518: ${MASTER_SITE_IFARCHIVE}
                   6519: ${MASTER_SITE_KDE}
                   6520: ${MASTER_SITE_MOZILLA}
1.174     asau     6521: ${MASTER_SITE_MOZILLA_ALL}
                   6522: ${MASTER_SITE_MOZILLA_ESR}
1.100     rillig   6523: ${MASTER_SITE_MYSQL}
1.174     asau     6524: ${MASTER_SITE_NETLIB}
1.100     rillig   6525: ${MASTER_SITE_OPENOFFICE}
1.208     ryoon    6526: ${MASTER_SITE_OSDN}
1.100     rillig   6527: ${MASTER_SITE_PERL_CPAN}
                   6528: ${MASTER_SITE_PGSQL}
1.174     asau     6529: ${MASTER_SITE_RUBYGEMS}
1.100     rillig   6530: ${MASTER_SITE_R_CRAN}
                   6531: ${MASTER_SITE_SOURCEFORGE}
                   6532: ${MASTER_SITE_SUNSITE}
                   6533: ${MASTER_SITE_SUSE}
                   6534: ${MASTER_SITE_TEX_CTAN}
                   6535: ${MASTER_SITE_XCONTRIB}
                   6536: ${MASTER_SITE_XEMACS}
1.174     asau     6537: ${MASTER_SITE_XORG}
1.100     rillig   6538: </pre>
1.88      wiz      6539: <p>Some explanations for the less self-explaining ones:
                   6540:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133     wiz      6541:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.132     spz      6542:       package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.88      wiz      6543: <p>If you choose one of these predefined sites, you may
                   6544:       want to specify a subdirectory of that site. Since these
                   6545:       macros may expand to more than one actual site, you
                   6546:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6547:       specify a subdirectory:</p>
1.81      rillig   6548: <pre class="programlisting">
1.100     rillig   6549: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6550: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6551: </pre>
1.81      rillig   6552: <p>Note the trailing slash after the subdirectory
1.88      wiz      6553:       name.</p>
1.81      rillig   6554: </div>
1.148     asau     6555: <div class="sect2">
1.81      rillig   6556: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6557: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6558: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6559:       all the distfiles exist in a local directory
1.93      rillig   6560:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6561:       user). If the files do not exist, they are fetched using
                   6562:       commands of the form</p>
1.75      rillig   6563: <pre class="programlisting">
1.100     rillig   6564: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6565: </pre>
1.88      wiz      6566: <p>where <code class="literal">${site}</code> varies through
                   6567:       several possibilities in turn: first,
                   6568:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6569:       sites specified in either <code class="varname">SITES.file</code> if
                   6570:       defined, else <code class="varname">MASTER_SITES</code> or
                   6571:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6572:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6573:       all except the first and the last can be optionally sorted
                   6574:       by the user, via setting either
                   6575:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6576:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6577:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  6578: <p> The specific command and arguments used depend on the
                   6579:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6580:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   6581: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6582:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6583:       distfiles, if they are freely distributable.  Packages setting
                   6584:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128     wiz      6585:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.97      rillig   6586:       mirrored.</p>
1.81      rillig   6587: </div>
1.75      rillig   6588: </div>
1.148     asau     6589: <div class="sect1">
1.75      rillig   6590: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6591: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6592: <p>After the distfile(s) are fetched, their checksum is
                   6593:     generated and compared with the checksums stored in the
                   6594:     distinfo file. If the checksums don't match, the build is
                   6595:     aborted. This is to ensure the same distfile is used for
                   6596:     building, and that the distfile wasn't changed, e.g. by some
                   6597:     malign force, deliberately changed distfiles on the master
                   6598:     distribution site or network lossage.</p>
1.75      rillig   6599: </div>
1.148     asau     6600: <div class="sect1">
1.75      rillig   6601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6602: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6603: <p>When the distfiles are present on the local system, they
1.88      wiz      6604:     need to be extracted, as they usually come in the form of some
                   6605:     compressed archive format.</p>
1.75      rillig   6606: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6607:     extracted. If you only need some of them, you can set the
                   6608:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6609:     files.</p>
                   6610: <p>Extracting the files is usually done by a little
1.93      rillig   6611:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6612:     already knows how to extract various archive formats, so most
                   6613:     likely you will not need to change anything here. But if you
                   6614:     need, the following variables may help you:</p>
1.148     asau     6615: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6616: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6617: <dd><p>Use these variables to override the default
1.88      wiz      6618:       options for an extract command, which are defined in
1.93      rillig   6619:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6620: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6621: <dd><p>This variable can be set to
1.114     jmcneill 6622:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6623:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      6624:       absolute pathname pointing to the command with which tar
1.114     jmcneill 6625:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6626:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   6627: </dl></div>
1.88      wiz      6628: <p>If the <code class="filename">extract</code> program doesn't
                   6629:     serve your needs, you can also override the
                   6630:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6631:     command used for extracting the files. This command is
                   6632:     executed in the <code class="filename">${WRKSRC}</code>
                   6633:     directory. During execution of this command, the shell
                   6634:     variable <code class="varname">extract_file</code> holds the absolute
                   6635:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6636: <p>And if that still does not suffice, you can override the
1.88      wiz      6637:     <code class="varname">do-extract</code> target in the package
                   6638:     Makefile.</p>
1.75      rillig   6639: </div>
1.148     asau     6640: <div class="sect1">
1.75      rillig   6641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6642: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6643: <p>After extraction, all the patches named by the
1.88      wiz      6644:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6645:     subdirectory of the package as well as in
                   6646:     $LOCALPATCHES/$PKGPATH (e.g.
                   6647:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6648:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6649:     <code class="filename">.gz</code> are uncompressed before they are
                   6650:     applied, files ending in <code class="filename">.orig</code> or
                   6651:     <code class="filename">.rej</code> are ignored. Any special options to
1.189     snj      6652:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.110     hubertf  6653:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more details.</p>
1.189     snj      6654: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88      wiz      6655:     it fail if the patches apply with some lines of fuzz. Please
                   6656:     fix (regen) the patches so that they apply cleanly. The
                   6657:     rationale behind this is that patches that don't apply cleanly
                   6658:     may end up being applied in the wrong place, and cause severe
                   6659:     harm there.</p>
1.75      rillig   6660: </div>
1.148     asau     6661: <div class="sect1">
1.75      rillig   6662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6663: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  6664: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.88      wiz      6665:     </p>
1.75      rillig   6666: </div>
1.148     asau     6667: <div class="sect1">
1.75      rillig   6668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6669: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6670: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6671:     linkers. The following variables can be used to tweak the
                   6672:     wrappers.</p>
1.148     asau     6673: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6674: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6675: <dd><p>The command used to print progress
1.88      wiz      6676:       messages. Does nothing by default. Set to
                   6677:       <code class="literal">${ECHO}</code> to see the progress
                   6678:       messages.</p></dd>
1.75      rillig   6679: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6680: <dd><p>This variable can be set to
1.88      wiz      6681:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6682:       depending on whether you want additional information in the
                   6683:       wrapper log file.</p></dd>
1.75      rillig   6684: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6685: <dd><p>This variable can be set to
1.88      wiz      6686:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6687:       on whether the wrapper should use its cache, which will
                   6688:       improve the speed. The default value is
                   6689:       <code class="literal">yes</code>, but is forced to
                   6690:       <code class="literal">no</code> if the platform does not support
                   6691:       it.</p></dd>
1.75      rillig   6692: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6693: <dd><p>A list of reordering commands. A reordering
                   6694:       command has the form
                   6695:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6696:       It ensures that that
                   6697:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6698:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6699:       </p></dd>
1.75      rillig   6700: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6701: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6702:       investigate further]</p></dd>
1.75      rillig   6703: </dl></div>
                   6704: </div>
1.148     asau     6705: <div class="sect1">
1.75      rillig   6706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6707: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6708: <p>Most pieces of software need information on the header
                   6709:     files, system calls, and library routines which are available
                   6710:     on the platform they run on. The process of determining this
                   6711:     information is known as configuration, and is usually
                   6712:     automated. In most cases, a script is supplied with the
                   6713:     distfiles, and its invocation results in generation of header
                   6714:     files, Makefiles, etc.</p>
                   6715: <p>If the package contains a configure script, this can be
                   6716:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128     wiz      6717:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.88      wiz      6718:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128     wiz      6719:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.88      wiz      6720:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6721: <pre class="programlisting">
1.100     rillig   6722: .for d in ${CONFIGURE_DIRS}
                   6723:         cd ${WRKSRC} \
                   6724:         &amp;&amp; cd ${d} \
                   6725:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6726: .endfor
                   6727: </pre>
1.88      wiz      6728: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128     wiz      6729:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6730:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6731:     configure script is run with the environment
                   6732:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6733:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6734:     <code class="varname">CONFIGURE_ENV</code>,
                   6735:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128     wiz      6736:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.88      wiz      6737:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6738:     package.</p>
1.144     wiz      6739: <p>If the program uses the Perl way of configuration (mainly Perl
                   6740:     modules, but not only), i.e. a file called
                   6741:     <code class="filename">Makefile.PL</code>, it should include
                   6742:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6743:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6744:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88      wiz      6745: <p>If the program uses an <code class="filename">Imakefile</code>
                   6746:     for configuration, the appropriate steps can be invoked by
                   6747:     setting <code class="varname">USE_IMAKE</code> to
1.209     sevan    6748:     <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>.
                   6749:     You can add variables to xmkmf's environment by adding them to the
1.97      rillig   6750:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   6751: <p>If the program uses <code class="filename">cmake</code>
                   6752:     for configuration, the appropriate steps can be invoked by
1.128     wiz      6753:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.111     rillig   6754:     You can add variables to cmake's environment by adding them to the
                   6755:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6756:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6757:     The top directory argument is given by the
                   6758:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128     wiz      6759:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   6760: <p>If there is no configure step at all, set
1.128     wiz      6761:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6762: </div>
1.148     asau     6763: <div class="sect1">
1.75      rillig   6764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6765: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6766: <p>For building a package, a rough equivalent of the
                   6767:     following code is executed.</p>
1.75      rillig   6768: <pre class="programlisting">
1.100     rillig   6769: .for d in ${BUILD_DIRS}
                   6770:         cd ${WRKSRC} \
                   6771:         &amp;&amp; cd ${d} \
                   6772:         &amp;&amp; env ${MAKE_ENV} \
                   6773:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6774:                 -f ${MAKE_FILE} \
                   6775:                 ${BUILD_TARGET}
                   6776: .endfor
                   6777: </pre>
1.88      wiz      6778: <p><code class="varname">BUILD_DIRS</code> (default:
1.128     wiz      6779:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6780:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6781:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6782:     <code class="varname">MAKE_ENV</code> and arguments
                   6783:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6784:     <code class="varname">MAKE_ENV</code>,
                   6785:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6786:     <code class="varname">MAKE_FILE</code> and
                   6787:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6788:     package.</p>
1.75      rillig   6789: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128     wiz      6790:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6791:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
1.88      wiz      6792:     default value of <code class="varname">MAKE_FILE</code> is
1.128     wiz      6793:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6794:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.97      rillig   6795: <p>If there is no build step at all, set
1.128     wiz      6796:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6797: </div>
1.148     asau     6798: <div class="sect1">
1.75      rillig   6799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6800: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6801: <p>[TODO]</p>
                   6802: </div>
1.148     asau     6803: <div class="sect1">
1.75      rillig   6804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6805: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6806: <p>Once the build stage has completed, the final step is to
1.88      wiz      6807:     install the software in public directories, so users can
                   6808:     access the programs and files.</p>
1.75      rillig   6809: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6810:     equivalent of the following code is executed. Additionally,
                   6811:     before and after this code, much magic is performed to do
                   6812:     consistency checks, registering the package, and so on.</p>
                   6813: <pre class="programlisting">
1.100     rillig   6814: .for d in ${INSTALL_DIRS}
                   6815:         cd ${WRKSRC} \
                   6816:         &amp;&amp; cd ${d} \
                   6817:         &amp;&amp; env ${MAKE_ENV} \
                   6818:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6819:                 -f ${MAKE_FILE} \
                   6820:                 ${INSTALL_TARGET}
                   6821: .endfor
                   6822: </pre>
1.75      rillig   6823: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6824:     <span class="emphasis"><em>build</em></span> phase.
                   6825:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6826:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128     wiz      6827:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   6828:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.88      wiz      6829:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6830:     defined.</p>
1.75      rillig   6831: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6832:     variables are useful. They are all variations of the
1.189     snj      6833:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88      wiz      6834:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6835:     install command. The specialized variants, together with their
                   6836:     intended use, are:</p>
1.148     asau     6837: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6838: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6839: <dd><p>directories that contain
                   6840:       binaries</p></dd>
1.75      rillig   6841: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6842: <dd><p>directories that contain
                   6843:       scripts</p></dd>
1.75      rillig   6844: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6845: <dd><p>directories that contain shared and static
                   6846:       libraries</p></dd>
1.75      rillig   6847: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6848: <dd><p>directories that contain data
                   6849:       files</p></dd>
1.75      rillig   6850: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6851: <dd><p>directories that contain man
                   6852:       pages</p></dd>
1.210     leot     6853: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   6854: <dd><p>directories that contain data files for games
                   6855:       </p></dd>
1.75      rillig   6856: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      6857: <dd><p>binaries that can be stripped from debugging
                   6858:       symbols</p></dd>
1.75      rillig   6859: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      6860: <dd><p>binaries that cannot be
                   6861:       stripped</p></dd>
1.75      rillig   6862: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      6863: <dd><p>game
                   6864:       binaries</p></dd>
1.75      rillig   6865: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      6866: <dd><p>shared and static
                   6867:       libraries</p></dd>
1.75      rillig   6868: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6869: <dd><p>data files</p></dd>
                   6870: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      6871: <dd><p>data files for
                   6872:       games</p></dd>
1.75      rillig   6873: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6874: <dd><p>man pages</p></dd>
                   6875: </dl></div>
                   6876: <p>Some other variables are:</p>
1.148     asau     6877: <div class="variablelist"><dl class="variablelist">
1.216     tnn      6878: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
                   6879: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?strip+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
                   6880:       when installing binaries. Any debugging sections and symbols present in
                   6881:       binaries will be preserved.
                   6882:       </p></dd>
1.75      rillig   6883: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6884: <dd><p>A list of directories relative to
1.88      wiz      6885:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      6886:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6887:       The package is supposed to create all needed directories itself
                   6888:       before installing files to it and list all other directories here.
                   6889:       </p></dd>
1.75      rillig   6890: </dl></div>
1.97      rillig   6891: <p>In the rare cases that a package shouldn't install anything,
1.128     wiz      6892:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.97      rillig   6893:     mostly relevant for packages in the <code class="filename">regress</code>
                   6894:     category.</p>
1.75      rillig   6895: </div>
1.148     asau     6896: <div class="sect1">
1.75      rillig   6897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6898: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      6899: <p>Once the install stage has completed, a binary package of
                   6900:     the installed files can be built.  These binary packages can be
                   6901:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  6902:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   6903:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      6904: <p>By default, the binary packages are created in
                   6905:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6906:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6907:     one for each category in the <code class="varname">CATEGORIES</code>
                   6908:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6909:     <code class="filename">pkgsrc/packages</code>.</p>
                   6910: </div>
1.148     asau     6911: <div class="sect1">
1.88      wiz      6912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6913: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      6914: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  6915:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      6916:     to clean the work directories of all dependencies too, use
1.110     hubertf  6917:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   6918: </div>
1.148     asau     6919: <div class="sect1">
1.75      rillig   6920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6921: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148     asau     6922: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6923: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      6924: <dd><p>For any of the main targets described in the
                   6925:          previous section, two auxiliary targets exist with
1.128     wiz      6926:          <span class="quote">&#8220;<span class="quote">pre-</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">post-</span>&#8221;</span> used as a
1.87      wiz      6927:          prefix for the main target's name.  These targets are
1.88      wiz      6928:          invoked before and after the main target is called,
                   6929:          allowing extra configuration or installation steps be
                   6930:          performed from a package's Makefile, for example, which
                   6931:          a program's configure script or install target
                   6932:          omitted.</p></dd>
1.75      rillig   6933: <dt><span class="term">do-*</span></dt>
1.88      wiz      6934: <dd><p>Should one of the main targets do the wrong thing,
                   6935:          and should there be no variable to fix this, you can
                   6936:          redefine it with the do-* target.  (Note that redefining
                   6937:          the target itself instead of the do-* target is a bad
                   6938:          idea, as the pre-* and post-* targets won't be called
                   6939:          anymore, etc.) You will not usually need to do
                   6940:          this.</p></dd>
1.75      rillig   6941: <dt><span class="term">reinstall</span></dt>
1.88      wiz      6942: <dd>
1.110     hubertf  6943: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      6944:          you noticed some file was not installed properly, you
                   6945:          can repeat the installation with this target, which will
1.128     wiz      6946:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.88      wiz      6947: <p>This is the default value of
                   6948:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  6949:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      6950:          package</strong></span>, where the defaults are
1.128     wiz      6951:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
1.88      wiz      6952:          respectively.</p>
                   6953: </dd>
1.75      rillig   6954: <dt><span class="term">deinstall</span></dt>
                   6955: <dd>
1.189     snj      6956: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88      wiz      6957:          current directory, effectively de-installing the
                   6958:          package. The following variables can be used to tune the
                   6959:          behaviour:</p>
1.148     asau     6960: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6961: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.189     snj      6962: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75      rillig   6963: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      6964: <dd><p>Remove all packages that require (depend on)
                   6965:                the given package.  This can be used to remove any
                   6966:                packages that may have been pulled in by a given
1.110     hubertf  6967:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      6968:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      6969:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   6970:                likely to remove whole KDE. Works by adding
1.189     snj      6971:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88      wiz      6972:                command line.</p></dd>
1.75      rillig   6973: </dl></div>
                   6974: </dd>
1.88      wiz      6975: <dt><span class="term">bin-install</span></dt>
                   6976: <dd><p>Install a binary package from local disk and via FTP
                   6977:          from a list of sites (see the
                   6978:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  6979:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      6980:          available anywhere.  The arguments given to
1.110     hubertf  6981:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      6982:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   6983:          operation, etc.</p></dd>
1.205     wiz      6984: <dt><span class="term">install-clean</span></dt>
                   6985: <dd><p>This target removes the state files for the "install" and later
                   6986:          phases so that the "install" target may be re-invoked. This can be
                   6987:          used after editing the PLIST to install the package without
                   6988:          rebuilding it.</p></dd>
                   6989: <dt><span class="term">build-clean</span></dt>
                   6990: <dd><p>This target removes the state files for the "build" and later
                   6991:          phases so that the "build" target may be re-invoked.</p></dd>
1.75      rillig   6992: <dt><span class="term">update</span></dt>
                   6993: <dd>
1.88      wiz      6994: <p>This target causes the current package to be
                   6995:          updated to the latest version.  The package and all
                   6996:          depending packages first get de-installed, then current
                   6997:          versions of the corresponding packages get compiled and
                   6998:          installed.  This is similar to manually noting which
                   6999:          packages are currently installed, then performing a
1.110     hubertf  7000:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7001:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      7002:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7003:          packages.</p>
1.128     wiz      7004: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.110     hubertf  7005:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      7006:          update</strong></span> was interrupted for some reason.
                   7007:          However, in this case, make sure you don't call
1.110     hubertf  7008:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      7009:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7010:          Otherwise, you lose the ability to automatically update
                   7011:          the current package along with the dependent packages
                   7012:          you have installed.</p>
1.110     hubertf  7013: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      7014:          update</strong></span> will only work as long as the package
                   7015:          tree remains unchanged.  If the source code for one of
                   7016:          the packages to be updated has been changed, resuming
1.110     hubertf  7017:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      7018:          fail!</p>
                   7019: <p>The following variables can be used either on the
1.110     hubertf  7020:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7021:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      7022:          update</strong></span>:</p>
1.148     asau     7023: <div class="variablelist"><dl class="variablelist">
1.75      rillig   7024: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7025: <dd><p>Install target to recursively use for the
                   7026:                updated package and the dependent packages.
                   7027:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128     wiz      7028:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.110     hubertf  7029:                <span class="command"><strong>make update</strong></span>.  Other good
1.128     wiz      7030:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   7031:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   7032:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.88      wiz      7033:                endless loop!</p></dd>
1.75      rillig   7034: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7035: <dd><p>Don't clean up after updating.  Useful if
                   7036:                you want to leave the work sources of the updated
                   7037:                packages around for inspection or other purposes.
                   7038:                Be sure you eventually clean up the source tree
1.128     wiz      7039:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.88      wiz      7040:                or you may run into troubles with old source code
                   7041:                still lying around on your next
1.110     hubertf  7042:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      7043:                update</strong></span>.</p></dd>
1.75      rillig   7044: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7045: <dd><p>Deinstall each package before installing
                   7046:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7047:                may be necessary if the
1.128     wiz      7048:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.110     hubertf  7049:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      7050:                update</strong></span>.</p></dd>
1.75      rillig   7051: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7052: <dd><p>Allows you to disable recursion and hardcode
                   7053:                the target for packages.  The default is
1.128     wiz      7054:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.88      wiz      7055:                facilitating a recursive update of prerequisite
                   7056:                packages.  Only set
                   7057:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7058:                disable recursive updates. Use
                   7059:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7060:                set a specific target for each package to be
1.110     hubertf  7061:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      7062:                (see above).</p></dd>
1.75      rillig   7063: </dl></div>
                   7064: </dd>
                   7065: <dt><span class="term">clean-update</span></dt>
                   7066: <dd>
1.88      wiz      7067: <p>Clean the source tree for all packages that would
1.110     hubertf  7068:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      7069:          from the current directory.  This target should not be
                   7070:          used if the current package (or any of its depending
                   7071:          packages) have already been de-installed (e.g., after
1.110     hubertf  7072:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      7073:          some packages you intended to update. As a rule of
                   7074:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  7075:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      7076:          and only if you have a dirty package tree (e.g., if you
                   7077:          used <code class="varname">NOCLEAN</code>).</p>
                   7078: <p>If you are unsure about whether your tree is
1.110     hubertf  7079:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      7080:          clean</strong></span> at the top of the tree, or use the
                   7081:          following sequence of commands from the directory of the
                   7082:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  7083:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      7084:          time, otherwise you lose all the packages you wanted to
                   7085:          update!):</p>
1.87      wiz      7086: <pre class="screen">
                   7087: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7088: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7089: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7090:          </pre>
1.88      wiz      7091: <p>The following variables can be used either on the
1.110     hubertf  7092:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7093:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.148     asau     7094: <div class="variablelist"><dl class="variablelist">
1.75      rillig   7095: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  7096: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      7097:                reconstruct the list of directories to update for
1.110     hubertf  7098:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      7099:                update</strong></span> successfully installed all
                   7100:                packages you wanted to update.  Normally, this is
1.110     hubertf  7101:                done automatically on <span class="command"><strong>make
1.88      wiz      7102:                update</strong></span>, but may have been suppressed by
                   7103:                the <code class="varname">NOCLEAN</code> variable (see
                   7104:                above).</p></dd>
1.75      rillig   7105: </dl></div>
                   7106: </dd>
1.88      wiz      7107: <dt><span class="term">replace</span></dt>
                   7108: <dd>
                   7109: <p>Update the installation of the current package.  This
                   7110:          differs from update in that it does not replace dependent
1.189     snj      7111:          packages.  You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88      wiz      7112:          target to work.</p>
                   7113: <p><span class="emphasis"><em>Be careful when using this
                   7114:          target!</em></span> There are no guarantees that dependent
                   7115:          packages will still work, in particular they will most
1.110     hubertf  7116:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      7117:          library package whose shared library major version changed
                   7118:          between your installed version and the new one.  For this
                   7119:          reason, this target is not officially supported and only
                   7120:          recommended for advanced users.</p>
                   7121: </dd>
1.75      rillig   7122: <dt><span class="term">info</span></dt>
1.189     snj      7123: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      7124:          package. You can use this to check which version of a
                   7125:          package is installed.</p></dd>
                   7126: <dt><span class="term">index</span></dt>
                   7127: <dd>
                   7128: <p>This is a top-level command, i.e. it should be used in
                   7129:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7130:          database of all packages in the local pkgsrc tree, including
                   7131:          dependencies, comment, maintainer, and some other useful
                   7132:          information.  Individual entries are created by running
1.110     hubertf  7133:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      7134:          directories.  This index file is saved as
                   7135:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  7136:          verbose format by running <span class="command"><strong>make
1.88      wiz      7137:          print-index</strong></span>.  You can search in it with
1.110     hubertf  7138:          <span class="command"><strong>make search
1.88      wiz      7139:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7140:          extract a list of all packages that depend on a particular
1.110     hubertf  7141:          one by running <span class="command"><strong>make show-deps
1.88      wiz      7142:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7143: <p>Running this command takes a very long time, some
                   7144:          hours even on fast machines!</p>
                   7145: </dd>
1.75      rillig   7146: <dt><span class="term">readme</span></dt>
1.88      wiz      7147: <dd>
                   7148: <p>This target generates a
                   7149:          <code class="filename">README.html</code> file, which can be
1.189     snj      7150:          viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
1.88      wiz      7151:          contain references to any packages which are in the
                   7152:          <code class="varname">PACKAGES</code> directory on the local
                   7153:          host. The generated files can be made to refer to URLs
                   7154:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7155:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7156:          wanted to generate <code class="filename">README.html</code>
                   7157:          files which pointed to binary packages on the local
                   7158:          machine, in the directory
                   7159:          <code class="filename">/usr/packages</code>, set
                   7160:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7161:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7162:          <code class="varname">${PACKAGES}</code> directory and its
                   7163:          subdirectories will be searched for all the binary
                   7164:          packages.</p>
                   7165: <p>The target can be run at the toplevel or in category
                   7166:          directories, in which case it descends recursively.</p>
                   7167: </dd>
1.75      rillig   7168: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7169: <dd><p>This is a top-level command, run it in
                   7170:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7171:          file <code class="filename">README-all.html</code> which contains a
                   7172:          list of all packages currently available in the NetBSD
                   7173:          Packages Collection, together with the category they belong
                   7174:          to and a short description. This file is compiled from the
                   7175:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  7176:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      7177:          readme</strong></span>.</p></dd>
1.75      rillig   7178: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7179: <dd><p>This is very much the same as the
1.128     wiz      7180:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.88      wiz      7181:          used when generating a pkgsrc tree to be written to a
                   7182:          CD-ROM.  This target also produces
                   7183:          <code class="filename">README.html</code> files, and can be made
                   7184:          to refer to URLs based on
                   7185:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7186:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7187: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7188: <dd><p>This target shows which distfiles and patchfiles
                   7189:          are needed to build the package
                   7190:          (<code class="varname">ALLFILES</code>, which contains all
                   7191:          <code class="varname">DISTFILES</code> and
1.87      wiz      7192:          <code class="varname">PATCHFILES</code>, but not
                   7193:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7194: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7195: <dd><p>This target shows nothing if the package is not
                   7196:          installed. If a version of this package is installed,
                   7197:          but is not the version provided in this version of
                   7198:          pkgsrc, then a warning message is displayed. This target
                   7199:          can be used to show which of your installed packages are
                   7200:          downlevel, and so the old versions can be deleted, and
                   7201:          the current ones added.</p></dd>
1.75      rillig   7202: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7203: <dd><p>This target shows the directory in the pkgsrc
                   7204:          hierarchy from which the package can be built and
                   7205:          installed. This may not be the same directory as the one
                   7206:          from which the package was installed. This target is
                   7207:          intended to be used by people who may wish to upgrade
                   7208:          many packages on a single host, and can be invoked from
                   7209:          the top-level pkgsrc Makefile by using the
1.128     wiz      7210:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.75      rillig   7211: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7212: <dd><p>This target shows which installed packages match
                   7213:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7214:          if out of date dependencies are causing build
                   7215:          problems.</p></dd>
1.205     wiz      7216: <dt><span class="term">print-build-depends-list</span></dt>
                   7217: <dd><p>This target shows the list of packages that the current package
                   7218:            depends on for building.</p></dd>
                   7219: <dt><span class="term">print-run-depends-list</span></dt>
                   7220: <dd><p>This target shows the list of packages that the current package
                   7221:            depends on for running.</p></dd>
1.75      rillig   7222: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7223: <dd><p>After a package is installed, check all its
                   7224:          binaries and (on ELF platforms) shared libraries to see
                   7225:          if they find the shared libs they need.  Run by default
1.110     hubertf  7226:          if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75      rillig   7227: <dt><span class="term">print-PLIST</span></dt>
                   7228: <dd>
1.128     wiz      7229: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.88      wiz      7230:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  7231:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      7232:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7233:          to care for shared libs etc., but it is
1.87      wiz      7234:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7235:          result before putting it into
                   7236:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7237:          diff the output of this command against an already
                   7238:          existing <code class="filename">PLIST</code> file.</p>
1.189     snj      7239: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88      wiz      7240:          other methods that don't update file access times, be
                   7241:          sure to add these files manually to your
1.128     wiz      7242:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   7243:          -newer</span>&#8221;</span> command used by this target won't catch
1.87      wiz      7244:          them!</p>
1.128     wiz      7245: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, &#8220;Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>&#8221;</a> for more
1.87      wiz      7246:          information on this target.</p>
1.75      rillig   7247: </dd>
                   7248: <dt><span class="term">bulk-package</span></dt>
                   7249: <dd>
1.88      wiz      7250: <p>Used to do bulk builds. If an appropriate binary
                   7251:          package already exists, no action is taken. If not, this
                   7252:          target will compile, install and package it (and its
                   7253:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174     asau     7254:          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
                   7255: builds)</i></a>).
1.88      wiz      7256:          After creating the binary package, the sources, the
                   7257:          just-installed package and its required packages are
                   7258:          removed, preserving free disk space.</p>
                   7259: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7260:          all packages installed on a system!</em></span></p>
1.75      rillig   7261: </dd>
                   7262: <dt><span class="term">bulk-install</span></dt>
                   7263: <dd>
1.88      wiz      7264: <p>Used during bulk-installs to install required
                   7265:          packages. If an up-to-date binary package is available,
1.189     snj      7266:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110     hubertf  7267:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      7268:          but the installed binary won't be removed.</p>
1.88      wiz      7269: <p>A binary package is considered
1.128     wiz      7270:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.189     snj      7271:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148     asau     7272: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7273: <li class="listitem"><p>None of the package's files
1.88      wiz      7274:              (<code class="filename">Makefile</code>, ...) were modified
                   7275:              since it was built.</p></li>
1.128     wiz      7276: <li class="listitem"><p>None of the package's required (binary)
1.88      wiz      7277:              packages were modified since it was built.</p></li>
1.75      rillig   7278: </ul></div>
1.88      wiz      7279: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7280:          all packages installed on a system!</em></span></p>
1.75      rillig   7281: </dd>
                   7282: </dl></div>
                   7283: </div>
                   7284: </div>
1.148     asau     7285: <div class="chapter">
1.75      rillig   7286: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7287: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7288: <div class="toc">
                   7289: <p><b>Table of Contents</b></p>
1.210     leot     7290: <dl class="toc">
1.106     rillig   7291: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7292: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7293: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7294: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7295: </dl>
                   7296: </div>
1.87      wiz      7297: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7298: by pkgsrc and also for individual packages to define what commands
                   7299: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7300: or for later run-time of an installed packaged (such as
                   7301: <code class="varname">DEPENDS</code>).
                   7302: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7303: package will not be used.</p>
                   7304: <p>When building a package, the replacement tools are
1.75      rillig   7305: made available in a directory (as symlinks or wrapper scripts)
                   7306: that is early in the executable search path. Just like the buildlink
1.87      wiz      7307: system, this helps with consistent builds.</p>
                   7308: <p>A tool may be needed to help build a specific package. For example,
                   7309: perl, GNU make (gmake) or yacc may be needed.</p>
                   7310: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7311: tool may be inefficient for building a package with pkgsrc.
                   7312: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7313: yacc) or a better sed.</p>
                   7314: <p>The tools used by a package can be listed by running
1.110     hubertf  7315: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     7316: <div class="sect1">
1.75      rillig   7317: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7318: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7319: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7320: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  7321: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7322: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   7323: These can be seen by running:
1.110     hubertf  7324: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      7325: <p>If a package needs a specific program to build
1.75      rillig   7326: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7327: to define the tools needed.</p>
1.75      rillig   7328: </div>
1.148     asau     7329: <div class="sect1">
1.75      rillig   7330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7331: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135     wiz      7332: <p>In the following examples, the :run means that it is needed at
                   7333: run-time (and becomes a DEPENDS).
1.75      rillig   7334: The default is a build dependency which can be set with
                   7335: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7336: and pkg-config:build.)</p>
1.75      rillig   7337: <pre class="programlisting">
                   7338: USE_TOOLS+=     gmake perl:run pkg-config
                   7339: </pre>
1.87      wiz      7340: <p>When using the tools framework, a
1.75      rillig   7341: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7342: which contains the full path to the appropriate tool. For example,
1.128     wiz      7343: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.87      wiz      7344: on Linux systems.</p>
                   7345: <p>If you always need a pkgsrc version of the
1.75      rillig   7346: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7347: </p>
                   7348: </div>
1.148     asau     7349: <div class="sect1">
1.75      rillig   7350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7351: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7352: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7353: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7354: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7355: the name of the common tools. For example:</p>
                   7356: <pre class="programlisting">
                   7357: .if exists(/usr/bin/bzcat)
                   7358: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7359: .elif exists(/usr/bin/bzip2)
                   7360: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7361: .endif
1.69      rillig   7362: 
1.75      rillig   7363: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7364: </pre>
                   7365: </div>
1.148     asau     7366: <div class="sect1">
1.97      rillig   7367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7368: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148     asau     7369: <div class="qandaset">
1.218   ! rillig   7370: <a name="idm83805728"></a><dl>
1.106     rillig   7371: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97      rillig   7372: </dt>
1.106     rillig   7373: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97      rillig   7374:        tools?</a>
                   7375: </dt>
1.106     rillig   7376: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97      rillig   7377:        package is using while being built? I want to know whether it
                   7378:        uses sed or not.</a>
                   7379: </dt>
                   7380: </dl>
1.148     asau     7381: <table border="0" style="width: 100%;">
                   7382: <colgroup>
1.97      rillig   7383: <col align="left" width="1%">
1.128     wiz      7384: <col>
1.148     asau     7385: </colgroup>
1.97      rillig   7386: <tbody>
1.148     asau     7387: <tr class="question">
1.97      rillig   7388: <td align="left" valign="top">
1.218   ! rillig   7389: <a name="tools.new"></a><a name="idm83805344"></a><p><b>18.4.1.</b></p>
1.97      rillig   7390: </td>
                   7391: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7392: </tr>
                   7393: <tr class="answer">
                   7394: <td align="left" valign="top"></td>
                   7395: <td align="left" valign="top"><p>TODO</p></td>
                   7396: </tr>
1.148     asau     7397: <tr class="question">
1.97      rillig   7398: <td align="left" valign="top">
1.218   ! rillig   7399: <a name="tools.listall"></a><a name="idm83804320"></a><p><b>18.4.2.</b></p>
1.97      rillig   7400: </td>
                   7401: <td align="left" valign="top"><p>How do I get a list of all available
                   7402:        tools?</p></td>
                   7403: </tr>
                   7404: <tr class="answer">
                   7405: <td align="left" valign="top"></td>
                   7406: <td align="left" valign="top"><p>TODO</p></td>
                   7407: </tr>
1.148     asau     7408: <tr class="question">
1.97      rillig   7409: <td align="left" valign="top">
1.218   ! rillig   7410: <a name="tools.used"></a><a name="idm83803296"></a><p><b>18.4.3.</b></p>
1.97      rillig   7411: </td>
                   7412: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7413:        package is using while being built? I want to know whether it
                   7414:        uses sed or not.</p></td>
                   7415: </tr>
                   7416: <tr class="answer">
                   7417: <td align="left" valign="top"></td>
                   7418: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7419:        to do it.)</p></td>
                   7420: </tr>
                   7421: </tbody>
                   7422: </table>
                   7423: </div>
                   7424: </div>
1.75      rillig   7425: </div>
1.148     asau     7426: <div class="chapter">
1.75      rillig   7427: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7428: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   7429: <div class="toc">
                   7430: <p><b>Table of Contents</b></p>
1.210     leot     7431: <dl class="toc">
1.106     rillig   7432: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   7433: <dd><dl>
1.218   ! rillig   7434: <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>
        !          7435: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
        !          7436: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
        !          7437: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
        !          7438: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
        !          7439: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
        !          7440: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
        !          7441: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
        !          7442: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
        !          7443: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
        !          7444: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.106     rillig   7445: </dl></dd>
1.218   ! rillig   7446: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   7447: <dd><dl>
                   7448: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7449: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.199     tnn      7450: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig   7451: </dl></dd>
1.218   ! rillig   7452: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig   7453: <dd><dl>
                   7454: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7455: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7456: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7457: </dl></dd>
                   7458: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7459: <dd><dl>
                   7460: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7461: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7462: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      7463: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   7464: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   7465: </dl></dd>
1.218   ! rillig   7466: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig   7467: <dd><dl>
                   7468: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7469: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      7470: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.106     rillig   7471: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7472: </dl></dd>
1.218   ! rillig   7473: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig   7474: <dd><dl>
                   7475: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7476: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7477: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7478: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7479: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7480: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7481: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7482: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   7483: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   7484: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   7485: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7486: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7487: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7488: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7489: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7490: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7491: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7492: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      7493:     emulation</a></span></dt>
1.106     rillig   7494: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7495: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7496: </dl></dd>
1.106     rillig   7497: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7498: </dl>
                   7499: </div>
1.148     asau     7500: <div class="sect1">
1.75      rillig   7501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7502: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.78      rillig   7503: <p>One appealing feature of pkgsrc is that it runs on many
1.218   ! rillig   7504:   different platforms. As a result, it is important to ensure,
        !          7505:   where possible, that packages in pkgsrc are portable. This
        !          7506:   chapter mentions some particular details you should pay
        !          7507:   attention to while working on pkgsrc.</p>
1.148     asau     7508: <div class="sect2">
1.78      rillig   7509: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   7510: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93      rillig   7511: </h3></div></div></div>
1.78      rillig   7512: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7513:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7514:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7515:     want to use those variables in the preprocessor directives of
1.189     snj      7516:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7517:     <code class="literal">.for</code>), you need to include the file
                   7518:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7519:     loads the user preferences.</p>
1.78      rillig   7520: <p>But note that some variables may not be completely defined
1.218   ! rillig   7521:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been included,
        !          7522:     as they may contain references to variables that are not yet
        !          7523:     defined. In shell commands (the lines in
        !          7524:     <code class="filename">Makefile</code> that are indented with a tab) this is
        !          7525:     no problem, since variables are only expanded when they are used.
        !          7526:     But in the preprocessor directives mentioned above and in dependency
        !          7527:     lines (of the form <code class="literal">target: dependencies</code>) the
        !          7528:     variables are expanded at load time.</p>
1.148     asau     7529: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7530: <h3 class="title">Note</h3>
1.218   ! rillig   7531: <p>To check whether a variable can be used at load time,
        !          7532:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   7533: </div>
                   7534: </div>
1.148     asau     7535: <div class="sect2">
1.78      rillig   7536: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   7537: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.88      wiz      7538: <p>Occasionally, packages require interaction from the user,
                   7539:     and this can be in a number of ways:</p>
1.148     asau     7540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7541: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7542:        interaction such as entering username/password or accepting a
                   7543:        license on a web page.</p></li>
1.128     wiz      7544: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7545:        passwords.</p></li>
1.128     wiz      7546: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7547: <li class="listitem"><p>help during the build process</p></li>
                   7548: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7549: </ul></div>
1.218   ! rillig   7550: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
        !          7551:     variable to define which stages need interaction. This should be
        !          7552:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7553: <pre class="programlisting">
1.100     rillig   7554: INTERACTIVE_STAGE=      configure install
1.87      wiz      7555:     </pre>
1.88      wiz      7556: <p>The user can then decide to skip this package by setting the
1.218   ! rillig   7557:     <code class="varname">BATCH</code> variable. Packages that require interaction
        !          7558:     are also excluded from bulk builds.</p>
1.75      rillig   7559: </div>
1.148     asau     7560: <div class="sect2">
1.75      rillig   7561: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   7562: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.98      wiz      7563: <p>Authors of software can choose the licence under which
                   7564:     software can be copied.  This is due to copyright law, and reasons
                   7565:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7566:     system recognizes that there are a number of licenses which some
                   7567:     users may find objectionable or difficult or impossible to comply
                   7568:     with.  The Free Software Foundation has declared some licenses
                   7569:     "Free", and the Open Source Initiative has a definition of "Open
1.218   ! rillig   7570:     Source".  Note that a package whose license forbids to copy does
        !          7571:     not meet either the Free or Open Source test.</p>
1.98      wiz      7572: <p>For packages which are not Free or Open Source, pkgsrc will
                   7573:     not build the package unless the user has indicated to pkgsrc that
                   7574:     packages with that particular license may be built.  Note that
                   7575:     this documentation avoids the term "accepted the license".  The
                   7576:     pkgsrc system is merely providing a mechanism to avoid
1.99      rillig   7577:     accidentally building a package with a non-free license;
1.98      wiz      7578:     judgement and responsibility remain with the user.  (Installation
                   7579:     of binary packages are not currently subject to this mechanism;
                   7580:     this is a bug.)</p>
                   7581: <p>One might want to only install packages with a BSD license,
1.218   ! rillig   7582:     or the GPL, and not the other.  The free licenses are added to the
1.121     jnemeth  7583:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
                   7584:     user can override the default by setting the
                   7585:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
                   7586:     of "+=".  The licenses accepted by default are:
                   7587:     </p>
                   7588: <pre class="programlisting">
1.154     rodent   7589:        apache-1.1 apache-2.0
                   7590:        arphic-public
                   7591:        artistic artistic-2.0
                   7592:        boost-license
                   7593:        cc-by-sa-v3.0
1.161     ryoon    7594:        cc0-1.0-universal
1.154     rodent   7595:        cddl-1.0
                   7596:        cpl-1.0
                   7597:        epl-v1.0
                   7598:        gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
                   7599:        gnu-gpl-v1
                   7600:        gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
                   7601:        gnu-gpl-v3 gnu-lgpl-v3
                   7602:        ibm-public-license-1.0
                   7603:        ipafont
                   7604:        isc
                   7605:        lppl-1.3c
                   7606:        lucent
                   7607:        miros
                   7608:        mit
                   7609:        mpl-1.0 mpl-1.1 mpl-2.0
                   7610:        mplusfont
                   7611:        ofl-v1.0 ofl-v1.1
                   7612:        original-bsd modified-bsd 2-clause-bsd
                   7613:        php
                   7614:        png-license
                   7615:        postgresql-license
                   7616:        public-domain
                   7617:        python-software-foundation
                   7618:        qpl-v1.0
1.158     rodent   7619:        sgi-free-software-b-v2.0
1.154     rodent   7620:        sleepycat-public
                   7621:        unlicense
                   7622:        x11
                   7623:        zlib
                   7624:        zpl
1.121     jnemeth  7625:     </pre>
                   7626: <p>
                   7627:     </p>
1.78      rillig   7628: <p>The license tag mechanism is intended to address
1.87      wiz      7629:     copyright-related issues surrounding building, installing and
                   7630:     using a package, and not to address redistribution issues (see
                   7631:     <code class="varname">RESTRICTED</code> and
1.121     jnemeth  7632:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  
                   7633:     Packages with redistribution restrictions should set these
                   7634:     tags.</p>
1.98      wiz      7635: <p>Denoting that a package may be copied according to a
                   7636:     particular license is done by placing the license in
1.87      wiz      7637:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7638:     <code class="varname">LICENSE</code> variable to a string identifying the
1.189     snj      7639:     license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7640: <pre class="programlisting">
1.100     rillig   7641: LICENSE=        xv-license
1.87      wiz      7642:     </pre>
                   7643: <p>When trying to build, the user will get a notice that the
1.98      wiz      7644:     package is covered by a license which has not been placed in the
                   7645:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7646: <pre class="programlisting">
1.100     rillig   7647: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7648: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7649: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7650: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7651: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7652: *** Error code 1
1.87      wiz      7653:     </pre>
1.110     hubertf  7654: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7655:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7656:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7657:     convey to pkgsrc that it should not in the future fail because of
                   7658:     that license:</p>
1.78      rillig   7659: <pre class="programlisting">
1.100     rillig   7660: ACCEPTABLE_LICENSES+=xv-license
1.87      wiz      7661:     </pre>
1.154     rodent   7662: <p>When adding a package with a new license, the following steps
                   7663:     are required:</p>
                   7664: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7665: <li class="listitem">
                   7666: <p>Check if the file can avoid the -license filename tag as described above by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.html" target="_top">Various Licenses and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name | Open Source Initiative</a>.  If this is the case, additionally add the license filename to:</p>
                   7667: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7668: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7669: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.158     rodent   7670: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154     rodent   7671: </ul></div>
                   7672: <p>with the proper syntax as demonstrated in those files, respectively.</p>
                   7673: </li>
                   7674: <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>
                   7675: </ol></div>
1.98      wiz      7676: <p>When the license changes (in a way other than formatting),
                   7677:     please make sure that the new license has a different name (e.g.,
                   7678:     append the version number if it exists, or the date).  Just
                   7679:     because a user told pkgsrc to build programs under a previous
                   7680:     version of a license does not mean that pkgsrc should build
1.99      rillig   7681:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7682:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7683:     test is a mechanistic test of whether a particular text has been
                   7684:     approved by either of two bodies.</p>
1.78      rillig   7685: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98      wiz      7686:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7687:     is deprecated because it does not crisply refer to a particular
                   7688:     license text.  Another problem with such usage is that it does not
                   7689:     enable a user to tell pkgsrc to proceed for a single package
                   7690:     without also telling pkgsrc to proceed for all packages with that
                   7691:     tag.</p>
1.75      rillig   7692: </div>
1.148     asau     7693: <div class="sect2">
1.75      rillig   7694: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   7695: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7696: <p>Some licenses restrict how software may be re-distributed.
1.98      wiz      7697:     Because a license tag is required unless the package is Free or
                   7698:     Open Source, all packages with restrictions should have license
                   7699:     tags.  By declaring the restrictions, package tools can
                   7700:     automatically refrain from e.g. placing binary packages on FTP
                   7701:     sites.</p>
                   7702: <p>There are four restrictions that may be encoded, which are
                   7703:     the cross product of sources (distfiles) and binaries not being
                   7704:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7705:     language in any license, and because non-Free licenses tend to be
                   7706:     different from each other, pkgsrc adopts a definition of FTP and
                   7707:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7708:     should not be made available over the Internet at no charge.
                   7709:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7710:     made available on some kind of media, together with other source
                   7711:     and binary packages, and which is sold for a distribution charge.
                   7712:     </p>
                   7713: <p>In order to encode these restrictions, the package system
1.87      wiz      7714:     defines five make variables that can be set to note these
                   7715:     restrictions:</p>
1.148     asau     7716: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7717: <li class="listitem">
1.75      rillig   7718: <p><code class="varname">RESTRICTED</code></p>
                   7719: <p>This variable should be set whenever a restriction
1.87      wiz      7720:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7721:        string containing the reason for the restriction.  It should
                   7722:        be understood that those wanting to understand the restriction
                   7723:        will have to read the license, and perhaps seek advice of
                   7724:        counsel.</p>
1.75      rillig   7725: </li>
1.128     wiz      7726: <li class="listitem">
1.75      rillig   7727: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7728: <p>Binaries may not be placed on CD-ROM containing other
                   7729:        binary packages, for which a distribution charge may be made.
                   7730:        In this case, set this variable to
                   7731:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7732: </li>
1.128     wiz      7733: <li class="listitem">
1.75      rillig   7734: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7735: <p>Binaries may not made available on the Internet without
                   7736:        charge.  In this case, set this variable to
                   7737:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7738:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7739: </li>
1.128     wiz      7740: <li class="listitem">
1.75      rillig   7741: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7742: <p>Distfiles may not be placed on CD-ROM, together with
                   7743:        other distfiles, for which a fee may be charged.  In this
                   7744:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7745:        </p>
1.75      rillig   7746: </li>
1.128     wiz      7747: <li class="listitem">
1.75      rillig   7748: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7749: <p>Distfiles may not made available via FTP at no charge.
                   7750:        In this case, set this variable to
                   7751:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7752:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7753: </li>
                   7754: </ul></div>
1.139     wiz      7755: <p>Please note that packages will to be removed from pkgsrc
                   7756:     when the distfiles are not distributable and cannot be obtained
                   7757:     for a period of one full quarter branch. Packages with manual /
                   7758:     interactive fetch must have a maintainer and it is his/her
                   7759:     responsibility to ensure this.</p>
1.75      rillig   7760: </div>
1.148     asau     7761: <div class="sect2">
1.75      rillig   7762: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   7763: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.75      rillig   7764: <p>Your package may depend on some other package being present
1.88      wiz      7765:     - and there are various ways of expressing this dependency.
                   7766:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7767:     <code class="varname">DEPENDS</code> definitions, the
                   7768:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7769:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7770:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  7771:     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   7772: <p>The basic difference between the two variables is as
1.87      wiz      7773:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7774:     that pre-requisite in the binary package so it will be pulled in
                   7775:     when the binary package is later installed, whilst the
                   7776:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7777:     dependency that is only needed for building the package.</p>
1.75      rillig   7778: <p>This means that if you only need a package present whilst
1.87      wiz      7779:     you are building, it should be noted as a
                   7780:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7781: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7782:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7783: <pre class="programlisting">
1.100     rillig   7784: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.87      wiz      7785:     </pre>
1.128     wiz      7786: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7787:     may include any of the wildcard version numbers recognized by
1.189     snj      7788:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7789: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7790: <li class="listitem">
1.75      rillig   7791: <p>If your package needs another package's binaries or
1.160     wiz      7792:        libraries to build and run, and if that package has a
1.87      wiz      7793:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7794: <pre class="programlisting">
1.100     rillig   7795: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      7796:        </pre>
1.75      rillig   7797: </li>
1.128     wiz      7798: <li class="listitem">
1.160     wiz      7799: <p>If your package needs another package's binaries or
                   7800:        libraries only for building, and if that package has a
                   7801:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7802: <pre class="programlisting">
                   7803: .include "../../graphics/jpeg/buildlink3.mk"
                   7804:        </pre>
                   7805: <p>but set
                   7806:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7807:        to make it a build dependency only. This case is rather
                   7808:        rare.</p>
                   7809: </li>
                   7810: <li class="listitem">
1.132     spz      7811: <p>If your package needs binaries from another package to build,
                   7812:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75      rillig   7813: <pre class="programlisting">
1.132     spz      7814: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87      wiz      7815:        </pre>
1.75      rillig   7816: </li>
1.132     spz      7817: <li class="listitem"><p>If your package needs a library with which to link and
                   7818:        there is no <code class="filename">buildlink3.mk</code> file
                   7819:        available, create one. Using
                   7820:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7821:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7822: <li class="listitem">
1.132     spz      7823: <p>If your package needs some executable to be able to run
                   7824:        correctly and if there's no
                   7825:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7826:        using the <code class="varname">DEPENDS</code> variable. The
1.189     snj      7827:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.132     spz      7828:        be able to execute the latex binary from the teTeX package
                   7829:        when it runs, and that is specified:</p>
1.75      rillig   7830: <pre class="programlisting">
1.132     spz      7831: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.87      wiz      7832:        </pre>
1.132     spz      7833: </li>
                   7834: <li class="listitem">
                   7835: <p>You can use wildcards in package dependencies. Note that
                   7836:        such wildcard dependencies are retained when creating binary
                   7837:        packages. The dependency is checked when installing the binary
                   7838:        package and any package which matches the pattern will be
                   7839:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7840: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7841:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7842:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7843:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7844: <p>Wildcards can also be used to specify that a package
1.87      wiz      7845:        will only build against a certain minimum version of a
                   7846:        pre-requisite:</p>
1.75      rillig   7847: <pre class="programlisting">
1.132     spz      7848: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.87      wiz      7849:        </pre>
1.132     spz      7850: <p>This means that the package will build using version 6.0
                   7851:        of ImageMagick or newer. Such a dependency may be warranted
                   7852:        if, for example, the command line options of an executable
                   7853:        have changed.</p>
                   7854: <p>If you need to depend on minimum versions of libraries,
                   7855:        see the buildlink section of the pkgsrc guide.</p>
1.75      rillig   7856: <p>For security fixes, please update the package
1.218   ! rillig   7857:        vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.9. Handling packages with security problems">Section 19.1.9, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      7858:        information.</p>
1.75      rillig   7859: </li>
                   7860: </ol></div>
                   7861: <p>If your package needs files from another package to build,
1.87      wiz      7862:     add the relevant distribution files to
                   7863:     <code class="varname">DISTFILES</code>, so they will be extracted
1.189     snj      7864:     automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      7865:     (It relies on the jpeg sources being present in source form
                   7866:     during the build.)</p>
1.75      rillig   7867: </div>
1.148     asau     7868: <div class="sect2">
1.75      rillig   7869: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   7870: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7871: <p>Your package may conflict with other packages a user might
1.87      wiz      7872:     already have installed on his system, e.g. if your package
1.88      wiz      7873:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7874:     tree or has the same <code class="varname">PKGNAME</code>.</p>
                   7875: <p>These cases are handled automatically by the packaging tools
                   7876:     at package installation time and do not need to be handled
                   7877:     manually.</p>
                   7878: <p>In case the conflicts can not be recognized automatically
                   7879:     (e.g., packages using the same config file location but no other
                   7880:     shared files), you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      7881:     space-separated list of packages (including version string) your
                   7882:     package conflicts with.</p>
1.190     wiz      7883: <p>For example, if both <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/bar/README.html" target="_top"><code class="filename">foo/bar</code></a>
                   7884:     and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
                   7885:     use the same config file, you would set in
                   7886:     <code class="filename">foo/bar/Makefile</code>:</p>
1.87      wiz      7887: <pre class="programlisting">
1.190     wiz      7888: CONFLICTS=      baz-[0-9]*
1.87      wiz      7889:     </pre>
1.190     wiz      7890: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.75      rillig   7891: <pre class="programlisting">
1.190     wiz      7892: CONFLICTS=      bar-[0-9]*
1.87      wiz      7893:     </pre>
1.75      rillig   7894: </div>
1.148     asau     7895: <div class="sect2">
1.75      rillig   7896: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   7897: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7898: <p>There are several reasons why a package might be
1.88      wiz      7899:     instructed to not build under certain circumstances.  If the
1.87      wiz      7900:     package builds and runs on most platforms, the exceptions
1.193     dholland 7901:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7902:     the package builds and runs on a small handful of platforms,
                   7903:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7904:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7905:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7906:     (OS-version-platform) that can use glob-style
                   7907:     wildcards.</p>
                   7908: <p>If a package is not appropriate for some platforms (as
                   7909:     oopposed to merely broken), a different set of variables should be
                   7910:     used as this affects failure reporting and statistics.
                   7911:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7912:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7913:     the package is appropriate for only a small handful of platforms
                   7914:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7915:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7916:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7917:     (OS-version-platform) that can use glob-style
                   7918:     wildcards.</p>
1.88      wiz      7919: <p>Some packages are tightly bound to a specific version of an
1.189     snj      7920:     operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      7921:     backwards compatible with other versions of the OS, and should be
                   7922:     uploaded to a version specific directory on the FTP server.  Mark
                   7923:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7924:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7925:     the package system internals, but may be used in the
                   7926:     future.</p>
1.75      rillig   7927: <p>If the package should be skipped (for example, because it
1.87      wiz      7928:     provides functionality already provided by the system), set
1.88      wiz      7929:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7930:     the package should fail because some preconditions are not met,
                   7931:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7932:     message.</p>
1.75      rillig   7933: </div>
1.148     asau     7934: <div class="sect2">
1.75      rillig   7935: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   7936: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7937: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7938:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7939:     be set in the package Makefile. This will be carried into any
                   7940:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7941:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.189     snj      7942:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7943:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7944: </div>
1.148     asau     7945: <div class="sect2">
1.75      rillig   7946: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   7947: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7948: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7949:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      7950:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7951:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7952: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7953:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7954:     course not necessary if the problem is fixed by using a newer
                   7955:     release of the software), and the pattern in the
                   7956:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7957: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7958:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7959: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7960:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7961: </div>
1.148     asau     7962: <div class="sect2">
1.75      rillig   7963: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   7964: <a name="bumping-pkgrevision"></a>19.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   7965: <p>When making fixes to an existing package it can be useful
1.87      wiz      7966:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7967:     avoid conflicting with future versions by the original author, a
1.128     wiz      7968:     <span class="quote">&#8220;<span class="quote">nb1</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">nb2</span>&#8221;</span>, ... suffix can be used
1.87      wiz      7969:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7970:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7971:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7972: <pre class="programlisting">
1.100     rillig   7973: DISTNAME=       foo-17.42
                   7974: PKGREVISION=    9
1.87      wiz      7975:     </pre>
1.75      rillig   7976: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7977:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7978:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7979:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7980:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7981: <p>When a new release of the package is released, the
1.87      wiz      7982:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7983:     minor release of the above package, things should be like:</p>
1.75      rillig   7984: <pre class="programlisting">
1.100     rillig   7985: DISTNAME=       foo-17.43
1.87      wiz      7986:     </pre>
                   7987: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7988:     non-trivial change in the resulting binary package.  Without a
                   7989:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7990:     version installed has no way of knowing that their package is out
                   7991:     of date.  Thus, changes without increasing
                   7992:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7993:     trivial that no reasonable person would want to upgrade", and this
                   7994:     is the rough test for when increasing
                   7995:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7996:     changes that do not merit increasing
                   7997:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7998: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7999: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114     jmcneill 8000:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   8001:       or comments in Makefile.</p></li>
1.128     wiz      8002: <li class="listitem"><p>
1.100     rillig   8003:       Changing build variables if the resulting binary package is the same.</p></li>
1.128     wiz      8004: <li class="listitem"><p>
1.100     rillig   8005:       Changing <code class="filename">DESCR</code>.</p></li>
1.128     wiz      8006: <li class="listitem"><p>
1.100     rillig   8007:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8008: </ul></div>
1.87      wiz      8009: <p>Examples of changes that do merit an increase to
                   8010:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     8011: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8012: <li class="listitem"><p>
1.100     rillig   8013:       Security fixes</p></li>
1.128     wiz      8014: <li class="listitem"><p>
1.100     rillig   8015:       Changes or additions to a patch file</p></li>
1.128     wiz      8016: <li class="listitem"><p>
1.100     rillig   8017:       Changes to the <code class="filename">PLIST</code></p></li>
1.128     wiz      8018: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100     rillig   8019: </ul></div>
1.78      rillig   8020: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8021:     changes.</p>
1.75      rillig   8022: </div>
1.148     asau     8023: <div class="sect2">
1.79      rillig   8024: <div class="titlepage"><div><div><h3 class="title">
1.218   ! rillig   8025: <a name="fixes.subst"></a>19.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79      rillig   8026: <p>When you want to replace the same text in multiple files
1.87      wiz      8027:     or when the replacement text varies, patches alone cannot help.
                   8028:     This is where the SUBST framework comes in. It provides an
                   8029:     easy-to-use interface for replacing text in files.
                   8030:     Example:</p>
                   8031: <pre class="programlisting">
1.100     rillig   8032: SUBST_CLASSES+=                 fix-paths
                   8033: SUBST_STAGE.fix-paths=          pre-configure
                   8034: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8035: SUBST_FILES.fix-paths=          src/*.c
                   8036: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8037: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8038: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.87      wiz      8039:     </pre>
1.79      rillig   8040: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      8041:     that are used to identify the different SUBST blocks that are
                   8042:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8043:     important to always use the <code class="literal">+=</code> operator with
                   8044:     this variable. Otherwise some substitutions may be
                   8045:     skipped.</p>
1.79      rillig   8046: <p>The remaining variables of each SUBST block are
1.87      wiz      8047:     parameterized with the identifier from the first line
                   8048:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8049:     parameters to a function call.</p>
1.79      rillig   8050: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      8051:     which the replacement will take place. All combinations of
                   8052:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8053:     <code class="literal">post-</code> together with a phase name are
                   8054:     possible, though only few are actually used. Most commonly used
                   8055:     are <code class="literal">post-patch</code> and
                   8056:     <code class="literal">pre-configure</code>. Of these two,
                   8057:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  8058:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      8059:     have the state after applying the patches but before making any
                   8060:     other changes. This is especially useful when you are debugging
                   8061:     a package in order to create new patches for it. Similarly,
                   8062:     <code class="literal">post-build</code> is preferred over
                   8063:     <code class="literal">pre-install</code>, because the install phase should
                   8064:     generally be kept as simple as possible. When you use
                   8065:     <code class="literal">post-build</code>, you have the same files in the
                   8066:     working directory that will be installed later, so you can check
                   8067:     if the substitution has succeeded.</p>
1.79      rillig   8068: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      8069:     that is printed just before the substitution is done.</p>
1.79      rillig   8070: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8071:     globbing patterns that specifies the files in which the
                   8072:     substitution will take place. The patterns are interpreted
                   8073:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8074: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.189     snj      8075:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87      wiz      8076:     command should be prefixed with <code class="literal">-e</code>, so that
                   8077:     all SUBST blocks look uniform.</p>
1.79      rillig   8078: <p>There are some more variables, but they are so seldomly
1.87      wiz      8079:     used that they are only documented in the
                   8080:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8081: </div>
1.75      rillig   8082: </div>
1.148     asau     8083: <div class="sect1">
1.75      rillig   8084: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218   ! rillig   8085: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     8086: <div class="sect2">
1.75      rillig   8087: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8088: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   8089: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8090:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8091:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8092:     with the name of each file to download as an argument, expecting
                   8093:     it to output the URL of the directory from which to download
1.189     snj      8094:     it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      8095:     example of this usage.</p>
1.75      rillig   8096: <p>If the download can't be automated, because the user must
1.87      wiz      8097:     submit personal information to apply for a password, or must pay
                   8098:     for the source, or whatever, you can set
                   8099:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8100:     displayed to the user before aborting the build. Example:</p>
                   8101: <pre class="programlisting">
1.100     rillig   8102: FETCH_MESSAGE=  "Please download the files"
                   8103: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8104: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87      wiz      8105:     </pre>
1.75      rillig   8106: </div>
1.148     asau     8107: <div class="sect2">
1.75      rillig   8108: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8109: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   8110: <p>Sometimes authors of a software package make some
1.87      wiz      8111:     modifications after the software was released, and they put up a
                   8112:     new distfile without changing the package's version number. If a
                   8113:     package is already in pkgsrc at that time, the checksum will
                   8114:     no longer match. The contents of the new distfile should be
                   8115:     compared against the old one before changing anything, to make
                   8116:     sure the distfile was really updated on purpose, and that
                   8117:     no trojan horse or so crept in.
1.97      rillig   8118:     Please mention that the distfiles were compared and what was found
1.159     rodent   8119:     in your commit message.</p>
                   8120: <p>Then, the correct way to work around this is to
1.87      wiz      8121:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8122:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8123:     <code class="varname">DISTFILES</code> and
1.93      rillig   8124:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97      rillig   8125:     subdirectory of the local distfiles directory.
1.218   ! rillig   8126:     (See <a class="xref" href="#bumping-pkgrevision" title="19.1.10. How to handle incrementing versions when fixing an existing package">Section 19.1.10, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.)
1.97      rillig   8127:     In case this
1.87      wiz      8128:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8129:     including the <code class="filename">nbX</code> suffix) or a date stamp
1.159     rodent   8130:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
                   8131: <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>
                   8132: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8133:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8134:     path in the filenames.
1.159     rodent   8135:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8136:     Furthermore, a mail to the package's authors seems appropriate
                   8137:     telling them that changing distfiles after releases without
                   8138:     changing the file names is not good practice.</p>
1.75      rillig   8139: </div>
1.199     tnn      8140: <div class="sect2">
                   8141: <div class="titlepage"><div><div><h3 class="title">
                   8142: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.200     tnn      8143: <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:
                   8144:     </p>
1.199     tnn      8145: <div class="sect3">
                   8146: <div class="titlepage"><div><div><h4 class="title">
                   8147: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
                   8148: <p>
                   8149:         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.
                   8150:       </p>
                   8151: <pre class="programlisting">
                   8152: DISTNAME=       exampleproject-1.0
1.200     tnn      8153: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8154: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   8155: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      8156: EXTRACT_SUFX=   .zip
                   8157: </pre>
                   8158: </div>
                   8159: <div class="sect3">
                   8160: <div class="titlepage"><div><div><h4 class="title">
                   8161: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
                   8162: <p>
                   8163:         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.
                   8164:       </p>
                   8165: <pre class="programlisting">
                   8166: DISTNAME=       example-1.0
1.217     jnemeth  8167: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.200     tnn      8168: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   8169: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.199     tnn      8170:       </pre>
                   8171: </div>
                   8172: <div class="sect3">
                   8173: <div class="titlepage"><div><div><h4 class="title">
                   8174: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
                   8175: <p>
                   8176:         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.
                   8177:       </p>
                   8178: <pre class="programlisting">
                   8179: DISTNAME=       offensive-1.6
1.200     tnn      8180: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8181: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8182: GITHUB_PROJECT= exampleproject
                   8183: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8184: EXTRACT_SUFX=   .zip
1.199     tnn      8185:       </pre>
                   8186: </div>
                   8187: </div>
1.75      rillig   8188: </div>
1.148     asau     8189: <div class="sect1">
1.75      rillig   8190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218   ! rillig   8191: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8192: <div class="sect2">
1.75      rillig   8193: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8194: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8195: <p>pkgsrc supports many different machines, with different
1.87      wiz      8196:     object formats like a.out and ELF, and varying abilities to do
                   8197:     shared library and dynamic loading at all. To accompany this,
                   8198:     varying commands and options have to be passed to the
                   8199:     compiler, linker, etc. to get the Right Thing, which can be
                   8200:     pretty annoying especially if you don't have all the machines
                   8201:     at your hand to test things.  The
1.189     snj      8202:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128     wiz      8203:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      8204:     both static and dynamic libraries from a set of source files,
                   8205:     thus being platform-independent.</p>
                   8206: <p>Here's how to use libtool in a package in seven simple
                   8207:     steps:</p>
1.128     wiz      8208: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8209: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8210:        Makefile.</p></li>
1.128     wiz      8211: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8212:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      8213:        add it to the definition of <code class="varname">CC</code>, if only
                   8214:        libraries are being built in a given Makefile. This one command
                   8215:        will build both PIC and non-PIC library objects, so you need not
                   8216:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8217: <li class="listitem">
1.75      rillig   8218: <p>For the linking of the library, remove any
1.128     wiz      8219:        <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
                   8220:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   8221: <pre class="programlisting">
1.100     rillig   8222: ${LIBTOOL} --mode=link \
                   8223:     ${CC} -o ${.TARGET:.a=.la} \
                   8224:         ${OBJS:.o=.lo} \
                   8225:         -rpath ${PREFIX}/lib \
                   8226:         -version-info major:minor
1.87      wiz      8227:        </pre>
1.75      rillig   8228: <p>Note that the library is changed to have a
1.87      wiz      8229:        <code class="filename">.la</code> extension, and the objects are
                   8230:        changed to have a <code class="filename">.lo</code>
                   8231:        extension. Change <code class="varname">OBJS</code> as
                   8232:        necessary. This automatically creates all of the
                   8233:        <code class="filename">.a</code>,
                   8234:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8235:        necessary) in the build directory. Be sure to include
1.128     wiz      8236:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      8237:        minor are zero, as libtool will otherwise strip off the
                   8238:        shared library version.</p>
1.75      rillig   8239: <p>From the libtool manual:</p>
                   8240: <pre class="programlisting">
1.100     rillig   8241: So, libtool library versions are described by three integers:
1.69      rillig   8242: 
1.100     rillig   8243: CURRENT
                   8244: The most recent interface number that this library implements.
1.69      rillig   8245: 
1.100     rillig   8246: REVISION
                   8247: The implementation number of the CURRENT interface.
1.69      rillig   8248: 
1.100     rillig   8249: AGE
                   8250: The difference between the newest and oldest interfaces that
                   8251: this library implements.  In other words, the library implements
                   8252: all the interface numbers in the range from number `CURRENT -
                   8253: AGE' to `CURRENT'.
1.1       grant    8254: 
1.100     rillig   8255: If two libraries have identical CURRENT and AGE numbers, then the
                   8256: dynamic linker chooses the library with the greater REVISION number.
1.87      wiz      8257:        </pre>
1.128     wiz      8258: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      8259:        different results for a.out and ELF (excluding symlinks)
                   8260:        in only one case. An ELF library of the form
1.128     wiz      8261:        <span class="quote">&#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      8262:        will have a symlink of
1.128     wiz      8263:        <span class="quote">&#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      8264:        on an a.out platform. This is handled
                   8265:        automatically.</p>
1.128     wiz      8266: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      8267:        directory of the library being built.</p>
1.76      rillig   8268: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8269:        <code class="filename">.la</code> file, the other files will be
                   8270:        added automatically.</p>
1.75      rillig   8271: </li>
1.128     wiz      8272: <li class="listitem">
1.76      rillig   8273: <p>When linking shared object (<code class="filename">.so</code>)
1.189     snj      8274:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      8275:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8276:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      8277:        tacked on.</p>
1.76      rillig   8278: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8279:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8280: </li>
1.128     wiz      8281: <li class="listitem">
1.75      rillig   8282: <p>When linking programs that depend on these libraries
1.87      wiz      8283:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.189     snj      8284:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8285:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      8286:        libraries (static or shared), but please be aware that
                   8287:        libtool will not allow you to specify a relative path in
1.128     wiz      8288:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      8289:        expects you to change that argument to be the
                   8290:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8291: <pre class="programlisting">
1.100     rillig   8292: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87      wiz      8293:        </pre>
1.75      rillig   8294: <p>should be changed to:</p>
                   8295: <pre class="programlisting">
1.100     rillig   8296: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87      wiz      8297:        </pre>
1.75      rillig   8298: <p>and it will do the right thing with the libraries.</p>
                   8299: </li>
1.128     wiz      8300: <li class="listitem">
1.189     snj      8301: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8302:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8303:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      8304:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8305: <pre class="programlisting">
1.126     jakllsch 8306: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87      wiz      8307:        </pre>
1.76      rillig   8308: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8309:        shared library, any needed symlinks, and run
1.189     snj      8310:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8311: </li>
1.128     wiz      8312: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8313:        the <code class="filename">.la</code>
                   8314:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8315: </ol></div>
                   8316: </div>
1.148     asau     8317: <div class="sect2">
1.75      rillig   8318: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8319: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8320: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8321:     package Makefile. This will override the package's own libtool
                   8322:     in most cases.  For older libtool using packages,  libtool is
                   8323:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8324:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8325:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8326: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8327:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      8328:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8329:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      8330:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8331: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8332:     libraries built and installed, then use
                   8333:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8334: <p>If your package makes use of the platform-independent library
1.87      wiz      8335:     for loading dynamic shared objects, that comes with libtool
                   8336:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8337: <p>Some packages use libtool incorrectly so that the package
                   8338:     may not work or build in some circumstances. Some of the more
                   8339:     common errors are:</p>
1.148     asau     8340: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8341: <li class="listitem">
1.75      rillig   8342: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8343:        executable or library. This in itself isn't a problem if one of two things
                   8344:        has been done:</p>
1.128     wiz      8345: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8346: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8347:            <code class="filename">libfoo.la</code>, not
                   8348:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8349: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8350: </ol></div>
                   8351: </li>
1.128     wiz      8352: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8353:        The function lt_dlinit() should be called and the macro
                   8354:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8355:        executables.</p></li>
1.75      rillig   8356: </ul></div>
                   8357: </div>
1.148     asau     8358: <div class="sect2">
1.75      rillig   8359: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8360: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8361: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8362:     to regenerate the configure script and Makefile.in makefile
                   8363:     templates, then they should be executed in a pre-configure
                   8364:     target.</p>
1.75      rillig   8365: <p>For packages that need only autoconf:</p>
                   8366: <pre class="programlisting">
1.100     rillig   8367: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8368: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8369: ...
1.1       grant    8370: 
1.100     rillig   8371: pre-configure:
                   8372:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8373: 
1.100     rillig   8374: ...
1.87      wiz      8375:     </pre>
1.75      rillig   8376: <p>and for packages that need automake and autoconf:</p>
                   8377: <pre class="programlisting">
1.100     rillig   8378: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8379: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8380: ...
                   8381: 
                   8382: pre-configure:
                   8383:         set -e; cd ${WRKSRC}; \
                   8384:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8385: 
1.100     rillig   8386: ...
1.87      wiz      8387:     </pre>
1.75      rillig   8388: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8389:     require GNU Make.</p>
1.75      rillig   8390: <p>There are times when the configure process makes
1.87      wiz      8391:     additional changes to the generated files, which then causes
                   8392:     the build process to try to re-execute the automake sequence.
                   8393:     This is prevented by touching various files in the configure
                   8394:     stage. If this causes problems with your package you can set
                   8395:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8396:     Makefile.</p>
1.75      rillig   8397: </div>
                   8398: </div>
1.148     asau     8399: <div class="sect1">
1.75      rillig   8400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8401: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148     asau     8402: <div class="sect2">
1.87      wiz      8403: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8404: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8405: <p>Compilers for the C, C++, and Fortran languages comes with
                   8406:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8407:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  8408:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8409: <p>To declare which language's compiler a package needs, set
                   8410:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      8411:     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
                   8412:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8413:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8414:     written in C++, usually need a C compiler for the configure
                   8415:     phase.</p>
                   8416: </div>
1.148     asau     8417: <div class="sect2">
1.87      wiz      8418: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8419: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      8420: <p>If a program is written in Java, use the Java framework in
                   8421:     pkgsrc.  The package must include
                   8422:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8423:     provides the following variables:</p>
1.148     asau     8424: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8425: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8426:       dependency on the JDK is added.  If
1.128     wiz      8427:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      8428:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      8429:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      8430:       JDK.</p></li>
1.128     wiz      8431: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8432:       a package needs a Java2 implementation.  The supported values
1.128     wiz      8433:       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
                   8434:       <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
                   8435:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8436:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      8437:       above. This variable is not set by default.</p></li>
1.130     wiz      8438: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8439:       automatically set to the runtime location of the used Java
                   8440:       implementation dependency. It may be used to set
                   8441:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8442:       needs this variable to be defined.
                   8443:       </p></li>
1.87      wiz      8444: </ul></div>
                   8445: </div>
1.148     asau     8446: <div class="sect2">
1.87      wiz      8447: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8448: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8449: <p>If your package contains interpreted perl scripts, add
1.128     wiz      8450:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8451:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8452:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8453:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      8454:     that you want adjusted. Every occurrence of
                   8455:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   8456:     replaced with the full path to the perl executable.</p>
1.87      wiz      8457: <p>If a particular version of perl is needed, set the
                   8458:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      8459:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.110     hubertf  8460: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.87      wiz      8461:     about handling perl modules.</p>
                   8462: </div>
1.148     asau     8463: <div class="sect2">
1.87      wiz      8464: <div class="titlepage"><div><div><h3 class="title">
1.147     wiz      8465: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
                   8466: <p><code class="varname">REPLACE_SH</code>,
                   8467:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8468:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   8469:     hash bangs in files. Please use the appropriate one, prefering
                   8470:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      8471:     Each should contain a list of scripts, relative to
                   8472:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8473:     occurrence of the matching shell in a she-bang line will be
                   8474:     replaced with the full path to the shell executable.
1.147     wiz      8475:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8476:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8477: </div>
1.148     asau     8478: <div class="sect2">
1.147     wiz      8479: <div class="titlepage"><div><div><h3 class="title">
                   8480: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      8481: <p>Currently, there is no special handling for other languages
                   8482:     in pkgsrc.  If a compiler package provides a
                   8483:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8484:     just add a (build) dependency on the appropriate compiler
                   8485:     package.</p>
                   8486: </div>
                   8487: </div>
1.148     asau     8488: <div class="sect1">
1.87      wiz      8489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218   ! rillig   8490: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8491: <p>The most common failures when building a package are that
                   8492:        some platforms do not provide certain header files, functions or
                   8493:        libraries, or they provide the functions in a library that the
                   8494:        original package author didn't know. To work around this, you
                   8495:        can rewrite the source code in most cases so that it does not
                   8496:        use the missing functions or provides a replacement function.</p>
1.148     asau     8497: <div class="sect2">
1.77      rillig   8498: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8499: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8500: <p>If a package already comes with a GNU configure script, the
                   8501:        preferred way to fix the build failure is to change the
                   8502:        configure script, not the code. In the other cases, you can
                   8503:        utilize the C preprocessor, which defines certain macros
                   8504:        depending on the operating system and hardware architecture it
                   8505:        compiles for. These macros can be queried using for example
                   8506:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8507:        system, hardware architecture and compiler has its own macro.
                   8508:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8509:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8510:        are all defined, you know that you are using NetBSD on an i386
                   8511:        compatible CPU, and your compiler is GCC.</p>
                   8512: <p>The list of the following macros for hardware and
                   8513:        operating system depends on the compiler that is used. For
                   8514:        example, if you want to conditionally compile code on Solaris,
                   8515:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8516:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8517: <div class="sect3">
1.75      rillig   8518: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8519: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   8520: <p>To distinguish between 4.4 BSD-derived systems and the
                   8521:         rest of the world, you should use the following code.</p>
                   8522: <pre class="programlisting">
1.100     rillig   8523: #include &lt;sys/param.h&gt;
                   8524: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8525: /* BSD-specific code goes here */
                   8526: #else
                   8527: /* non-BSD-specific code goes here */
                   8528: #endif
1.75      rillig   8529: </pre>
1.77      rillig   8530: <p>If this distinction is not fine enough, you can also test
                   8531:        for the following macros.</p>
1.75      rillig   8532: <pre class="programlisting">
1.151     obache   8533: Cygwin      __CYGWIN__
                   8534: DragonFly   __DragonFly__
1.100     rillig   8535: FreeBSD     __FreeBSD__
1.151     obache   8536: Haiku       __HAIKU__
1.100     rillig   8537: Interix     __INTERIX
                   8538: IRIX        __sgi (TODO: get a definite source for this)
                   8539: Linux       linux, __linux, __linux__
1.193     dholland 8540: Mac OS X    __APPLE__
1.151     obache   8541: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8542: Minix3      __minix
1.100     rillig   8543: NetBSD      __NetBSD__
                   8544: OpenBSD     __OpenBSD__
                   8545: Solaris     sun, __sun
1.75      rillig   8546: </pre>
                   8547: </div>
1.148     asau     8548: <div class="sect3">
1.75      rillig   8549: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8550: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   8551: <pre class="programlisting">
1.100     rillig   8552: i386        i386, __i386, __i386__
                   8553: MIPS        __mips
                   8554: SPARC       sparc, __sparc
1.75      rillig   8555: </pre>
                   8556: </div>
1.148     asau     8557: <div class="sect3">
1.75      rillig   8558: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8559: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   8560: <pre class="programlisting">
1.100     rillig   8561: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8562: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8563: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8564: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8565: </pre>
                   8566: </div>
                   8567: </div>
1.148     asau     8568: <div class="sect2">
1.78      rillig   8569: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8570: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8571: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8572:         combinations of compiler version and architecture and almost
                   8573:         always relation to optimisation being enabled.  Common symptoms
                   8574:         are gcc internal errors or never finishing compiling a
1.78      rillig   8575:        file.</p>
                   8576: <p>Typically, a workaround involves testing the
                   8577:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8578:         optimisation for that combination of file,
1.198     tnn      8579:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8580: <p>This used to be a big problem in the past, but is rarely
                   8581:        needed now as compiler technology has matured. If you still need
                   8582:        to add a compiler specific workaround, please do so in the file
                   8583:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8584:        compiler version as detailed as possible.</p>
1.78      rillig   8585: </div>
1.148     asau     8586: <div class="sect2">
1.78      rillig   8587: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz      8588: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   8589: </h3></div></div></div>
1.92      rillig   8590: <p>This error message often means that a package did not
1.78      rillig   8591:        link to a shared library it needs. The following functions are
                   8592:        known to cause this error message over and over.</p>
                   8593: <div class="informaltable">
1.216     tnn      8594: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   8595: <colgroup>
                   8596: <col>
                   8597: <col>
                   8598: <col>
                   8599: </colgroup>
                   8600: <thead><tr>
                   8601: <th>Function</th>
                   8602: <th>Library</th>
                   8603: <th>Affected platforms</th>
                   8604: </tr></thead>
                   8605: <tbody>
                   8606: <tr>
                   8607: <td>accept, bind, connect</td>
                   8608: <td>-lsocket</td>
                   8609: <td>Solaris</td>
                   8610: </tr>
                   8611: <tr>
                   8612: <td>crypt</td>
                   8613: <td>-lcrypt</td>
                   8614: <td>DragonFly, NetBSD</td>
                   8615: </tr>
                   8616: <tr>
                   8617: <td>dlopen, dlsym</td>
                   8618: <td>-ldl</td>
                   8619: <td>Linux</td>
                   8620: </tr>
                   8621: <tr>
                   8622: <td>gethost*</td>
                   8623: <td>-lnsl</td>
                   8624: <td>Solaris</td>
                   8625: </tr>
                   8626: <tr>
                   8627: <td>inet_aton</td>
                   8628: <td>-lresolv</td>
                   8629: <td>Solaris</td>
                   8630: </tr>
                   8631: <tr>
                   8632: <td>nanosleep, sem_*, timer_*</td>
                   8633: <td>-lrt</td>
                   8634: <td>Solaris</td>
                   8635: </tr>
                   8636: <tr>
                   8637: <td>openpty</td>
                   8638: <td>-lutil</td>
                   8639: <td>Linux</td>
                   8640: </tr>
                   8641: </tbody>
                   8642: </table>
                   8643: </div>
                   8644: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8645:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8646:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8647:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8648:     bmake</strong></span>.</p>
1.148     asau     8649: <div class="sect3">
1.92      rillig   8650: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8651: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8652: <p>When you are using the SunPro compiler, there is another
                   8653: possibility. That compiler cannot handle the following code:</p>
                   8654: <pre class="programlisting">
1.100     rillig   8655: extern int extern_func(int);
1.93      rillig   8656: 
1.100     rillig   8657: static inline int
                   8658: inline_func(int x)
                   8659: {
1.92      rillig   8660:         return extern_func(x);
1.100     rillig   8661: }
1.93      rillig   8662: 
1.100     rillig   8663: int main(void)
                   8664: {
1.92      rillig   8665:         return 0;
1.100     rillig   8666: }
1.92      rillig   8667: </pre>
                   8668: <p>It generates the code for <code class="function">inline_func</code> even if
                   8669: that function is never used. This code then refers to
                   8670: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8671: solve this problem you can try to tell the package to disable inlining
                   8672: of functions.</p>
                   8673: </div>
1.87      wiz      8674: </div>
1.148     asau     8675: <div class="sect2">
1.87      wiz      8676: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8677: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8678: <p>Sometimes packages fail to build because the compiler runs
                   8679:     into an operating system specific soft limit.  With the
                   8680:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      8681:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8682:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8683:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span>.
1.87      wiz      8684:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8685:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8686:     segment size or maximum stack size of a process, respectively, to
                   8687:     their hard limits.</p>
1.78      rillig   8688: </div>
1.75      rillig   8689: </div>
1.148     asau     8690: <div class="sect1">
1.75      rillig   8691: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218   ! rillig   8692: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     8693: <div class="sect2">
1.75      rillig   8694: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8695: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8696: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8697:     with some operating systems cannot create more than one
                   8698:     directory at a time. As such, you should call
                   8699:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8700: <pre class="programlisting">
1.100     rillig   8701: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8702: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87      wiz      8703:     </pre>
1.128     wiz      8704: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8705:     dir2</code></span>&#8221;</span> to the
1.87      wiz      8706:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8707:     automatically do the right thing.</p>
1.75      rillig   8708: </div>
1.148     asau     8709: <div class="sect2">
1.75      rillig   8710: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8711: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8712: <p>In general, documentation should be installed into
1.87      wiz      8713:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8714:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8715:     includes the version number of the package).</p>
1.84      wiz      8716: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8717:     directory where HTML documentation is installed with the
1.128     wiz      8718:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      8719:     is needed because otherwise the documentation ends up in
                   8720:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8721:     places.</p>
                   8722: <p>An exception to the above is that library API documentation
1.189     snj      8723:     generated with the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      8724:     browsers (devhelp) should be left at their default location, which
                   8725:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8726:     documentation can be recognized from files ending in
                   8727:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8728:     (It is also acceptable to install such files in
                   8729:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8730:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8731:     <code class="filename">.devhelp*</code> file must be directly in that
                   8732:     directory then, no additional subdirectory level is allowed in
                   8733:     this case. This is usually achieved by using
1.128     wiz      8734:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      8735:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8736:     though.)</p>
1.75      rillig   8737: </div>
1.148     asau     8738: <div class="sect2">
1.75      rillig   8739: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8740: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8741: <p>Certain packages, most of them in the games category, install
1.87      wiz      8742:     a score file that allows all users on the system to record their
                   8743:     highscores.  In order for this to work, the binaries need to be
                   8744:     installed setgid and the score files owned by the appropriate
1.142     wiz      8745:     group and/or owner (traditionally the "games" user/group).  Set
                   8746:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      8747:     following variables, documented in more detail in
                   8748:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      8749:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8750:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     8751:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8752:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8753:     <code class="varname">GAMEDATA_PERMS</code> and
                   8754:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8755: <p>An example that illustrates some of the variables described above is
                   8756:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8757:     used to properly set directory permissions of the directory where the
                   8758:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8759:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8760:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8761:     binary:</p>
                   8762: <pre class="programlisting">
                   8763: USE_GAMESGROUP=                yes
                   8764: 
                   8765: BUILD_DEFS+=           VARBASE
                   8766: 
                   8767: OWN_DIRS_PERMS+=       ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8768: REQD_FILES_PERMS+=     /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8769: SPECIAL_PERMS+=                ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
                   8770:     </pre>
                   8771: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8772:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8773:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8774:     needed to be accessed by setgid games and
                   8775:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 8776: <p>A package should therefore never hard code file ownership or
1.210     leot     8777:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8778:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8779:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8780:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   8781: </div>
1.148     asau     8782: <div class="sect2">
1.75      rillig   8783: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8784: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8785: <p><code class="varname">DESTDIR</code> support means that a package
                   8786:     installs into a staging directory, not the final location of the
                   8787:     files. Then a binary package is created which can be used for
                   8788:     installation as usual. There are two ways: Either the package must
1.128     wiz      8789:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8790:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     8791: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8792: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145     wiz      8793:       set to <span class="quote">&#8220;<span class="quote">none</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>, or
                   8794:       <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
                   8795:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8796:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 8797:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8798:       the inclusion.</p></li>
1.128     wiz      8799: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      8800:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      8801: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      8802:       automatically. Many manual rules and pre/post-install often are
                   8803:       incorrect; fix them.</p></li>
1.128     wiz      8804: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     8805:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      8806: <li class="listitem"><p>In general, packages should support
1.103     wiz      8807:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8808:       DESTDIR.</p></li>
                   8809: </ul></div>
                   8810: </div>
1.148     asau     8811: <div class="sect2">
1.103     wiz      8812: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8813: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8814: <p>Your package may also contain scripts with hardcoded paths to
                   8815:       other interpreters besides (or as well as) perl.  To correct the
                   8816:       full pathname to the script interpreter, you need to set the
                   8817:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8818:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8819: <pre class="programlisting">
1.100     rillig   8820: REPLACE_INTERPRETER+=   tcl
                   8821: REPLACE.tcl.old=        .*/bin/tclsh
                   8822: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8823: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8824: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87      wiz      8825:     </pre>
1.148     asau     8826: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8827: <h3 class="title">Note</h3>
                   8828: <p>Before March 2006, these variables were called
1.87      wiz      8829:     <code class="varname">_REPLACE.*</code> and
                   8830:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8831: </div>
                   8832: </div>
1.148     asau     8833: <div class="sect2">
1.75      rillig   8834: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8835: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8836: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8837:     the Makefile fragment
                   8838:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8839:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8840:     configuration for such modules as well as various hooks to tune
                   8841:     this configuration.  See comments in this file for
                   8842:     details.</p>
1.75      rillig   8843: <p>Perl5 modules will install into different places depending
1.87      wiz      8844:     on the version of perl used during the build process.  To
                   8845:     address this, pkgsrc will append lines to the
                   8846:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8847:     the installed <code class="filename">.packlist</code> file generated by
                   8848:     most perl5 modules.  This is invoked by defining
                   8849:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      8850:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8851:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8852:     e.g.:</p>
1.75      rillig   8853: <pre class="programlisting">
1.153     wiz      8854: PERL5_PACKLIST= auto/Pg/.packlist
1.87      wiz      8855:     </pre>
1.153     wiz      8856: <p>The perl5 config variables
                   8857:     <code class="varname">installarchlib</code>,
                   8858:     <code class="varname">installscript</code>,
                   8859:     <code class="varname">installvendorbin</code>,
                   8860:     <code class="varname">installvendorscript</code>,
                   8861:     <code class="varname">installvendorarch</code>,
                   8862:     <code class="varname">installvendorlib</code>,
                   8863:     <code class="varname">installvendorman1dir</code>, and
                   8864:     <code class="varname">installvendorman3dir</code> represent those
                   8865:     locations in which components of perl5 modules may be installed,
                   8866:     provided as variable with uppercase and prefixed with
                   8867:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8868:     and may be used by perl5 packages that don't have a packlist.
                   8869:     These variables are also substituted for in the
                   8870:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8871:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   8872: </div>
1.148     asau     8873: <div class="sect2">
1.75      rillig   8874: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8875: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8876: <p>Some packages install info files or use the
1.128     wiz      8877:     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
1.87      wiz      8878:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8879:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8880:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8881:     handle registration of the info files in the Info directory
1.128     wiz      8882:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      8883:     files registration is either provided by the system, or by a
                   8884:     special purpose package automatically added as dependency if
                   8885:     needed.</p>
1.75      rillig   8886: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8887:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8888:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      8889:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   8890: <p>The info files for the package should be listed in the
1.87      wiz      8891:     package <code class="filename">PLIST</code>; however any split info files
                   8892:     need not be listed.</p>
1.128     wiz      8893: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8894:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      8895:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      8896:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      8897:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8898:     variable in the package <code class="filename">Makefile</code>. By
                   8899:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  8900:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      8901:     does not match the required minimum, a build dependency on the
1.189     snj      8902:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      8903:     be added automatically.</p>
1.75      rillig   8904: <p>The build and installation process of the software provided
1.87      wiz      8905:     by the package should not use the
1.110     hubertf  8906:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      8907:     info files is the task of the package
                   8908:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  8909:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   8910: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  8911:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8912:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      8913:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  8914: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      8915:     no effect except the logging of a message. The script overriding
1.110     hubertf  8916:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      8917:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  8918:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8919: </div>
1.148     asau     8920: <div class="sect2">
1.75      rillig   8921: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8922: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8923: <p>All packages that install manual pages should install them
1.87      wiz      8924:     into the same directory, so that there is one common place to look
                   8925:     for them. In pkgsrc, this place is
                   8926:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8927:     should be used in packages. The default for
                   8928:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      8929:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8930:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     8931: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8932: <h3 class="title">Note</h3>
1.87      wiz      8933: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8934:     is far from complete.</p>
1.75      rillig   8935: </div>
1.81      rillig   8936: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8937:     <code class="filename">man/</code> as the top level directory for the man
                   8938:     page file entries, and the pkgsrc framework will convert as
                   8939:     needed. In all other places, the correct
                   8940:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8941: <p>Packages that are
                   8942:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      8943:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      8944:     <code class="filename">./configure</code>
                   8945:     --mandir switch to set where the man pages should be installed.
                   8946:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8947:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8948: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8949:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      8950:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      8951:     Or if the <code class="filename">./configure</code> script uses
                   8952:     a non-standard use of --mandir, you can set
                   8953:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  8954: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      8955:     information on installation of compressed manual pages.</p>
1.75      rillig   8956: </div>
1.148     asau     8957: <div class="sect2">
1.75      rillig   8958: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   8959: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      8960: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   8961:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      8962:     you need to take some extra steps to make sure they get registered
                   8963:     in the database:</p>
1.128     wiz      8964: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8965: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      8966:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   8967:        takes care of rebuilding the GConf database at installation and
1.87      wiz      8968:        deinstallation time, and tells the package where to install
1.107     rillig   8969:        GConf data files using some standard configure arguments.  It
1.87      wiz      8970:        also disallows any access to the database directly from the
                   8971:        package.</p></li>
1.128     wiz      8972: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      8973:        <code class="filename">.schemas</code> files under
                   8974:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8975:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8976:        need to manually patch the package.</p></li>
1.128     wiz      8977: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8978:        directory, as they will be handled automatically.  See
1.194     bsiegert 8979:        <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.128     wiz      8980: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      8981:        your <code class="filename">Makefile</code> with a list of all
                   8982:        <code class="filename">.schemas</code> files installed by the package, if
                   8983:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      8984: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      8985:        your <code class="filename">Makefile</code> with a
                   8986:        list of all <code class="filename">.entries</code> files installed by the
                   8987:        package, if any. Names must not contain any directories in
                   8988:        them.</p></li>
1.75      rillig   8989: </ol></div>
                   8990: </div>
1.148     asau     8991: <div class="sect2">
1.75      rillig   8992: <div class="titlepage"><div><div><h3 class="title">
1.119     mishka   8993: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      8994: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   8995:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      8996:     get registered in the database:</p>
1.128     wiz      8997: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8998: <li class="listitem"><p>Include
1.119     mishka   8999:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9000:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      9001:        takes care of rebuilding the scrollkeeper database at
                   9002:        installation and deinstallation time, and disallows any access
                   9003:        to it directly from the package.</p></li>
1.128     wiz      9004: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9005:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9006:        will be handled automatically.</p></li>
1.128     wiz      9007: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   9008:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9009:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   9010: </ol></div>
                   9011: </div>
1.148     asau     9012: <div class="sect2">
1.75      rillig   9013: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9014: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9015: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9016:     the fonts database in the directory where they get installed at
                   9017:     installation and deinstallation time.  This can be automatically
                   9018:     done by using the pkginstall framework.</p>
1.75      rillig   9019: <p>You can list the directories where fonts are installed in the
1.87      wiz      9020:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9021:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      9022:     <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.
1.87      wiz      9023:     Also make sure that the database file
                   9024:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9025: <p>Note that you should not create new directories for fonts;
1.87      wiz      9026:     instead use the standard ones to avoid that the user needs to
                   9027:     manually configure his X server to find them.</p>
1.75      rillig   9028: </div>
1.148     asau     9029: <div class="sect2">
1.75      rillig   9030: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9031: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   9032: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      9033:     take some extra steps to get them registered in the GTK2 database
                   9034:     properly:</p>
1.128     wiz      9035: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9036: <li class="listitem"><p>Include
1.87      wiz      9037:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9038:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9039:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      9040: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      9041:       your package installs GTK2 immodules.</p></li>
1.128     wiz      9042: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      9043:       GTK2 loaders.</p></li>
1.128     wiz      9044: <li class="listitem">
1.87      wiz      9045: <p>Patch the package to not touch any of the GTK2
                   9046:       databases directly.  These are:</p>
1.148     asau     9047: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9048: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9049: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9050: </ul></div>
                   9051: </li>
1.128     wiz      9052: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      9053:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9054:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9055: </ol></div>
                   9056: </div>
1.148     asau     9057: <div class="sect2">
1.75      rillig   9058: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9059: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9060: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9061:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9062:     etc.), you need to take some extra steps:</p>
1.128     wiz      9063: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9064: <li class="listitem"><p>Include
1.87      wiz      9065:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9066:        your <code class="filename">Makefile</code>, which takes care of
                   9067:        registering those files in system-wide catalogs at
                   9068:        installation and deinstallation time.</p></li>
1.128     wiz      9069: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9070:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      9071: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9072:        any XML catalogs installed by the package.</p></li>
1.128     wiz      9073: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9074:        to be added to the SGML catalog.  These come in groups of
                   9075:        three strings; see xmlcatmgr(1) for more information
                   9076:        (specifically, arguments recognized by the 'add' action).
                   9077:        Note that you will normally not use this variable.</p></li>
1.128     wiz      9078: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9079:        to be added to the XML catalog.  These come in groups of three
                   9080:        strings; see xmlcatmgr(1) for more information (specifically,
                   9081:        arguments recognized by the 'add' action).  Note that you will
                   9082:        normally not use this variable.</p></li>
1.75      rillig   9083: </ol></div>
                   9084: </div>
1.148     asau     9085: <div class="sect2">
1.75      rillig   9086: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9087: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9088: <p>If a package provides extensions to the MIME database by
1.87      wiz      9089:     installing <code class="filename">.xml</code> files inside
                   9090:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9091:     need to take some extra steps to ensure that the database is kept
                   9092:     consistent with respect to these new files:</p>
1.128     wiz      9093: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9094: <li class="listitem"><p>Include
1.87      wiz      9095:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9096:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9097:        this same directory, which is reserved for inclusion from
                   9098:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9099:        care of rebuilding the MIME database at installation and
                   9100:        deinstallation time, and disallows any access to it directly
                   9101:        from the package.</p></li>
1.128     wiz      9102: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9103:        <code class="filename">share/mime</code> directory,
                   9104:        <span class="emphasis"><em>except</em></span> for files saved under
                   9105:        <code class="filename">share/mime/packages</code>.  The former are
                   9106:        handled automatically by
                   9107:        the update-mime-database program, but the latter are
                   9108:        package-dependent and must be removed by the package that
                   9109:        installed them in the first place.</p></li>
1.128     wiz      9110: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9111:        from the PLIST.  They will be handled by the shared-mime-info
                   9112:        package.</p></li>
1.75      rillig   9113: </ol></div>
                   9114: </div>
1.148     asau     9115: <div class="sect2">
1.75      rillig   9116: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9117: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9118: <p>If a package uses intltool during its build, add
                   9119:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9120:     which forces it to use the intltool package provided by pkgsrc,
                   9121:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9122: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9123:     latest available version; this way, the package benefits of any
                   9124:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9125: </div>
1.148     asau     9126: <div class="sect2">
1.75      rillig   9127: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9128: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9129: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9130:     the startup directory by default, but you can enable it, by adding
                   9131:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9132:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9133:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9134:     it will automatically remove the scripts when the package is
                   9135:     deinstalled.</p>
1.75      rillig   9136: </div>
1.148     asau     9137: <div class="sect2">
1.75      rillig   9138: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9139: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9140: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9141:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9142:     updated.</p>
1.148     asau     9143: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9144: <h3 class="title">Note</h3>
1.125     wiz      9145: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9146:     packages should install files
1.125     wiz      9147:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9148:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9149: </div>
1.128     wiz      9150: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9151: <li class="listitem"><p>Include
1.125     wiz      9152:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9153:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9154:       database at installation and deinstallation time.</p></li>
1.128     wiz      9155: <li class="listitem">
1.75      rillig   9156: <p>If your package installs files into a texmf
1.87      wiz      9157:       tree other than the one
1.125     wiz      9158:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9159:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9160:       trees that need database update.</p>
1.75      rillig   9161: <p>If your package also installs font map files that need
1.110     hubertf  9162:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9163:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9164:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9165:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9166:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9167:       be run automatically at installation/deinstallation to
                   9168:       enable/disable font map files for TeX output
                   9169:       drivers.</p>
1.75      rillig   9170: </li>
1.128     wiz      9171: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9172:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9173:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9174: </ol></div>
                   9175: </div>
1.148     asau     9176: <div class="sect2">
1.85      jmmv     9177: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9178: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      9179:     emulation</h3></div></div></div>
                   9180: <p>There are some packages that provide libraries and
                   9181:     executables for running binaries from a one operating system
                   9182:     on a different one (if the latter supports it).  One example
                   9183:     is running Linux binaries on NetBSD.</p>
1.189     snj      9184: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      9185:     helps in extracting and packaging Linux rpm packages.</p>
                   9186: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9187:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9188:     if all libraries for each installed executable can be found by
                   9189:     the dynamic linker.  Since the standard dynamic linker is run,
                   9190:     this fails for emulation packages, because the libraries used
                   9191:     by the emulation are not in the standard directories.</p>
                   9192: </div>
1.148     asau     9193: <div class="sect2">
1.87      wiz      9194: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9195: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9196: <p>If a package installs images under the
1.87      wiz      9197:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9198:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9199:     database, you need to take some extra steps to make sure that the
                   9200:     shared theme directory is handled appropriately and that the cache
                   9201:     database is rebuilt:</p>
1.128     wiz      9202: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9203: <li class="listitem"><p>Include
1.87      wiz      9204:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128     wiz      9205: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87      wiz      9206:        entry that refers to the theme cache.</p></li>
1.128     wiz      9207: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85      jmmv     9208:          directories from the <code class="filename">share/icons/hicolor</code>
                   9209:          hierarchy because they will be handled automatically.</p></li>
                   9210: </ol></div>
                   9211: <p>The best way to verify that the PLIST is correct with
                   9212:       respect to the last two points is to regenerate it using
1.110     hubertf  9213:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     9214: </div>
1.148     asau     9215: <div class="sect2">
1.85      jmmv     9216: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9217: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9218: <p>If a package installs <code class="filename">.desktop</code> files
                   9219:       under <code class="filename">share/applications</code> and these include
1.159     rodent   9220:       MIME information (MimeType key), you need to take extra steps to
                   9221:       ensure that they are registered into the MIME database:</p>
1.128     wiz      9222: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9223: <li class="listitem"><p>Include
1.85      jmmv     9224:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128     wiz      9225: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85      jmmv     9226:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9227:          It will be handled automatically.</p></li>
                   9228: </ol></div>
                   9229: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  9230:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     9231:       print-PLIST</strong></span>.</p>
1.75      rillig   9232: </div>
                   9233: </div>
1.148     asau     9234: <div class="sect1">
1.87      wiz      9235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9236: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9237: <p>In some cases one does not have the time to solve a problem
1.125     wiz      9238:   immediately. In this case, one can plainly mark a package as broken.  For
                   9239:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9240:   reason why the package is broken (similar to the
                   9241:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9242:   the package will immediately be shown this message, and the build
                   9243:   will not be even tried.</p>
                   9244: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87      wiz      9245:   intervals.</p>
                   9246: </div>
1.75      rillig   9247: </div>
1.148     asau     9248: <div class="chapter">
1.75      rillig   9249: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9250: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      9251: <p>To check out all the gotchas when building a package, here are
                   9252:   the steps that I do in order to get a package working.  Please note
                   9253:   this is basically the same as what was explained in the previous
                   9254:   sections, only with some debugging aids.</p>
1.148     asau     9255: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9256: <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>
                   9257: <li class="listitem">
1.189     snj      9258: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88      wiz      9259:       create a directory for a new package, change into it, then run
1.110     hubertf  9260:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   9261: <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>
                   9262: <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>
                   9263: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9264: </li>
1.128     wiz      9265: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9266: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   9267: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   9268: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9269:       configure step to the package's
                   9270:       <code class="filename">Makefile</code>.</p></li>
1.128     wiz      9271: <li class="listitem">
1.75      rillig   9272: <p>Make the package compile, doing multiple rounds of</p>
                   9273: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9274: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9275: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9276: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9277: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9278: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9279: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9280: <p>Doing this step as non-root user will ensure that no files
                   9281:       are modified that shouldn't be, especially during the build
1.110     hubertf  9282:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9283:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.189     snj      9284:       from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88      wiz      9285:       package.</p>
1.75      rillig   9286: </li>
1.128     wiz      9287: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   9288:       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>
                   9289: <li class="listitem">
1.76      rillig   9290: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9291: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9292: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9293: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9294: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9295: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9296: <p>You usually need to be <code class="username">root</code> to do
                   9297:       this.  Look if there are any files left:</p>
1.75      rillig   9298: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9299: <p>If this reveals any files that are missing in
1.88      wiz      9300:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9301: </li>
1.128     wiz      9302: <li class="listitem">
1.88      wiz      9303: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9304:       package again and make a binary package:</p>
1.75      rillig   9305: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9306: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9307: </li>
1.128     wiz      9308: <li class="listitem">
1.75      rillig   9309: <p>Delete the installed package:</p>
1.88      wiz      9310: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75      rillig   9311: </li>
1.128     wiz      9312: <li class="listitem">
1.110     hubertf  9313: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      9314:       command, which shouldn't find anything now:</p>
1.75      rillig   9315: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9316: </li>
1.128     wiz      9317: <li class="listitem">
1.75      rillig   9318: <p>Reinstall the binary package:</p>
1.93      rillig   9319: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75      rillig   9320: </li>
1.128     wiz      9321: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   9322: <li class="listitem">
1.189     snj      9323: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88      wiz      9324:       reports:</p>
1.75      rillig   9325: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9326: </li>
1.128     wiz      9327: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.75      rillig   9328: </ul></div>
                   9329: </div>
1.148     asau     9330: <div class="chapter">
1.75      rillig   9331: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9332: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   9333: <div class="toc">
                   9334: <p><b>Table of Contents</b></p>
1.210     leot     9335: <dl class="toc">
1.106     rillig   9336: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9337: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9338: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140     wiz      9339: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig   9340: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     9341: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   9342: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9343: </dl>
                   9344: </div>
1.148     asau     9345: <div class="sect1">
1.75      rillig   9346: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9347: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9348: <p>Our policy is that we accept binaries only from pkgsrc
                   9349:        developers to guarantee that the packages don't contain any
                   9350:        trojan horses etc. This is not to annoy anyone but rather to
                   9351:        protect our users! You're still free to put up your home-made
                   9352:        binary packages and tell the world where to get them. NetBSD
                   9353:        developers doing bulk builds and wanting to upload them please
1.174     asau     9354:        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
                   9355: builds)</i></a>.</p>
1.75      rillig   9356: </div>
1.148     asau     9357: <div class="sect1">
1.75      rillig   9358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9359: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9360: <p>First, check that your package is complete, compiles and
1.110     hubertf  9361:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.189     snj      9362:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   9363:        archive that contains all files that make up the package.
1.87      wiz      9364:        Finally, send this package to the pkgsrc bug tracking system,
1.189     snj      9365:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      9366:        that, go to the web page
1.110     hubertf  9367:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124     snj      9368:        which contains some instructions and a link to a form where you
                   9369:        can submit packages.  The
1.189     snj      9370:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124     snj      9371:        also available as a substitute for either of the above two tools.
                   9372:        </p>
1.87      wiz      9373: <p>In the form of the problem report, the category should be
1.128     wiz      9374:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      9375:        and version number, and the description field should contain a
                   9376:        short description of your package (contents of the COMMENT
                   9377:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      9378:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   9379: <p>If you want to submit several packages, please send a
                   9380:        separate PR for each one, it's easier for us to track things
                   9381:        that way.</p>
                   9382: <p>Alternatively, you can also import new packages into
1.128     wiz      9383:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.215     wiz      9384:        homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.75      rillig   9385:        for details.</p>
                   9386: </div>
1.148     asau     9387: <div class="sect1">
1.75      rillig   9388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9389: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9390: <p>Please note all package additions, updates, moves, and
1.93      rillig   9391:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9392:        important to keep this file up to date and conforming to the
                   9393:        existing format, because it will be used by scripts to
1.110     hubertf  9394:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9395:        sites. Additionally, check the
1.76      rillig   9396:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9397:        for the package you updated or removed, in case it was mentioned
                   9398:        there.</p>
                   9399: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9400:        bumped, the change should appear in
1.93      rillig   9401:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9402:        related or otherwise relevant. Mass bumps that result from a
                   9403:        dependency being updated should not be mentioned. In all other
                   9404:        cases it's the developer's decision.</p>
                   9405: <p>There is a make target that helps in creating proper
1.110     hubertf  9406:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9407:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9408:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9409:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9410:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9411:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9412:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9413:   For new packages, or package moves or removals, set the
                   9414:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9415:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9416:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      9417:   not the same as your NetBSD login name. The target also automatically
                   9418:   removes possibly existing entries for the package in the
                   9419:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     9420:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 9421:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      9422:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9423:   makes the cvs commands use the main repository.
                   9424:   </p>
1.75      rillig   9425: </div>
1.148     asau     9426: <div class="sect1">
1.75      rillig   9427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140     wiz      9428: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      9429: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      9430:   access to the pkgsrc repository.</p>
                   9431: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9432: Start by adding the directory and then files in the directory. Don't
                   9433: forget to add the new package to the category's
                   9434: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9435: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9436: <pre class="programlisting">
                   9437: <code class="prompt">$</code> cd .../pkgsrc/category
                   9438: <code class="prompt">$</code> cvs add pkgname
                   9439: <code class="prompt">$</code> cd pkgname
                   9440: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9441: <code class="prompt">$</code> cvs add patches/p*
                   9442: <code class="prompt">$</code> cvs status | less
1.141     wiz      9443: <code class="prompt">$</code> cvs commit
1.140     wiz      9444: <code class="prompt">$</code> cd ..
                   9445: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      9446: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     9447: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  9448: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      9449: </pre>
1.87      wiz      9450: <p>The commit message of the initial import should include part of the
1.76      rillig   9451:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9452:   what the package is/does.</p>
1.140     wiz      9453: <p>Also mention the new package in
                   9454: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9455: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9456: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   9457: </div>
1.148     asau     9458: <div class="sect1">
1.75      rillig   9459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9460: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9461: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9462:   changes between old and new versions into the commit log when updating
1.87      wiz      9463:   a package. There are various reasons for this:</p>
1.148     asau     9464: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9465: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      9466:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      9467: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      9468:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      9469: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   9470:   repository is very useful for people who read the pkgsrc-changes mailing
                   9471:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9472:   the package.</p></li>
1.75      rillig   9473: </ul></div>
1.87      wiz      9474: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9475:   has been released, it should not automatically be upgraded in the CVS
                   9476:   repository.  We prefer to be conservative in the packages that are
                   9477:   included in pkgsrc - development or beta packages are not really the
                   9478:   best thing for most places in which pkgsrc is used. Please use your
                   9479:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9480:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9481: </div>
1.148     asau     9482: <div class="sect1">
1.75      rillig   9483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122     reed     9484: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
                   9485: <p>Renaming packages is not recommended.</p>
                   9486: <p>When renaming packages, be sure to fix any references to old name
                   9487:   in other Makefiles, options, buildlink files, etc.</p>
                   9488: <p>Also When renaming a package, please define
                   9489:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   9490:   pattern(s) of the previous package name.
                   9491:   This may be repeated for multiple renames.
                   9492:   The new package would be an exact replacement.
                   9493: </p>
1.128     wiz      9494: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     9495:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9496:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9497:   not be an exact replacement but is a suggestion for the replaced
                   9498:   functionality.</p>
                   9499: </div>
1.148     asau     9500: <div class="sect1">
1.122     reed     9501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9502: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
                   9503: <p>It is preferred that packages are not renamed or moved, but if needed
                   9504:   please follow these steps.
                   9505: </p>
1.128     wiz      9506: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9507: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9508: <li class="listitem">
1.75      rillig   9509: <p>Remove all CVS dirs.</p>
1.87      wiz      9510: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9511: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87      wiz      9512: <p>and use that for further work.</p>
1.75      rillig   9513: </li>
1.128     wiz      9514: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9515: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9516: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9517: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     9518: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9519: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9520: for doing an update using pkgsrc building; for example, it can
1.189     snj      9521: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     9522: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9523: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9524: it may have multiple matches, so the tool should also check on the
                   9525: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9526: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9527: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      9528: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9529: place.</p></li>
1.128     wiz      9530: <li class="listitem">
1.75      rillig   9531: <p>Check if any package depends on it:
                   9532: </p>
                   9533: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9534: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9535: </li>
1.128     wiz      9536: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9537: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9538: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9539: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9540: <li class="listitem">
1.75      rillig   9541: <p>Commit the changed and removed files:</p>
                   9542: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87      wiz      9543: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9544: </li>
                   9545: </ol></div>
                   9546: </div>
                   9547: </div>
1.148     asau     9548: <div class="chapter">
1.75      rillig   9549: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9550: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9551: <p>This section contains the answers to questions that may
                   9552:        arise when you are writing a package. If you don't find your
                   9553:        question answered here, first have a look in the other chapters,
                   9554:        and if you still don't have the answer, ask on the
                   9555:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     9556: <div class="qandaset">
1.218   ! rillig   9557: <a name="idm83229600"></a><dl>
1.106     rillig   9558: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9559:        MAKEFLAGS, .MAKEFLAGS and
                   9560:        MAKE_FLAGS?</a>
                   9561: </dt>
1.106     rillig   9562: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9563:        MAKE, GMAKE and
                   9564:        MAKE_PROGRAM?</a>
                   9565: </dt>
1.106     rillig   9566: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9567:        CC, PKG_CC and
                   9568:        PKGSRC_COMPILER?</a>
                   9569: </dt>
1.106     rillig   9570: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9571:        BUILDLINK_LDFLAGS,
                   9572:        BUILDLINK_LDADD and
                   9573:        BUILDLINK_LIBS?</a>
                   9574: </dt>
1.106     rillig   9575: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9576:        VARNAME=BUILDLINK_PREFIX.foo
                   9577:        say it's empty?</a>
                   9578: </dt>
1.106     rillig   9579: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9580:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9581:        don't understand the := inside
                   9582:        it.</a>
                   9583: </dt>
1.106     rillig   9584: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9585:        developers?</a>
                   9586: </dt>
1.106     rillig   9587: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9588:        documentation?</a>
                   9589: </dt>
1.106     rillig   9590: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   9591: do?</a>
                   9592: </dt>
1.75      rillig   9593: </dl>
1.148     asau     9594: <table border="0" style="width: 100%;">
                   9595: <colgroup>
1.75      rillig   9596: <col align="left" width="1%">
1.128     wiz      9597: <col>
1.148     asau     9598: </colgroup>
1.75      rillig   9599: <tbody>
1.148     asau     9600: <tr class="question">
1.75      rillig   9601: <td align="left" valign="top">
1.218   ! rillig   9602: <a name="devfaq.makeflags"></a><a name="idm83229216"></a><p><b>22.1.</b></p>
1.75      rillig   9603: </td>
                   9604: <td align="left" valign="top"><p>What is the difference between
                   9605:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9606:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9607: </tr>
                   9608: <tr class="answer">
1.91      rillig   9609: <td align="left" valign="top"></td>
1.75      rillig   9610: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.189     snj      9611:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   9612:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9613:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9614:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9615: </tr>
1.148     asau     9616: <tr class="question">
1.75      rillig   9617: <td align="left" valign="top">
1.218   ! rillig   9618: <a name="devfaq.make"></a><a name="idm83225248"></a><p><b>22.2.</b></p>
1.75      rillig   9619: </td>
                   9620: <td align="left" valign="top"><p>What is the difference between
                   9621:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9622:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9623: </tr>
                   9624: <tr class="answer">
1.91      rillig   9625: <td align="left" valign="top"></td>
1.75      rillig   9626: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.189     snj      9627:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   9628:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9629:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9630:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9631:        Make program that is used for building the
                   9632:        package.</p></td>
                   9633: </tr>
1.148     asau     9634: <tr class="question">
1.75      rillig   9635: <td align="left" valign="top">
1.218   ! rillig   9636: <a name="devfaq.cc"></a><a name="idm83220768"></a><p><b>22.3.</b></p>
1.75      rillig   9637: </td>
                   9638: <td align="left" valign="top"><p>What is the difference between
                   9639:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9640:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9641: </tr>
                   9642: <tr class="answer">
1.91      rillig   9643: <td align="left" valign="top"></td>
1.75      rillig   9644: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9645:        compiler, which can be configured by the pkgsrc user.
                   9646:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9647:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9648:        path to a compiler, but the type of compiler that should be
1.76      rillig   9649:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9650:        information about the latter variable.</p></td>
                   9651: </tr>
1.148     asau     9652: <tr class="question">
1.75      rillig   9653: <td align="left" valign="top">
1.218   ! rillig   9654: <a name="devfaq.bl3flags"></a><a name="idm83216672"></a><p><b>22.4.</b></p>
1.75      rillig   9655: </td>
                   9656: <td align="left" valign="top"><p>What is the difference between
                   9657:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9658:        <code class="varname">BUILDLINK_LDADD</code> and
                   9659:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9660: </tr>
                   9661: <tr class="answer">
1.91      rillig   9662: <td align="left" valign="top"></td>
1.75      rillig   9663: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9664: </tr>
1.148     asau     9665: <tr class="question">
1.75      rillig   9666: <td align="left" valign="top">
1.218   ! rillig   9667: <a name="devfaq.bl3prefix"></a><a name="idm83214368"></a><p><b>22.5.</b></p>
1.75      rillig   9668: </td>
1.110     hubertf  9669: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   9670:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9671:        say it's empty?</p></td>
                   9672: </tr>
                   9673: <tr class="answer">
1.91      rillig   9674: <td align="left" valign="top"></td>
1.75      rillig   9675: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      9676:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9677:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  9678:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   9679:        command.</p></td>
                   9680: </tr>
1.148     asau     9681: <tr class="question">
1.78      rillig   9682: <td align="left" valign="top">
1.218   ! rillig   9683: <a name="devfaq.master_sites"></a><a name="idm83211296"></a><p><b>22.6.</b></p>
1.78      rillig   9684: </td>
                   9685: <td align="left" valign="top"><p>What does
                   9686:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9687:        don't understand the <code class="literal">:=</code> inside
                   9688:        it.</p></td>
                   9689: </tr>
                   9690: <tr class="answer">
1.91      rillig   9691: <td align="left" valign="top"></td>
1.78      rillig   9692: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9693:        assignment operator, like you might expect at first sight.
                   9694:        Instead, it is a degenerate form of
                   9695:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.189     snj      9696:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78      rillig   9697:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9698:        case of <code class="varname">MASTER_SITE_*</code>,
                   9699:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9700:        <em class="replaceable"><code>new_string</code></em> is
                   9701:        <code class="literal">package/</code>. That's where the
                   9702:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9703:        together.</p></td>
                   9704: </tr>
1.148     asau     9705: <tr class="question">
1.78      rillig   9706: <td align="left" valign="top">
1.218   ! rillig   9707: <a name="devfaq.mailinglists"></a><a name="idm83203232"></a><p><b>22.7.</b></p>
1.78      rillig   9708: </td>
                   9709: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9710:        developers?</p></td>
                   9711: </tr>
                   9712: <tr class="answer">
1.91      rillig   9713: <td align="left" valign="top"></td>
1.148     asau     9714: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110     hubertf  9715: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78      rillig   9716: <dd><p>This is a list for technical discussions related
                   9717:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9718:        pkgsrc infrastructure, proposed new features, questions related
                   9719:        to porting pkgsrc to a new platform, advice for maintaining a
                   9720:        package, patches that affect many packages, help requests moved
                   9721:        from pkgsrc-users when an infrastructure bug is found,
                   9722:        etc.</p></dd>
1.110     hubertf  9723: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78      rillig   9724: <dd><p>All bug reports in category "pkg" sent with
1.189     snj      9725:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   9726:        directly; use one of the other mailing
                   9727:        lists.</p></dd>
                   9728: </dl></div></td>
                   9729: </tr>
1.148     asau     9730: <tr class="question">
1.80      rillig   9731: <td align="left" valign="top">
1.218   ! rillig   9732: <a name="devfaq.documentation"></a><a name="idm83199392"></a><p><b>22.8.</b></p>
1.80      rillig   9733: </td>
                   9734: <td align="left" valign="top"><p>Where is the pkgsrc
                   9735:        documentation?</p></td>
                   9736: </tr>
                   9737: <tr class="answer">
1.91      rillig   9738: <td align="left" valign="top"></td>
1.80      rillig   9739: <td align="left" valign="top">
                   9740: <p>There are many places where you can find
                   9741:        documentation about pkgsrc:</p>
1.148     asau     9742: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9743: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   9744:        of chapters that explain large parts of pkgsrc, but some
                   9745:        chapters tend to be outdated. Which ones they are is hard to
                   9746:        say.</p></li>
1.128     wiz      9747: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.80      rillig   9748:        about certain features, announcements of new parts of the pkgsrc
                   9749:        infrastructure and sometimes even announcements that a certain
                   9750:        feature has been marked as obsolete. The benefit here is that
                   9751:        each message has a date appended to it.</p></li>
1.128     wiz      9752: <li class="listitem"><p>Many of the files in the
1.80      rillig   9753:        <code class="filename">mk/</code> directory start with a comment that
                   9754:        describes the purpose of the file and how it can be used by the
1.92      rillig   9755:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9756:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9757:        help</strong></span>.</p></li>
1.128     wiz      9758: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   9759:        information, but they tend to be highly abbreviated, especially
                   9760:        for actions that occur often. Some contain a detailed
                   9761:        description of what has changed, but they are geared towards the
                   9762:        other pkgsrc developers, not towards an average pkgsrc user.
                   9763:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9764:        don't know what has been before, these messages may not be worth
                   9765:        too much to you.</p></li>
1.128     wiz      9766: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9767:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   9768:        mind of the developer who wrote the code. To get this
1.110     hubertf  9769:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9770:        to see who has written it and ask on the
                   9771:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9772:        find your questions later (see above). To be sure that the
                   9773:        developer in charge reads the mail, you may CC him or
                   9774:        her.</p></li>
                   9775: </ul></div>
                   9776: </td>
                   9777: </tr>
1.148     asau     9778: <tr class="question">
1.92      rillig   9779: <td align="left" valign="top">
1.218   ! rillig   9780: <a name="devfaq.too-much-time"></a><a name="idm83192992"></a><p><b>22.9.</b></p>
1.92      rillig   9781: </td>
                   9782: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9783: do?</p></td>
                   9784: </tr>
                   9785: <tr class="answer">
                   9786: <td align="left" valign="top"></td>
                   9787: <td align="left" valign="top">
1.93      rillig   9788: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9789: anyway.</p>
1.148     asau     9790: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9791: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.189     snj      9792:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package).  It
1.92      rillig   9793:     will tell you about newer versions of installed packages that are
                   9794:     available, but not yet updated in pkgsrc.</p></li>
1.128     wiz      9795: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126     jakllsch 9796:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   9797:     cleanups and enhancements for pkgsrc that would be nice to
                   9798:     have.</p></li>
1.128     wiz      9799: <li class="listitem"><p>Review packages for which review was requested on
1.180     wiz      9800:     the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92      rillig   9801:     mailing list.</p></li>
                   9802: </ul></div>
                   9803: </td>
                   9804: </tr>
1.75      rillig   9805: </tbody>
                   9806: </table>
                   9807: </div>
                   9808: </div>
1.148     asau     9809: <div class="chapter">
1.85      jmmv     9810: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9811: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9812: <div class="toc">
                   9813: <p><b>Table of Contents</b></p>
1.210     leot     9814: <dl class="toc">
1.106     rillig   9815: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9816: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9817: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9818: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     9819: </dl>
                   9820: </div>
1.110     hubertf  9821: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9822: site</a>:</p>
                   9823: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9824:   environment, an intuitive and attractive desktop for users, and the
                   9825:   GNOME development platform, an extensive framework for building
                   9826:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9827: <p>pkgsrc provides a seamless way to automatically build and install
                   9828: a complete GNOME environment <span class="emphasis"><em>under many different
                   9829: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9830: the most advanced build and packaging systems for GNOME due to its
                   9831: included technologies buildlink3, the wrappers and tools framework and
                   9832: automatic configuration file management.  Lots of efforts are put into
                   9833: achieving a completely clean deinstallation of installed software
                   9834: components.</p>
1.110     hubertf  9835: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9836: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9837: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9838: pkgsrc as its preferred packaging system, contributing lots of
                   9839: portability fixes to make GNOME build and install under it.</p>
                   9840: <p>This chapter is aimed at pkgsrc developers and other people
                   9841: interested in helping our GNOME porting and packaging efforts.  It
                   9842: provides instructions on how to manage the existing packages and some
                   9843: important information regarding their internals.</p>
1.148     asau     9844: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85      jmmv     9845: <h3 class="title">We need your help!</h3>
                   9846: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9847:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9848:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9849:   work</a> list!  There is still a long way to go to get a
                   9850:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9851:   achieve it!</p>
                   9852: </div>
1.148     asau     9853: <div class="sect1">
1.85      jmmv     9854: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9855: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     9856: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148     asau     9857: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      9858: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.85      jmmv     9859:     the core GNOME desktop environment.  It only includes the necessary
                   9860:     bits to get it to boot correctly, although it may lack important
                   9861:     functionality for daily operation.  The idea behind this package is
                   9862:     to let end users build their own configurations on top of this one,
                   9863:     first installing this meta package to achieve a functional setup and
                   9864:     then adding individual applications.</p></li>
1.189     snj      9865: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.85      jmmv     9866:     complete installation of the GNOME platform and desktop as defined
                   9867:     by the GNOME project; this is based on the components distributed in
                   9868:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9869:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9870:     official FTP server.  Developer-only tools found in those
                   9871:     directories are not installed unless required by some other
                   9872:     component to work properly.  Similarly, packages from the bindings
                   9873:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9874:     in unless required as a dependency for an end-user component.  This
1.189     snj      9875:     package "extends" <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
                   9876: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.85      jmmv     9877:     Installs all the tools required to build a GNOME component when
                   9878:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9879:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9880: </ul></div>
                   9881: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9882: sorted in a way that eases updates: a package may depend on other
                   9883: packages listed before it but not on any listed after it.  It is very
                   9884: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9885: change it to alphabetical sorting!</em></span></p>
                   9886: </div>
1.148     asau     9887: <div class="sect1">
1.85      jmmv     9888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9889: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9890: <p>Almost all GNOME applications are written in C and use a common
                   9891: set of tools as their build system.  Things get different with the new
                   9892: bindings to other languages (such as Python), but the following will
                   9893: give you a general idea on the minimum required tools:</p>
1.148     asau     9894: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9895: <li class="listitem">
1.85      jmmv     9896: <p>Almost all GNOME applications use the GNU Autotools as their
                   9897:     build system.  As a general rule you will need to tell this to your
                   9898:     package:</p>
1.100     rillig   9899: <pre class="programlisting">
                   9900: GNU_CONFIGURE=yes
1.85      jmmv     9901: USE_LIBTOOL=yes
1.100     rillig   9902: USE_TOOLS+=gmake
                   9903: </pre>
1.85      jmmv     9904: </li>
1.128     wiz      9905: <li class="listitem">
1.85      jmmv     9906: <p>If the package uses pkg-config to detect dependencies, add this
                   9907:     tool to the list of required utilities:</p>
                   9908: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.189     snj      9909: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85      jmmv     9910:     the end of the build process to ensure that you did not miss to
                   9911:     specify any dependency in your package and that the version
                   9912:     requirements are all correct.</p>
                   9913: </li>
1.128     wiz      9914: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93      rillig   9915:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9916:     to handle dependencies and to force the package to use the latest
                   9917:     available version.</p></li>
1.128     wiz      9918: <li class="listitem">
1.85      jmmv     9919: <p>If the package uses gtk-doc (a documentation generation
                   9920:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9921:     tool is rather big and the distfile should come with pregenerated
                   9922:     documentation anyway; if it does not, it is a bug that you ought to
                   9923:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9924:     the default):</p>
                   9925: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9926: <p>The default location of installed HTML files
                   9927:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9928:     and should not be changed unless the package insists on installing
                   9929:     them somewhere else.  Otherwise programs as
1.110     hubertf  9930:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   9931:     do that with an entry similar to:</p>
                   9932: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     9933: </li>
                   9934: </ul></div>
                   9935: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9936: files under the installation prefix to maintain databases.  In this
                   9937: context, shared means that those exact same directories and files are
                   9938: used among several different packages, leading to conflicts in the
                   9939: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9940: handle the most common cases, so you have to forget about using
                   9941: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9942: omitting shared files from them.  If you find yourself doing those,
                   9943: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9944: <p>The following table lists the common situations that result in
                   9945: using shared directories or files.  For each of them, the appropriate
                   9946: solution is given.  After applying the solution be sure to
                   9947: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  9948: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     9949: <div class="table">
1.106     rillig   9950: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.216     tnn      9951: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9952: <colgroup>
                   9953: <col>
                   9954: <col>
                   9955: </colgroup>
                   9956: <thead><tr>
                   9957: <th>If the package...</th>
                   9958: <th>Then...</th>
                   9959: </tr></thead>
                   9960: <tbody>
                   9961: <tr>
                   9962: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119     mishka   9963: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, &#8220;Packages installing scrollkeeper/rarian data files&#8221;</a>.</td>
1.85      jmmv     9964: </tr>
                   9965: <tr>
                   9966: <td>Installs icons under the
                   9967:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9968:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  9969: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.85      jmmv     9970: </tr>
                   9971: <tr>
                   9972: <td>Installs files under
                   9973:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  9974: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.85      jmmv     9975: </tr>
                   9976: <tr>
                   9977: <td>Installs <code class="filename">.desktop</code> files under
                   9978:         <code class="filename">share/applications</code> and these include MIME
                   9979:         information.</td>
1.110     hubertf  9980: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.85      jmmv     9981: </tr>
                   9982: </tbody>
1.91      rillig   9983: </table></div>
1.85      jmmv     9984: </div>
1.91      rillig   9985: <br class="table-break">
1.85      jmmv     9986: </div>
1.148     asau     9987: <div class="sect1">
1.85      jmmv     9988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9989: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9990: <p>When seeing GNOME as a whole, there are two kinds of
                   9991: updates:</p>
1.148     asau     9992: <div class="variablelist"><dl class="variablelist">
1.85      jmmv     9993: <dt><span class="term">Major update</span></dt>
                   9994: <dd>
                   9995: <p>Given that there is still a very long way for GNOME 3 (if it
                   9996:       ever appears), we consider a major update one that goes from a
                   9997:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9998:       where <code class="literal">Y</code> is even and greater than
                   9999:       <code class="literal">X</code>.  These are hard to achieve because they
                   10000:       introduce lots of changes in the components' code and almost all
                   10001:       GNOME distfiles are updated to newer versions.  Some of them can
                   10002:       even break API and ABI compatibility with the previous major
                   10003:       version series.  As a result, the update needs to be done all at
                   10004:       once to minimize breakage.</p>
                   10005: <p>A major update typically consists of around 80 package
                   10006:       updates and the addition of some new ones.</p>
                   10007: </dd>
                   10008: <dt><span class="term">Minor update</span></dt>
                   10009: <dd>
                   10010: <p>We consider a minor update one that goes from a
                   10011:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10012:       one where <code class="literal">Y</code> is greater than
                   10013:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10014:       not update all GNOME components, can be done in an incremental way
                   10015:       and do not break API nor ABI compatibility.</p>
                   10016: <p>A minor update typically consists of around 50 package
                   10017:       updates, although the numbers here may vary a lot.</p>
                   10018: </dd>
                   10019: </dl></div>
                   10020: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10021: release (either major or minor), the following steps should be
                   10022: followed:</p>
1.128     wiz      10023: <div class="orderedlist"><ol class="orderedlist" type="1">
                   10024: <li class="listitem">
1.85      jmmv     10025: <p>Get a list of all the tarballs that form the new release by
                   10026:     using the following commands.  These will leave the full list of the
1.120     snj      10027:     components' distfiles into the <code class="filename">list.txt</code>
1.85      jmmv     10028:     file:</p>
1.88      wiz      10029: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10030:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10031:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      10032: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10033:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10034:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10035: </li>
1.128     wiz      10036: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85      jmmv     10037:     bump their version to the release you are updating them to.  The
                   10038:     three meta packages should be always consistent with versioning.
                   10039:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10040:     in them.</p></li>
1.128     wiz      10041: <li class="listitem">
1.85      jmmv     10042: <p>For each meta package, update all its
                   10043:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10044:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10045:     newer version (even if found in the FTP) because the meta packages
                   10046:     are supposed to list the exact versions that form a specific GNOME
                   10047:     release.  Exceptions are permitted here if a newer version solves a
                   10048:     serious issue in the overall desktop experience; these typically
                   10049:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10050:     from the developers.</p>
                   10051: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10052:     should be updated to the latest version available (if found in
                   10053:     pkgsrc).  This is the case, for example, of the dependencies on the
1.189     snj      10054:     GNU Autotools in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.85      jmmv     10055: </li>
1.128     wiz      10056: <li class="listitem">
1.85      jmmv     10057: <p>Generate a patch from the modified meta packages and extract the
                   10058:     list of "new" lines.  This will provide you an outline on what
                   10059:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   10060: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' &gt;todo.txt</code></strong></pre>
1.85      jmmv     10061: </li>
1.128     wiz      10062: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85      jmmv     10063:     installed packages and start over from scratch at this point.</p></li>
1.128     wiz      10064: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85      jmmv     10065:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10066:     it in order.  For major desktop updates none of these should be
1.93      rillig   10067:     committed until the entire set is completed because there are chances
1.85      jmmv     10068:     of breaking not-yet-updated packages.</p></li>
1.128     wiz      10069: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85      jmmv     10070:     the tree one by one with appropriate log messages.  At the end,
                   10071:     commit the three meta package updates and all the corresponding
                   10072:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10073:     <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>
                   10074: </ol></div>
                   10075: </div>
1.148     asau     10076: <div class="sect1">
1.85      jmmv     10077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10078: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     10079: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10080: packages.  Please, it is very important that you always, always,
                   10081: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  10082: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.85      jmmv     10083: their attention on portability issues and to ensure that future versions
                   10084: can be built out-of-the box on NetBSD.  The less custom patches in
                   10085: pkgsrc, the easier further updates are.  Those developers in charge of
                   10086: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  10087: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85      jmmv     10088: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10089: of them do.  Do not be short on your reports: always provide detailed
                   10090: explanations of the current failure, how it can be improved to achieve
                   10091: maximum portability and, if at all possible, provide a patch against CVS
                   10092: head.  The more verbose you are, the higher chances of your patch being
                   10093: accepted.</p>
                   10094: <p>Also, please avoid using preprocessor magic to fix portability
                   10095: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10096: GNOME to their operating system, the official GNOME sources are now
                   10097: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10098: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  10099: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.85      jmmv     10100: details.</p>
                   10101: </div>
                   10102: </div>
1.75      rillig   10103: </div>
1.148     asau     10104: <div class="part">
1.75      rillig   10105: <div class="titlepage"><div><div><h1 class="title">
                   10106: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10107: <div class="partintro">
1.75      rillig   10108: <div></div>
                   10109: <p>This part of the guide deals with everything
                   10110:        from the infrastructure that is behind the interfaces described
                   10111:        in the developer's guide. A casual package maintainer should not
                   10112:        need anything from this part.</p>
                   10113: <div class="toc">
                   10114: <p><b>Table of Contents</b></p>
1.210     leot     10115: <dl class="toc">
1.106     rillig   10116: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10117: <dd><dl>
1.106     rillig   10118: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10119: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10120: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   10121: <dd><dl>
1.106     rillig   10122: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10123: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   10124: </dl></dd>
1.106     rillig   10125: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10126: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10127: <dd><dl>
1.106     rillig   10128: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10129: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10130: </dl></dd>
1.106     rillig   10131: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10132: <dd><dl>
1.128     wiz      10133: <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>
                   10134: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10135: </dl></dd>
                   10136: </dl></dd>
1.106     rillig   10137: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   10138: <dd><dl>
1.106     rillig   10139: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10140: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10141: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10142: <dd><dl>
1.106     rillig   10143: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10144: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10145: </dl></dd>
                   10146: </dl></dd>
1.106     rillig   10147: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig   10148: <dd><dl>
1.106     rillig   10149: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10150: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10151: </dl></dd>
                   10152: </dl>
                   10153: </div>
                   10154: </div>
1.148     asau     10155: <div class="chapter">
1.75      rillig   10156: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10157: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10158: <div class="toc">
                   10159: <p><b>Table of Contents</b></p>
1.210     leot     10160: <dl class="toc">
1.106     rillig   10161: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10162: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10163: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   10164: <dd><dl>
1.106     rillig   10165: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10166: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   10167: </dl></dd>
1.106     rillig   10168: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10169: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10170: <dd><dl>
1.106     rillig   10171: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10172: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10173: </dl></dd>
1.106     rillig   10174: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10175: <dd><dl>
1.128     wiz      10176: <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>
                   10177: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10178: </dl></dd>
                   10179: </dl>
                   10180: </div>
                   10181: <p>The pkgsrc infrastructure consists of many small Makefile
                   10182:        fragments. Each such fragment needs a properly specified
                   10183:        interface. This chapter explains how such an interface looks
                   10184:        like.</p>
1.148     asau     10185: <div class="sect1">
1.75      rillig   10186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10187: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10188: <p>Whenever a variable is defined in the pkgsrc
                   10189:        infrastructure, the location and the way of definition provide
                   10190:        much information about the intended use of that variable.
                   10191:        Additionally, more documentation may be found in a header
                   10192:        comment or in this pkgsrc guide.</p>
                   10193: <p>A special file is
                   10194:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10195:        variables that are intended to be user-defined. They are either
                   10196:        defined using the <code class="literal">?=</code> operator or they are
                   10197:        left undefined because defining them to anything would
1.128     wiz      10198:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   10199:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10200:        file.</p>
                   10201: <p>Outside this file, the following conventions apply:
                   10202:        Variables that are defined using the <code class="literal">?=</code>
                   10203:        operator may be overridden by a package.</p>
                   10204: <p>Variables that are defined using the <code class="literal">=</code>
                   10205:        operator may be used read-only at run-time.</p>
                   10206: <p>Variables whose name starts with an underscore must not be
                   10207:        accessed outside the pkgsrc infrastructure at all. They may
                   10208:        change without further notice.</p>
1.148     asau     10209: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10210: <h3 class="title">Note</h3>
                   10211: <p>These conventions are currently not applied
                   10212:        consistently to the complete pkgsrc
                   10213:        infrastructure.</p>
                   10214: </div>
                   10215: </div>
1.148     asau     10216: <div class="sect1">
1.81      rillig   10217: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10218: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10219: <p>All variables that contain lists of things should default
                   10220:        to being empty. Two examples that do not follow this rule are
                   10221:        <code class="varname">USE_LANGUAGES</code> and
                   10222:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10223:        modified using the <code class="literal">+=</code> operator in package
                   10224:        <code class="filename">Makefile</code>s (or other files included by
                   10225:        them), since there is no guarantee whether the variable is
                   10226:        already set or not, and what its value is. In the case of
1.128     wiz      10227:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   10228:        the default value and just define it as in the following
                   10229:        example.</p>
                   10230: <pre class="programlisting">
1.100     rillig   10231: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10232: </pre>
                   10233: <p>Because of the selection of this default value, the same
                   10234:        value appears in many package Makefiles. Similarly for
                   10235:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      10236:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   10237:        doesn't stand out. Nevertheless it is mentioned in many
                   10238:        files.</p>
                   10239: </div>
1.148     asau     10240: <div class="sect1">
1.81      rillig   10241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10242: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148     asau     10243: <div class="sect2">
1.75      rillig   10244: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10245: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   10246: <p>Variable evaluation takes place either at load time or at
                   10247:        runtime, depending on the context in which they occur. The
                   10248:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10249: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10250: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10251:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10252: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10253:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10254: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10255: </ul></div>
                   10256: <p>A special exception are references to the iteration
                   10257:        variables of <code class="literal">.for</code> loops, which are expanded
                   10258:        inline, no matter in which context they appear.</p>
                   10259: <p>As the values of variables may change during load time,
                   10260:        care must be taken not to evaluate them by accident. Typical
                   10261:        examples for variables that should not be evaluated at load time
                   10262:        are <code class="varname">DEPENDS</code> and
                   10263:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10264:        clear, here is an example:</p>
                   10265: <pre class="programlisting">
1.100     rillig   10266: CONFIGURE_ARGS=         # none
                   10267: CFLAGS=                 -O
                   10268: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10269: 
1.100     rillig   10270: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10271: 
1.100     rillig   10272: CFLAGS+=                -Wall
1.75      rillig   10273:        </pre>
                   10274: <p>This code shows how the use of the <code class="literal">:=</code>
                   10275:        operator can quickly lead to unexpected results. The first
                   10276:        paragraph is fairly common code. The second paragraph evaluates
                   10277:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10278:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10279:        <code class="literal">-Wall</code> is appended to the
                   10280:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10281:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10282:        paragraphs from above typically occur in completely unrelated
                   10283:        files.</p>
                   10284: </div>
1.148     asau     10285: <div class="sect2">
1.75      rillig   10286: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10287: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   10288: <p>After all the files have been loaded, the values of the
                   10289:        variables cannot be changed anymore. Variables that are used in
                   10290:        the shell commands are expanded at this point.</p>
                   10291: </div>
                   10292: </div>
1.148     asau     10293: <div class="sect1">
1.75      rillig   10294: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10295: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10296: <p>There are many ways in which the definition and use of a
1.218   ! rillig   10297:        variable can be restricted in order to detect bugs and violations
        !          10298:        of the (mostly unwritten) policies. A package can be checked with
        !          10299:        <code class="literal">pkglint -Wall</code> to see whether it meets these
        !          10300:        rules.</p>
1.78      rillig   10301: </div>
1.148     asau     10302: <div class="sect1">
1.78      rillig   10303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10304: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10305: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10306:        of the following classes. Cases where a file falls into more
                   10307:        than one class should be avoided as it often leads to subtle
                   10308:        bugs.</p>
1.148     asau     10309: <div class="sect2">
1.75      rillig   10310: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10311: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10312: <p>In a traditional imperative programming language some of
1.76      rillig   10313:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10314:        procedures. They take some input parameters and&mdash;after
                   10315:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10316:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10317:        care must be taken not to use parameter names that have already
                   10318:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10319:        bad choice for a parameter name.</p>
                   10320: <p>Procedures are completely evaluated at preprocessing time.
                   10321:        That is, when calling a procedure all input parameters must be
                   10322:        completely resolvable. For example,
                   10323:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10324:        parameter since it is very likely that further text will be
                   10325:        added after calling the procedure, which would effectively apply
                   10326:        the procedure to only a part of the variable. Also, references
1.218   ! rillig   10327:        to other variables will be modified after calling the
1.75      rillig   10328:        procedure.</p>
                   10329: <p>A procedure can declare its output parameters either as
                   10330:        suitable for use in preprocessing directives or as only
                   10331:        available at runtime. The latter alternative is for variables
                   10332:        that contain references to other runtime variables.</p>
                   10333: <p>Procedures shall be written such that it is possible to
                   10334:        call the procedure more than once. That is, the file must not
                   10335:        contain multiple-inclusion guards.</p>
                   10336: <p>Examples for procedures are
1.76      rillig   10337:        <code class="filename">mk/bsd.options.mk</code> and
                   10338:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10339:        that the parameters are evaluated at load time, they should be
                   10340:        assigned using the <code class="literal">:=</code> operator, which should
                   10341:        be used only for this purpose.</p>
                   10342: </div>
1.148     asau     10343: <div class="sect2">
1.75      rillig   10344: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10345: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10346: <p>Action files take some input parameters and may define
                   10347:        runtime variables. They shall not define loadtime variables.
                   10348:        There are action files that are included implicitly by the
                   10349:        pkgsrc infrastructure, while other must be included
                   10350:        explicitly.</p>
                   10351: <p>An example for action files is
1.76      rillig   10352:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10353: </div>
                   10354: </div>
1.148     asau     10355: <div class="sect1">
1.81      rillig   10356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10357: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10358: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10359:        a set of variable definitions, and include the file
                   10360:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10361:        Before that, they may also include various other
                   10362:        <code class="filename">*.mk</code> files if they need to query the
                   10363:        availability of certain features like the type of compiler or
                   10364:        the X11 implementation. Due to the heavy use of preprocessor
                   10365:        directives like <code class="literal">.if</code> and
                   10366:        <code class="literal">.for</code>, the order in which the files are loaded
                   10367:        matters.</p>
                   10368: <p>This section describes at which point the various files
                   10369:        are loaded and gives reasons for that order.</p>
1.148     asau     10370: <div class="sect2">
1.81      rillig   10371: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10372: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10373: </h3></div></div></div>
                   10374: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10375:        is to define some essential variables like
                   10376:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10377:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10378: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10379:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104     rillig   10380:        After that, those variables
1.81      rillig   10381:        that have not been overridden by the user are loaded from
                   10382:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10383: <p>After the user settings, the system settings and platform
                   10384:        settings are loaded, which may override the user
                   10385:        settings.</p>
                   10386: <p>Then, the tool definitions are loaded. The tool wrappers
                   10387:        are not yet in effect. This only happens when building a
                   10388:        package, so the proper variables must be used instead of the
                   10389:        direct tool names.</p>
                   10390: <p>As the last steps, some essential variables from the
                   10391:        wrapper and the package system flavor are loaded, as well as the
                   10392:        variables that have been cached in earlier phases of a package
                   10393:        build.</p>
                   10394: </div>
1.148     asau     10395: <div class="sect2">
1.81      rillig   10396: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10397: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10398: </h3></div></div></div>
1.81      rillig   10399: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10400: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10401:        loaded, which fill default values for those variables that have
1.93      rillig   10402:        not been defined by the package. These variables may later
1.81      rillig   10403:        be used even in unrelated files.</p>
                   10404: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10405:        provides the target <code class="literal">error-check</code> that is added
                   10406:        as a special dependency to all other targets that use
                   10407:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10408:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10409: <p>Then, the package-specific hacks from
                   10410:        <code class="filename">hacks.mk</code> are included.</p>
                   10411: <p>Then, various other files follow. Most of them don't have
                   10412:        any dependencies on what they need to have included before or
                   10413:        after them, though some do.</p>
                   10414: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10415:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10416:        restricts the use of these variables to all the files that have
                   10417:        been included before. Appearances in later files will be
                   10418:        silently ignored.</p>
                   10419: <p>Then, the files for the main targets are included, in the
                   10420:        order of later execution, though the actual order should not
                   10421:        matter.</p>
                   10422: <p>At last, some more files are included that don't set any
                   10423:        interesting variables but rather just define make targets to be
                   10424:        executed.</p>
                   10425: </div>
                   10426: </div>
1.75      rillig   10427: </div>
1.148     asau     10428: <div class="chapter">
1.75      rillig   10429: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10430: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   10431: <div class="toc">
                   10432: <p><b>Table of Contents</b></p>
1.210     leot     10433: <dl class="toc">
1.106     rillig   10434: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10435: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10436: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10437: <dd><dl>
1.106     rillig   10438: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10439: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10440: </dl></dd>
                   10441: </dl>
                   10442: </div>
                   10443: <p>The pkgsrc infrastructure consists of a large codebase,
                   10444:        and there are many corners where every little bit of a file is
                   10445:        well thought out, making pkgsrc likely to fail as soon as
                   10446:        anything is changed near those parts. To prevent most changes
                   10447:        from breaking anything, a suite of regression tests should go
                   10448:        along with every important part of the pkgsrc infrastructure.
                   10449:        This chapter describes how regression tests work in pkgsrc and
                   10450:        how you can add new tests.</p>
1.148     asau     10451: <div class="sect1">
1.75      rillig   10452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10453: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10454: <p></p>
                   10455: </div>
1.148     asau     10456: <div class="sect1">
1.75      rillig   10457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10458: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.189     snj      10459: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  10460:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10461:        can simply run that command, which will run all tests in the
1.76      rillig   10462:        <code class="filename">regress</code> category.</p>
1.75      rillig   10463: </div>
1.148     asau     10464: <div class="sect1">
1.75      rillig   10465: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10466: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10467: <p>Every directory in the <code class="filename">regress</code>
                   10468:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10469:        is considered a regression test. This file is a shell program
1.110     hubertf  10470:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10471:        The following functions can be overridden to suit your
                   10472:        needs.</p>
1.148     asau     10473: <div class="sect2">
1.75      rillig   10474: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10475: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.218   ! rillig   10476: <p>These functions do not take any parameters. Although they
        !          10477:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
        !          10478:        first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
        !          10479:        question</a> for details.</p>
1.148     asau     10480: <div class="variablelist"><dl class="variablelist">
1.218   ! rillig   10481: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   10482: <dd><p>This function prepares the environment for the
                   10483:        test. By default it does nothing.</p></dd>
1.218   ! rillig   10484: <dt><span class="term"><code class="varname">do_test</code></span></dt>
        !          10485: <dd>
        !          10486: <p>This function runs the actual test. By default,
1.75      rillig   10487:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10488:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10489:        error messages into the file
1.218   ! rillig   10490:        <code class="varname">TEST_OUTFILE</code>.</p>
        !          10491: <p>When defining this function, make sure that all output that
        !          10492:        needs to be checked is written to the correct output file.
        !          10493:        Example:</p>
        !          10494: <pre class="programlisting">
        !          10495: do_test() {
        !          10496:        echo "Example output"
        !          10497: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
        !          10498: </pre>
        !          10499: </dd>
        !          10500: <dt><span class="term"><code class="varname">check_result</code></span></dt>
        !          10501: <dd>
        !          10502: <p>This function is run after the test and is
1.75      rillig   10503:        typically used to compare the actual output from the one that is
                   10504:        expected. It can make use of the various helper functions from
1.218   ! rillig   10505:        the next section. Example:</p>
        !          10506: <pre class="programlisting">
        !          10507: check_result() {
        !          10508:        exit_status 0
        !          10509:        output_require "Example"
        !          10510:        output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
        !          10511:        output_prohibit "no such file or directory"
        !          10512: }
        !          10513: </pre>
        !          10514: </dd>
        !          10515: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   10516: <dd><p>This function cleans everything up after the
                   10517:        test has been run. By default it does nothing.</p></dd>
                   10518: </dl></div>
                   10519: </div>
1.148     asau     10520: <div class="sect2">
1.75      rillig   10521: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10522: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148     asau     10523: <div class="variablelist"><dl class="variablelist">
1.218   ! rillig   10524: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   10525: <dd><p>This function compares the exitcode of the
1.218   ! rillig   10526:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   10527:        If they differ, the test will fail.</p></dd>
1.218   ! rillig   10528: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
        !          10529: <dd>
        !          10530: <p>This function checks for each of its parameters
        !          10531:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   10532:        extended regular expression. If it does not, the test will
1.218   ! rillig   10533:        fail. Example:</p>
        !          10534: <pre class="programlisting">
        !          10535: output_require 
        !          10536: </pre>
        !          10537: </dd>
1.75      rillig   10538: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10539: <dd><p>This function checks for each of its parameters
1.110     hubertf  10540:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10541:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10542:        If any of the regular expressions matches, the test will
                   10543:        fail.</p></dd>
                   10544: </dl></div>
                   10545: </div>
                   10546: </div>
                   10547: </div>
1.148     asau     10548: <div class="chapter">
1.75      rillig   10549: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10550: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10551: <div class="toc">
                   10552: <p><b>Table of Contents</b></p>
1.210     leot     10553: <dl class="toc">
1.106     rillig   10554: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10555: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10556: </dl>
                   10557: </div>
                   10558: <p>The pkgsrc system has already been ported to many
                   10559:        operating systems, hardware architectures and compilers. This
                   10560:        chapter explains the necessary steps to make pkgsrc even more
                   10561:        portable.</p>
1.148     asau     10562: <div class="sect1">
1.75      rillig   10563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10564: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10565: <p>To port pkgsrc to a new operating system (called
                   10566:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10567:        following files:</p>
1.148     asau     10568: <div class="variablelist"><dl class="variablelist">
1.93      rillig   10569: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75      rillig   10570: <dd><p>This file contains some basic definitions, for
                   10571:        example the name of the C
                   10572:        compiler.</p></dd>
1.76      rillig   10573: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10574: <dd><p>Insert code that defines the variables
                   10575:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10576:        <code class="varname">LOWER_OS_VERSION</code>,
                   10577:        <code class="varname">LOWER_VENDOR</code>,
                   10578:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10579:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10580:        appear in this file.</p></dd>
1.93      rillig   10581: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10582: <dd><p>This file contains the platform-specific
                   10583:        definitions that are used by pkgsrc. Start by copying one of the
                   10584:        other files and edit it to your
                   10585:        needs.</p></dd>
1.93      rillig   10586: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10587: <dd><p>This file defines the paths to all the tools
                   10588:        that are needed by one or the other package in pkgsrc, as well
                   10589:        as by pkgsrc itself. Find out where these tools are on your
                   10590:        platform and add them.</p></dd>
                   10591: </dl></div>
                   10592: <p>Now, you should be able to build some basic packages, like
1.189     snj      10593:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   10594: </div>
1.148     asau     10595: <div class="sect1">
1.75      rillig   10596: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10597: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10598: <p>TODO</p>
                   10599: </div>
                   10600: </div>
                   10601: </div>
1.148     asau     10602: <div class="appendix">
                   10603: <div class="titlepage"><div><div><h1 class="title">
                   10604: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   10605: <div class="toc">
                   10606: <p><b>Table of Contents</b></p>
1.210     leot     10607: <dl class="toc">
1.75      rillig   10608: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10609: <dd><dl>
                   10610: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10611: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10612: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz      10613: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75      rillig   10614: </dl></dd>
                   10615: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10616: </dl>
                   10617: </div>
                   10618: <p>We checked to find a piece of software that wasn't in the packages
                   10619:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10620:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10621:     present in the tree is beyond us, but it's useful for the purposes of
                   10622:     this exercise.</p>
1.148     asau     10623: <div class="sect1">
1.75      rillig   10624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10625: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     10626: <div class="sect2">
1.75      rillig   10627: <div class="titlepage"><div><div><h3 class="title">
                   10628: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10629: <pre class="programlisting">
1.100     rillig   10630: # $NetBSD$
                   10631: #
1.1       grant    10632: 
1.100     rillig   10633: DISTNAME=       bison-1.25
                   10634: CATEGORIES=     devel
                   10635: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10636: 
1.136     dholland 10637: MAINTAINER=     pkgsrc-users@NetBSD.org
1.100     rillig   10638: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10639: COMMENT=        GNU yacc clone
1.1       grant    10640: 
1.100     rillig   10641: GNU_CONFIGURE=  yes
1.152     wiz      10642: INFO_FILES=     yes
1.1       grant    10643: 
1.100     rillig   10644: .include "../../mk/bsd.pkg.mk"
1.1       grant    10645: </pre>
1.75      rillig   10646: </div>
1.148     asau     10647: <div class="sect2">
1.75      rillig   10648: <div class="titlepage"><div><div><h3 class="title">
                   10649: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10650: <pre class="programlisting">
1.100     rillig   10651: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.189     snj      10652: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10653: of the NetBSD source tree is beyond me.
1.1       grant    10654: </pre>
1.75      rillig   10655: </div>
1.148     asau     10656: <div class="sect2">
1.75      rillig   10657: <div class="titlepage"><div><div><h3 class="title">
                   10658: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10659: <pre class="programlisting">
1.100     rillig   10660: @comment $NetBSD$
                   10661: bin/bison
                   10662: man/man1/bison.1.gz
                   10663: share/bison.simple
                   10664: share/bison.hairy
1.1       grant    10665: </pre>
1.75      rillig   10666: </div>
1.148     asau     10667: <div class="sect2">
1.75      rillig   10668: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  10669: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   10670: </h3></div></div></div>
1.75      rillig   10671: <p>The NetBSD package system comes with
1.189     snj      10672:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   10673:        which helps to check the contents of these
                   10674:        files. After installation it is quite easy to use, just change to the
                   10675:        directory of the package you wish to examine and execute
1.110     hubertf  10676:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10677: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10678: looks fine.</pre>
                   10679: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  10680:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   10681:        -Wall</strong></span> for a very thorough check.</p>
                   10682: </div>
                   10683: </div>
1.148     asau     10684: <div class="sect1">
1.75      rillig   10685: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10686: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10687: <p>Create the directory where the package lives,
                   10688:       plus any auxiliary directories:</p>
                   10689: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10690: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10691: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10692: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10693: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  10694:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   10695:       then continue with fetching the distfile:</p>
                   10696: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10697: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10698: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10699: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10700: ftp: Error retrieving file: 500 Internal error
                   10701: 
                   10702: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10703: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10704: ftp: Error retrieving file: 500 Internal error
                   10705: 
                   10706: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10707: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10708: Successfully retrieved file.</pre>
                   10709: <p>Generate the checksum of the distfile into
1.76      rillig   10710:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10711: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10712: <p>Now compile:</p>
                   10713: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10714: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10715: ===&gt;  Extracting for bison-1.25
                   10716: ===&gt;  Patching for bison-1.25
                   10717: ===&gt;   Ignoring empty patch directory
                   10718: ===&gt;  Configuring for bison-1.25
                   10719: creating cache ./config.cache
                   10720: checking for gcc... cc
                   10721: checking whether we are using GNU C... yes
                   10722: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10723: checking how to run the C preprocessor... cc -E
                   10724: checking for minix/config.h... no
                   10725: checking for POSIXized ISC... no
                   10726: checking whether cross-compiling... no
                   10727: checking for ANSI C header files... yes
                   10728: checking for string.h... yes
                   10729: checking for stdlib.h... yes
                   10730: checking for memory.h... yes
                   10731: checking for working const... yes
                   10732: checking for working alloca.h... no
                   10733: checking for alloca... yes
                   10734: checking for strerror... yes
                   10735: updating cache ./config.cache
                   10736: creating ./config.status
                   10737: creating Makefile
                   10738: ===&gt;  Building for bison-1.25
                   10739: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g LR0.c
                   10740: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g allocate.c
                   10741: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g closure.c
                   10742: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g conflicts.c
                   10743: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g derives.c
1.68      rillig   10744: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\"  -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1  -g  ./files.c
1.1       grant    10745: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getargs.c
                   10746: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g gram.c
                   10747: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g lalr.c
                   10748: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g lex.c
                   10749: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g main.c
                   10750: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g nullable.c
                   10751: 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
                   10752: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g print.c
                   10753: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g reader.c
                   10754: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g reduce.c
                   10755: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g symtab.c
                   10756: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g warshall.c
                   10757: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g version.c
                   10758: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt.c
                   10759: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt1.c
                   10760: 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
                   10761: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10762: rm -f bison.s1
1.75      rillig   10763: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10764: <p>Everything seems OK, so install the files:</p>
                   10765: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10766: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10767: ===&gt;  Installing for bison-1.25
                   10768: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10769: rm -f /usr/pkg/bin/bison
                   10770: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10771: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10772: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10773: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10774: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10775: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10776: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10777: ===&gt;  Registering installation for bison-1.25</pre>
                   10778: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10779:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10780:       binary package, do this now:</p>
                   10781: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10782: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10783: ===&gt;  Building package for bison-1.25
                   10784: Creating package bison-1.25.tgz
                   10785: Registering depends:.
1.75      rillig   10786: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10787: <p>Now that you don't need the source and object files
                   10788:       any more, clean up:</p>
                   10789: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10790: ===&gt;  Cleaning for bison-1.25</pre>
                   10791: </div>
                   10792: </div>
1.148     asau     10793: <div class="appendix">
                   10794: <div class="titlepage"><div><div><h1 class="title">
                   10795: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   10796: <div class="toc">
                   10797: <p><b>Table of Contents</b></p>
1.210     leot     10798: <dl class="toc">
1.75      rillig   10799: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10800: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10801: </dl>
                   10802: </div>
1.148     asau     10803: <div class="sect1">
1.75      rillig   10804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10805: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10806: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10807: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10808: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10809: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10810: =&gt; [172219 bytes]
                   10811: Connected to ftp.plig.net.
                   10812: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10813: 331 Guest login ok, send your complete e-mail address as password.
                   10814: 230-You are user #5 of 500 simultaneous users allowed.
                   10815: 230-
1.68      rillig   10816: 230-  ___ _             _ _
                   10817: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10818: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10819: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10820: 230-         |_|   |_|     |___|         |___|
                   10821: 230-
                   10822: 230-** Welcome to ftp.plig.org **
                   10823: 230-
                   10824: 230-Please note that all transfers from this FTP site are logged. If you
                   10825: 230-do not like this, please disconnect now.
                   10826: 230-
1.120     snj      10827: 230-This archive is available via
1.1       grant    10828: 230-
                   10829: 230-HTTP:  http://ftp.plig.org/
                   10830: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10831: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10832: 230-
                   10833: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10834: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10835: 230-
                   10836: 230-
                   10837: 230 Logged in anonymously.
                   10838: Remote system type is UNIX.
                   10839: Using binary mode to transfer files.
                   10840: 200 Type okay.
                   10841: 250 "/pub" is new cwd.
                   10842: 250-"/pub/figlet" is new cwd.
                   10843: 250-
                   10844: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10845: 250-
1.75      rillig   10846: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10847: 250-
                   10848: 250-The official FIGlet web page is:
1.75      rillig   10849: 250-   http://www.figlet.org/
1.1       grant    10850: 250-
                   10851: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10852: 250-contribute a font or something else, you can email us.
1.68      rillig   10853: 250
1.1       grant    10854: 250 "/pub/figlet/program" is new cwd.
                   10855: 250 "/pub/figlet/program/unix" is new cwd.
                   10856: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10857: 502 Unimplemented command.
                   10858: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10859: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10860: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10861: 226 Transfer completed.
                   10862: 172219 bytes received in 00:02 (75.99 KB/s)
                   10863: 221 Goodbye.
                   10864: =&gt; Checksum OK for figlet221.tar.gz.
                   10865: ===&gt; Extracting for figlet-2.2.1nb2
                   10866: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10867: ===&gt; Patching for figlet-2.2.1nb2
                   10868: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10869: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10870: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10871: ===&gt; Configuring for figlet-2.2.1nb2
                   10872: ===&gt; Building for figlet-2.2.1nb2
                   10873: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10874: chmod a+x figlet
                   10875: gcc -O2 -o chkfont chkfont.c
                   10876: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10877: <code class="prompt">#</code>
1.75      rillig   10878: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10879: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10880: ===&gt; Installing for figlet-2.2.1nb2
                   10881: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10882: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10883: mkdir -p /usr/pkg/share/figlet
                   10884: cp figlet /usr/pkg/bin
                   10885: cp chkfont /usr/pkg/bin
                   10886: chmod 555 figlist showfigfonts
                   10887: cp figlist /usr/pkg/bin
                   10888: cp showfigfonts /usr/pkg/bin
                   10889: cp fonts/*.flf /usr/pkg/share/figlet
                   10890: cp fonts/*.flc /usr/pkg/share/figlet
                   10891: cp figlet.6 /usr/pkg/man/man6
                   10892: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10893: <code class="prompt">#</code></pre>
                   10894: </div>
1.148     asau     10895: <div class="sect1">
1.75      rillig   10896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10897: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10898: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10899: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10900: ===&gt; Packaging figlet-2.2.1nb2
                   10901: ===&gt; Building binary package for figlet-2.2.1nb2
                   10902: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10903: Using SrcDir value of /usr/pkg
1.68      rillig   10904: Registering depends:.
1.75      rillig   10905: <code class="prompt">#</code></pre>
                   10906: </div>
                   10907: </div>
1.148     asau     10908: <div class="appendix">
                   10909: <div class="titlepage"><div><div><h1 class="title">
                   10910: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   10911: <div class="toc">
                   10912: <p><b>Table of Contents</b></p>
1.210     leot     10913: <dl class="toc">
1.128     wiz      10914: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10915: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10916: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10917: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10918: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                   10919: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10920: source packages</a></span></dt>
                   10921: </dl>
                   10922: </div>
                   10923: <p>As in other big projects, the directory layout of pkgsrc
                   10924:        is quite complex for newbies. This chapter explains where you
                   10925:        find things on the FTP server. The base directory on
1.110     hubertf  10926:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89      rillig   10927:        On other servers it may be different, but inside this directory,
                   10928:        everything should look the same, no matter on which server you
                   10929:        are. This directory contains some subdirectories, which are
                   10930:        explained below.</p>
1.148     asau     10931: <div class="sect1">
1.76      rillig   10932: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10933: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   10934: <p>The directory <code class="filename">distfiles</code> contains lots
                   10935:        of archive files from all pkgsrc packages, which are mirrored
                   10936:        here. The subdirectories are called after their package names
                   10937:        and are used when the distributed files have names that don't
                   10938:        explicitly contain a version number or are otherwise too generic
                   10939:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10940: </div>
1.148     asau     10941: <div class="sect1">
1.76      rillig   10942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10943: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   10944: <p>This directory contains things that individual pkgsrc
                   10945:        developers find worth publishing.</p>
                   10946: </div>
1.148     asau     10947: <div class="sect1">
1.76      rillig   10948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10949: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   10950: <p>This directory contains binary packages for the various
                   10951:        platforms that are supported by pkgsrc.
                   10952:        Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.148     asau     10953: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10954: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   10955:        operating system for which the packages have been built. The
1.110     hubertf  10956:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   10957:        command, so it may differ from the one you are used to
                   10958:        hear.</p></li>
1.128     wiz      10959: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   10960:        architecture of the platform for which the packages have been
1.110     hubertf  10961:        built. It also includes the <code class="varname">ABI</code> (Application
                   10962:        Binary Interface) for platforms that have several of
                   10963:        them.</p></li>
1.128     wiz      10964: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   10965:        the operating system. For version numbers that change often (for
                   10966:        example NetBSD-current), the often-changing part should be
                   10967:        replaced with an <code class="literal">x</code>, for example
                   10968:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      10969: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 10970:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   10971:        for a stable branch, or <code class="literal">head</code> for packages
                   10972:        built from the HEAD branch. The latter should only be used when
                   10973:        the packages are updated on a regular basis. Otherwise the date
                   10974:        from checking out pkgsrc should be appended, for example
                   10975:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   10976: </ul></div>
                   10977: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10978:        can quickly click through the directories on the
                   10979:        server and find the best binary packages for their machines. Since they
                   10980:        usually know the operating system and the hardware architecture, OPSYS
                   10981:        and ARCH are placed first. After these choices, they can select the
                   10982:        best combination of OSVERSION and TAG together, since it is usually the
                   10983:        case that packages stay compatible between different version of the
                   10984:        operating system.</p>
                   10985: <p>In each of these directories, there is a
                   10986:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   10987:        <code class="filename">All</code> which contains all binary packages.
                   10988:        Besides that, there are various category directories that
                   10989:        contain symbolic links to the real binary packages.</p>
                   10990: </div>
1.148     asau     10991: <div class="sect1">
1.76      rillig   10992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10993: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   10994: <p>Here are the reports from bulk builds, for those who want
                   10995:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      10996:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.108     rillig   10997: </div>
1.148     asau     10998: <div class="sect1">
1.108     rillig   10999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11000: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
                   11001: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11002: source packages</h2></div></div></div>
1.128     wiz      11003: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   11004:        that is the files that define how to create binary packages from
                   11005:        source archives.</p>
                   11006: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   11007:        snapshot of the CVS repository, which is updated regularly. The
                   11008:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   11009:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   11010: <p>In the directories for the quarterly branches, there is an
                   11011:        additional file called
1.126     jakllsch 11012:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.76      rillig   11013:        which contains the state of pkgsrc when it was branched.</p>
                   11014: </div>
1.75      rillig   11015: </div>
1.148     asau     11016: <div class="appendix">
                   11017: <div class="titlepage"><div><div><h1 class="title">
                   11018: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   11019: <div class="toc">
                   11020: <p><b>Table of Contents</b></p>
1.210     leot     11021: <dl class="toc">
1.79      rillig   11022: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   11023: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   11024: </dl>
                   11025: </div>
1.79      rillig   11026: <p>This section contains information on editing the pkgsrc
                   11027:        guide itself.</p>
1.148     asau     11028: <div class="sect1">
1.75      rillig   11029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   11030: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11031: <p>The pkgsrc guide's source code is stored in
                   11032:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11033:        are created from it:</p>
1.148     asau     11034: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      11035: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11036: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   11037: <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>
                   11038: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79      rillig   11039:        The PDF version of the pkgsrc guide.</p></li>
1.128     wiz      11040: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79      rillig   11041:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   11042: </ul></div>
                   11043: </div>
1.148     asau     11044: <div class="sect1">
1.75      rillig   11045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11046: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   11047: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      11048: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     11049: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      11050:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   11051:        documentation) installed. These are automatically installed when
1.189     snj      11052:        you install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148     asau     11053: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   11054:        right directory. All further steps will take place
                   11055:        here.</p></li>
1.148     asau     11056: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   11057:        <code class="filename">files/</code>.</p></li>
1.148     asau     11058: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   11059:        guide for valid XML and to build the final output files. If you
                   11060:        get any errors at this stage, you can just edit the files, as
                   11061:        there are only symbolic links in the working directory, pointing
                   11062:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     11063: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   11064:        commit)</strong></span></p></li>
1.148     asau     11065: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   11066:        regenerate the output files with the proper RCS
                   11067:        Ids.</p></li>
1.148     asau     11068: <li class="step">
1.110     hubertf  11069: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   11070:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11071:        <code class="filename">htdocs</code>.</p>
1.148     asau     11072: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   11073: <h3 class="title">Note</h3>
                   11074: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  11075:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11076:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   11077:        directory.</p>
                   11078: </div>
                   11079: </li>
1.79      rillig   11080: </ol></div>
1.75      rillig   11081: </div>
                   11082: </div>
                   11083: </div></body>
1.1       grant    11084: </html>

CVSweb <webmaster@jp.NetBSD.org>