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

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>
1.220     wiz        34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.30 2016/06/11 18:14:42 rillig 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>
1.75      rillig     80: </dl></dd>
                     81: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     82: <dd><dl>
                     83: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     84: <dd><dl>
                     85: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     86: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig     87: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     88: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                     89: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                     90: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                     91: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75      rillig     92: </dl></dd>
                     93: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                     94: <dd><dl>
                     95: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                     96: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                     97: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                     98: </dl></dd>
                     99: </dl></dd>
                    100: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    101: <dd><dl>
                    102: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    103: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    104: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       105: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       106: <dd><dl>
1.103     wiz       107: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz       108: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    109: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       110: </dl></dd>
1.103     wiz       111: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    112: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    113: </dl></dd>
                    114: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    115: <dd><dl>
                    116: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    117: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    118: </dl></dd>
                    119: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    120: builds)</a></span></dt>
1.75      rillig    121: <dd><dl>
1.180     wiz       122: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                    123: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                    124: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                    125: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau      126: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    127: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig    128: </dl></dd>
                    129: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    130: <dd><dl>
1.128     wiz       131: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    132: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106     rillig    133: </dl></dd>
                    134: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    135: <dd><dl>
                    136: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194     bsiegert  137: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                    138: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                    139: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    140: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    141: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                    142: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                    143: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                    144: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    145: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       146: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert  147: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                    148: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    149: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    150: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    151: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    152: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    153: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    154: </dl></dd>
                    155: </dl></dd>
                    156: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    157: <dd><dl>
1.106     rillig    158: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    159: <dd><dl>
1.106     rillig    160: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig    161: <dd><dl>
1.106     rillig    162: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174     asau      163: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118     imil      164: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig    165: </dl></dd>
1.106     rillig    166: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    167: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    168: </dl></dd>
                    169: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    170: <dd><dl>
1.128     wiz       171: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                    172: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219     rillig    173: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig    174: <dd><dl>
                    175: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    176: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    177: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    178: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    179: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    180: </dl></dd>
                    181: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    182: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    183: <dd><dl>
                    184: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    185: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    186: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    187: </dl></dd>
1.128     wiz       188: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                    189: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    190: </dl></dd>
1.128     wiz       191: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    192: <dd><dl>
                    193: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz       194: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig    195: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    196: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    197: <dd><dl>
                    198: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228     yyamano   199: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220     wiz       200: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                    201: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig    202: </dl></dd>
                    203: </dl></dd>
                    204: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    205: <dd><dl>
                    206: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz       207: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    208: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106     rillig    209: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    210: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz       211: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig    212: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz       213: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                    214: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106     rillig    215: </dl></dd>
                    216: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    217: <dd><dl>
                    218: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz       219: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    220: <dd><dl>
                    221: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz       222: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                    223:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    224:       and
                    225:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    226:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    227: </dl></dd>
1.128     wiz       228: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig    229: <dd><dl>
1.128     wiz       230: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106     rillig    231: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    232: </dl></dd>
                    233: </dl></dd>
                    234: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    235: <dd><dl>
                    236: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    237: <dd><dl>
                    238: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    239: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    240: </dl></dd>
                    241: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    242: <dd><dl>
1.128     wiz       243: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig    244: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    245: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    246: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    247: </dl></dd>
                    248: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    249: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    250: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    251: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    252: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    253: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    254: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                    255: </dl></dd>
                    256: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    257: <dd><dl>
                    258: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz       259: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106     rillig    260: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig    261: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    262: </dl></dd>
                    263: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    264: <dd><dl>
                    265: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    266: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    267: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    268: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz       269: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    270: <dd><dl>
                    271: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    272: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    273: </dl></dd>
1.128     wiz       274: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    275: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    276: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    277: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    278: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    279: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    280: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    281: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    282: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    283: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig    284: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    286: </dl></dd>
                    287: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    288: <dd><dl>
                    289: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    290: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    291: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    292: </dl></dd>
                    293: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    294: <dd><dl>
                    295: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    296: <dd><dl>
1.218     rillig    297: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    298: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                    299: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                    300: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                    301: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                    302: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                    303: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                    304: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    305: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                    306: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    307: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.106     rillig    308: </dl></dd>
1.218     rillig    309: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    310: <dd><dl>
                    311: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    312: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
1.199     tnn       313: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig    314: </dl></dd>
1.218     rillig    315: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig    316: <dd><dl>
                    317: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    318: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    319: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    320: </dl></dd>
                    321: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    322: <dd><dl>
                    323: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    324: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    325: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz       326: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                    327: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig    328: </dl></dd>
1.218     rillig    329: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig    330: <dd><dl>
                    331: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    332: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz       333: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.106     rillig    334: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    335: </dl></dd>
1.218     rillig    336: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig    337: <dd><dl>
                    338: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    339: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    340: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    341: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    342: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    343: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    344: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    345: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig    346: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka    347: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig    348: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    349: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    350: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    351: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    352: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    353: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    354: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    355: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz       356:     emulation</a></span></dt>
1.106     rillig    357: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    358: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    359: </dl></dd>
1.106     rillig    360: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig    361: </dl></dd>
1.106     rillig    362: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    363: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig    364: <dd><dl>
1.106     rillig    365: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    366: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    367: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140     wiz       368: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig    369: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed      370: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                    371: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig    372: </dl></dd>
                    373: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    374: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    375: <dd><dl>
                    376: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    377: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    378: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    379: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv      380: </dl></dd>
1.75      rillig    381: </dl></dd>
                    382: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    383: <dd><dl>
1.106     rillig    384: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    385: <dd><dl>
1.106     rillig    386: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    387: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    388: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig    389: <dd><dl>
1.106     rillig    390: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    391: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig    392: </dl></dd>
1.106     rillig    393: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    394: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    395: <dd><dl>
1.106     rillig    396: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    397: <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    398: </dl></dd>
1.106     rillig    399: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig    400: <dd><dl>
1.128     wiz       401: <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>
                    402: <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    403: </dl></dd>
                    404: </dl></dd>
1.106     rillig    405: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig    406: <dd><dl>
1.219     rillig    407: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
                    408: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75      rillig    409: <dd><dl>
1.219     rillig    410: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
                    411: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75      rillig    412: </dl></dd>
                    413: </dl></dd>
1.106     rillig    414: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.219     rillig    415: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig    416: </dl></dd>
                    417: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    418: <dd><dl>
                    419: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    420: <dd><dl>
                    421: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    422: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    423: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz       424: <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    425: </dl></dd>
                    426: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    427: </dl></dd>
                    428: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    429: <dd><dl>
                    430: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    431: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    432: </dl></dd>
1.76      rillig    433: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    434: <dd><dl>
1.128     wiz       435: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    436: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    437: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    438: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    439: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                    440: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    441: source packages</a></span></dt>
                    442: </dl></dd>
1.75      rillig    443: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    444: <dd><dl>
1.79      rillig    445: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    446: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    447: </dl></dd>
                    448: </dl>
                    449: </div>
1.82      rillig    450: <div class="list-of-tables">
                    451: <p><b>List of Tables</b></p>
                    452: <dl>
                    453: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    454: </dt>
1.106     rillig    455: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      456: </dt>
1.106     rillig    457: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      458: </dt>
1.82      rillig    459: </dl>
                    460: </div>
1.148     asau      461: <div class="chapter">
                    462: <div class="titlepage"><div><div><h1 class="title">
                    463: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    464: <div class="toc">
                    465: <p><b>Table of Contents</b></p>
1.210     leot      466: <dl class="toc">
1.75      rillig    467: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    468: <dd><dl>
                    469: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    470: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    471: </dl></dd>
1.75      rillig    472: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    473: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       474: <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    475: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    476: </dl>
                    477: </div>
1.148     asau      478: <div class="sect1">
1.75      rillig    479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    480: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    481: <p>There is a lot of software freely available for Unix-based
                    482: systems, which is usually available in form of the source code. Before
                    483: such software can be used, it needs to be configured to the local
                    484: system, compiled and installed, and this is exactly what The NetBSD
                    485: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    486: to handle binary packages, so that not every user has to build the
                    487: packages for himself, which is a time-costly task.</p>
1.75      rillig    488: <p>pkgsrc currently contains several thousand packages,
                    489:       including:</p>
1.148     asau      490: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.214     sevan     491: <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    492:          web server</p></li>
1.189     snj       493: <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    494:          web browser</p></li>
1.189     snj       495: <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    496:          Desktop Environment</p></li>
1.212     ryoon     497: <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    498:          Desktop Environment</p></li>
                    499: </ul></div>
1.219     rillig    500: <p>&#8230; just to name a few.</p>
1.75      rillig    501: <p>pkgsrc has built-in support for handling varying dependencies,
                    502:       such as pthreads and X11, and extended features such as IPv6 support on
                    503:       a range of platforms.</p>
1.148     asau      504: <div class="sect2">
1.82      rillig    505: <div class="titlepage"><div><div><h3 class="title">
                    506: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    507: <p>
                    508: pkgsrc provides the following key features:
                    509: </p>
1.148     asau      510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       511: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    512:   and installation of binary packages. The source and latest
                    513:   patches are retrieved from a master or mirror download site, checksum
                    514:   verified, then built on your system. Support for binary-only
                    515:   distributions is available for both native platforms and NetBSD
                    516:   emulated platforms.</p></li>
1.128     wiz       517: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    518:   including binaries, libraries, man pages and other
                    519:   documentation.</p></li>
1.214     sevan     520: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    521:   performing updates, to ensure required packages are installed. The
                    522:   configuration files of various packages are handled automatically during
                    523:   updates, so local changes are preserved.</p></li>
1.128     wiz       524: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    525:   consists of highly portable code. This allows the greatest speed of
1.132     spz       526:   development when porting to a new platform. This portability also
1.82      rillig    527:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    528:   platforms</em></span>.</p></li>
1.128     wiz       529: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    530:   international encryption requirements and build-time options for a
                    531:   large number of packages are all set in a simple, central
                    532:   configuration file.</p></li>
1.128     wiz       533: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    534:   freely available under a BSD license, so you may extend and adapt
                    535:   pkgsrc to your needs. Support for local packages and patches is
                    536:   available right out of the box, so you can configure it specifically
                    537:   for your environment.</p></li>
                    538: </ul></div>
1.91      rillig    539: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       541: <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  542: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    543: them and to complain about them rather than to just install the package
                    544: and hope that it works. There are numerous checks in pkgsrc that try to
1.189     snj       545: 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    546: of shell scripts), and post-installation checks (installed files,
                    547: references to shared libraries, script interpreters).</p></li>
1.128     wiz       548: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  549: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    550: pkgsrc has been ported to many operating systems. Care is taken that
                    551: packages behave the same on all platforms.</p></li>
                    552: </ul></div>
1.82      rillig    553: </div>
1.148     asau      554: <div class="sect2">
1.82      rillig    555: <div class="titlepage"><div><div><h3 class="title">
                    556: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    557: <p>pkgsrc consists of both a source distribution and a binary
                    558: distribution for these operating systems. After retrieving the required
                    559: source or binaries, you can be up and running with pkgsrc in just
                    560: minutes!</p>
1.75      rillig    561: <p>pkgsrc was derived from FreeBSD's ports system, and
                    562:       initially developed for NetBSD only. Since then, pkgsrc has
                    563:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    564: <div class="table">
                    565: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       566: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    567: <colgroup>
                    568: <col>
                    569: <col>
1.202     sevan     570: <col>
1.82      rillig    571: </colgroup>
                    572: <thead><tr>
                    573: <th>Platform</th>
                    574: <th>Date Support Added</th>
1.202     sevan     575: <th>Notes</th>
1.82      rillig    576: </tr></thead>
                    577: <tbody>
                    578: <tr>
1.110     hubertf   579: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    580: <td align="center">Aug 1997</td>
1.202     sevan     581: <td class="auto-generated"> </td>
1.82      rillig    582: </tr>
                    583: <tr>
1.110     hubertf   584: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    585: <td align="center">Mar 1999</td>
1.203     sevan     586: <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    587: </tr>
                    588: <tr>
1.110     hubertf   589: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    590: <td align="center">Jun 1999</td>
1.203     sevan     591: <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    592: </tr>
                    593: <tr>
                    594: <td>
1.230     sevan     595:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    596:         </td>
                    597: <td align="center">Oct 2001</td>
1.203     sevan     598: <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    599: </tr>
                    600: <tr>
1.110     hubertf   601: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    602: <td align="center">Nov 2002</td>
1.203     sevan     603: <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    604: </tr>
                    605: <tr>
1.110     hubertf   606: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    607: <td align="center">Nov 2002</td>
1.203     sevan     608: <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    609: </tr>
                    610: <tr>
1.110     hubertf   611: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    612: <td align="center">Dec 2002</td>
1.202     sevan     613: <td>
1.203     sevan     614:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    615:        <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     616:        </td>
1.82      rillig    617: </tr>
                    618: <tr>
                    619: <td>BSD/OS</td>
                    620: <td align="center">Dec 2003</td>
1.202     sevan     621: <td class="auto-generated"> </td>
1.82      rillig    622: </tr>
                    623: <tr>
1.110     hubertf   624: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    625: <td align="center">Dec 2003</td>
1.203     sevan     626: <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    627: </tr>
                    628: <tr>
                    629: <td>
1.110     hubertf   630:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    631:           (Microsoft Windows Services for Unix)
                    632:         </td>
                    633: <td align="center">Mar 2004</td>
1.203     sevan     634: <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    635: </tr>
                    636: <tr>
1.110     hubertf   637: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    638: <td align="center">Oct 2004</td>
1.202     sevan     639: <td class="auto-generated"> </td>
1.82      rillig    640: </tr>
                    641: <tr>
1.110     hubertf   642: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    643: <td align="center">Nov 2004</td>
1.203     sevan     644: <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    645: </tr>
1.98      wiz       646: <tr>
1.110     hubertf   647: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       648: <td align="center">Apr 2007</td>
1.203     sevan     649: <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       650: </tr>
1.128     wiz       651: <tr>
                    652: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    653: <td align="center">Sep 2010</td>
1.203     sevan     654: <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       655: </tr>
1.151     obache    656: <tr>
                    657: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  658: <td align="center">Jan 2011</td>
1.202     sevan     659: <td class="auto-generated"> </td>
1.151     obache    660: </tr>
                    661: <tr>
                    662: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
                    663: <td align="center">Nov 2011</td>
1.203     sevan     664: <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    665: </tr>
                    666: <tr>
                    667: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
                    668: <td align="center">Mar 2013</td>
1.203     sevan     669: <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    670: </tr>
1.166     jnemeth   671: <tr>
                    672: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
                    673: <td align="center">Jul 2013</td>
1.203     sevan     674: <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   675: </tr>
1.214     sevan     676: <tr>
                    677: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
                    678: <td align="center">Jun 2014</td>
                    679: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
                    680: </tr>
1.82      rillig    681: </tbody>
1.91      rillig    682: </table></div>
1.82      rillig    683: </div>
1.91      rillig    684: <br class="table-break">
1.82      rillig    685: </div>
1.75      rillig    686: </div>
1.148     asau      687: <div class="sect1">
1.75      rillig    688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    689: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    690: <p>This document is divided into three parts. The first,
1.110     hubertf   691:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    692:        describes how one can use one of the packages in the Package
                    693:        Collection, either by installing a precompiled binary package,
1.93      rillig    694:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   695:        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    696:        package so it can be easily built by other NetBSD users without
                    697:        knowing about the package's building details. The third part,
1.110     hubertf   698:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    699:        is intended for those who want to understand how pkgsrc is
                    700:        implemented.</p>
                    701: <p>This document is available in various formats:
1.110     hubertf   702:        <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    703: </div>
1.148     asau      704: <div class="sect1">
1.75      rillig    705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    706: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       707: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    708:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    709:       terminology used within this document.</p>
1.148     asau      710: <div class="variablelist"><dl class="variablelist">
1.75      rillig    711: <dt><span class="term">Package</span></dt>
                    712: <dd><p>A set of files and building instructions
                    713:            that describe what's necessary
                    714:            to build a certain piece of software using
                    715:             pkgsrc. Packages are traditionally stored under
1.76      rillig    716:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    717: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       718: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       719:          is part of the NetBSD operating system and can be bootstrapped
                    720:          to run on non-NetBSD operating systems as well.  It handles
                    721:          building (compiling), installing, and removing of
                    722:          packages.</p></dd>
1.75      rillig    723: <dt><span class="term">Distfile</span></dt>
                    724: <dd><p>This term describes the file or files that are
                    725:            provided by the author of the piece of software to
                    726:            distribute his work. All the changes necessary to build on
                    727:            NetBSD are reflected in the corresponding package. Usually
                    728:            the distfile is in the form of a compressed tar-archive,
                    729:            but other types are possible, too. Distfiles are usually
                    730:            stored below
1.76      rillig    731:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    732: <dt><span class="term">Port</span></dt>
                    733: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    734:            for what we call a package.
1.128     wiz       735:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    736:            architecture.</p></dd>
                    737: <dt><span class="term">Precompiled/binary package</span></dt>
                    738: <dd>
                    739: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    740:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    741:            file so it can be installed on machines of the same
                    742:            machine architecture without the need to
                    743:            recompile. Packages are usually generated in
1.76      rillig    744:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       745:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       746: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    747:            especially in the context of precompiled packages.</p>
                    748: </dd>
                    749: <dt><span class="term">Program</span></dt>
1.88      wiz       750: <dd><p>The piece of software to be installed which will be
                    751:          constructed from all the files in the distfile by the
                    752:          actions defined in the corresponding package.</p></dd>
1.75      rillig    753: </dl></div>
1.148     asau      754: <div class="sect2">
1.75      rillig    755: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       756: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      757: <div class="variablelist"><dl class="variablelist">
1.75      rillig    758: <dt><span class="term">pkgsrc users</span></dt>
                    759: <dd>
                    760: <p>The
                    761:        pkgsrc users are people who use the packages provided by pkgsrc.
                    762:        Typically they are system administrators. The people using the
1.128     wiz       763:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    764:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    765: <p>There are two kinds of pkgsrc users: Some only want to
                    766:        install pre-built binary packages. Others build the pkgsrc
                    767:        packages from source, either for installing them directly or for
1.110     hubertf   768:        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    769:        documentation.</p>
                    770: </dd>
                    771: <dt><span class="term">package maintainers</span></dt>
                    772: <dd><p>A
1.110     hubertf   773:        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    774: <dt><span class="term">infrastructure developers</span></dt>
                    775: <dd><p>These people are involved in all those files
1.76      rillig    776:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   777:        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    778:        too.</p></dd>
                    779: </dl></div>
                    780: </div>
                    781: </div>
1.148     asau      782: <div class="sect1">
1.75      rillig    783: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    784: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    785: <p>When giving examples for commands, shell prompts are used to
                    786:       show if the command should/can be issued as root, or if
1.128     wiz       787:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.226     sevan     788:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    789:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    790:       bourne shell and derivatives.</p>
1.75      rillig    791: </div>
                    792: </div>
1.148     asau      793: <div class="part">
1.75      rillig    794: <div class="titlepage"><div><div><h1 class="title">
                    795: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    796: <div class="toc">
                    797: <p><b>Table of Contents</b></p>
1.210     leot      798: <dl class="toc">
1.75      rillig    799: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    800: <dd><dl>
                    801: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    802: <dd><dl>
1.157     asau      803: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       804: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    805: </dl></dd>
                    806: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    807: <dd><dl>
                    808: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    809: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    810: </dl></dd>
                    811: </dl></dd>
                    812: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    813: <dd><dl>
1.82      rillig    814: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    815: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    816: </dl></dd>
                    817: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    818: <dd><dl>
                    819: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    820: <dd><dl>
                    821: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    822: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    823: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    824: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    825: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    826: <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>
                    827: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75      rillig    828: </dl></dd>
                    829: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    830: <dd><dl>
                    831: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    832: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    833: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    834: </dl></dd>
                    835: </dl></dd>
                    836: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    837: <dd><dl>
                    838: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    839: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    840: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       841: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       842: <dd><dl>
1.103     wiz       843: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz       844: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    845: <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       846: </dl></dd>
1.103     wiz       847: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    848: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    849: </dl></dd>
                    850: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    851: <dd><dl>
                    852: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    853: <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    854: </dl></dd>
                    855: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    856: builds)</a></span></dt>
1.75      rillig    857: <dd><dl>
1.180     wiz       858: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                    859: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                    860: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                    861: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau      862: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    863: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig    864: </dl></dd>
                    865: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    866: <dd><dl>
1.128     wiz       867: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    868: <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    869: </dl></dd>
                    870: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    871: <dd><dl>
                    872: <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  873: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                    874: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                    875: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    876: <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>
                    877: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                    878: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                    879: <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>
                    880: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    881: <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       882: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert  883: <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>
                    884: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    885: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    886: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    887: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    888: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    889: <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    890: </dl></dd>
                    891: </dl>
                    892: </div>
1.148     asau      893: <div class="chapter">
1.75      rillig    894: <div class="titlepage"><div><div><h2 class="title">
                    895: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    896: <div class="toc">
                    897: <p><b>Table of Contents</b></p>
1.210     leot      898: <dl class="toc">
1.75      rillig    899: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    900: <dd><dl>
1.157     asau      901: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       902: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    903: </dl></dd>
                    904: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    905: <dd><dl>
                    906: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    907: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    908: </dl></dd>
                    909: </dl>
                    910: </div>
1.91      rillig    911: <p>Before you download and extract the files, you need to decide
                    912: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    913: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    914: free to install the sources and binary packages wherever you want in
                    915: your filesystem, provided that the pathname does not contain white-space
                    916: or other characters that are interpreted specially by the shell and some
                    917: other programs. A safe bet is to use only letters, digits, underscores
                    918: and dashes.</p>
1.148     asau      919: <div class="sect1">
1.75      rillig    920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    921: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    922: <p>Before you download any pkgsrc files, you should decide
                    923:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    924:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    925:        quarterly basis from the current branch and only gets modified
                    926:        for security updates. The names of the stable branches are built
                    927:        from the year and the quarter, for example
1.230     sevan     928:        <code class="literal">2016Q4</code>.</p>
1.75      rillig    929: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz       930:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    931:        Both ways are described here.</p>
1.157     asau      932: <p>Note that tar archive contains CVS working copy.
                    933:        Thus you can switch to using CVS at any later time.</p>
1.148     asau      934: <div class="sect2">
1.75      rillig    935: <div class="titlepage"><div><div><h3 class="title">
1.157     asau      936: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75      rillig    937: <p>The primary download location for all pkgsrc files is
1.157     asau      938:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
                    939:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    940:        (it points to the same location).
                    941:        There are a number of subdirectories for different purposes,
                    942:        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>
                    943: <p>The tar archive for the current branch is in the directory
                    944:        <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.230     sevan     945:        It is autogenerated weekly.</p>
1.157     asau      946: <p>To save download time we provide bzip2- and
                    947:        xz-compressed archives which are published at
                    948:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
                    949:        and
                    950:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
                    951:        respectively.
                    952:        </p>
                    953: <p>You can fetch the same files using FTP.</p>
1.230     sevan     954: <p>The tar file for the stable branch 2016Q4 is in the
                    955:        directory <code class="filename">pkgsrc-2016Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2016Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.112     weinem    956: <p>To download a pkgsrc stable tarball, run:</p>
                    957: <pre class="screen">
1.166     jnemeth   958: <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  959: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112     weinem    960:        stable branch to be downloaded, for example, 
1.230     sevan     961:        <span class="quote">&#8220;<span class="quote">pkgsrc-2016Q4</span>&#8221;</span>.</p>
1.188     snj       962: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau      963:        or your web browser.</p>
1.112     weinem    964: <p>Then, extract it with:</p>
1.188     snj       965: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem    966: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    967:        in <code class="filename">/usr/</code> and all the package source will be 
                    968:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    969: <p>To download pkgsrc-current, run:</p>
                    970: <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    971: </div>
1.148     asau      972: <div class="sect2">
1.75      rillig    973: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz       974: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                    975: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146     wiz       976: <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       977: </pre>
                    978: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
1.230     sevan     979:        branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2016Q4</span>&#8221;</span></p>
1.128     wiz       980: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                    981:        in your <code class="filename">/usr/</code> directory and all the package source 
                    982:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    983: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz       984: <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     985: </pre>
1.188     snj       986: <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       987: <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       988: <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       989: </pre>
                    990: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                    991:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                    992:        or better globally in <code class="filename">/etc/profile</code>:</p>
                    993: <pre class="programlisting">
                    994: # set CVS remote shell command
                    995: CVS_RSH=ssh
                    996: export CVS_RSH
                    997: </pre>
                    998: <p>By default, CVS doesn't do things like most people would expect it to do.
                    999:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1000:        in your home directory and saving the following lines to it.
                   1001:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1002:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1003: <pre class="programlisting">
                   1004: # recommended CVS configuration file from the pkgsrc guide
1.146     wiz      1005: cvs -q -z2
1.101     rillig   1006: checkout -P
1.103     wiz      1007: update -dP
                   1008: diff -upN
1.101     rillig   1009: rdiff -u
1.128     wiz      1010: release -d
1.101     rillig   1011: </pre>
1.75      rillig   1012: </div>
                   1013: </div>
1.148     asau     1014: <div class="sect1">
1.75      rillig   1015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1016: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1017: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1018:        (which also works if you have first installed it via a tar
                   1019:        file). It saves bandwidth and hard disk activity, compared to
                   1020:        downloading the tar file again.</p>
1.148     asau     1021: <div class="sect2">
1.75      rillig   1022: <div class="titlepage"><div><div><h3 class="title">
                   1023: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148     asau     1024: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1025: <h3 class="title">Warning</h3>
1.77      rillig   1026: <p>When updating from a tar file, you first need to
                   1027:        completely remove the old pkgsrc directory. Otherwise those
                   1028:        files that have been removed from pkgsrc in the mean time will
                   1029:        not be removed on your local disk, resulting in inconsistencies.
                   1030:        When removing the old files, any changes that you have done to
                   1031:        the pkgsrc files will be lost after updating. Therefore updating
                   1032:        via CVS is strongly recommended.</p>
1.75      rillig   1033: </div>
1.82      rillig   1034: <p>Note that by default the distfiles and the binary packages
                   1035:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1036:        before updating. You can also configure pkgsrc to store distfiles
                   1037:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1038:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1039:        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   1040: <p>To update pkgsrc from a tar file, download the tar file as
                   1041:        explained above. Then, make sure that you have not made any
                   1042:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1043:        directory and extract the new tar file. Done.</p>
                   1044: </div>
1.148     asau     1045: <div class="sect2">
1.75      rillig   1046: <div class="titlepage"><div><div><h3 class="title">
                   1047: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132     spz      1048: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1049: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1050: </pre>
                   1051: <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>
                   1052: <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>
                   1053: </pre>
1.148     asau     1054: <div class="sect3">
1.75      rillig   1055: <div class="titlepage"><div><div><h4 class="title">
                   1056: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1057: <p>When updating pkgsrc, the CVS program keeps track of the
                   1058:        branch you selected. But if you, for whatever reason, want to
                   1059:        switch from the stable branch to the current one, you can do it
1.128     wiz      1060:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1061:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1062:        back to the stable branch, add the
1.230     sevan    1063:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2016Q4</span>&#8221;</span> option.</p>
1.75      rillig   1064: </div>
1.148     asau     1065: <div class="sect3">
1.75      rillig   1066: <div class="titlepage"><div><div><h4 class="title">
                   1067: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1068: <p>When you update pkgsrc, the CVS program will only touch
                   1069:        those files that are registered in the CVS repository. That
                   1070:        means that any packages that you created on your own will stay
                   1071:        unmodified. If you change files that are managed by CVS, later
                   1072:        updates will try to merge your changes with those that have been
                   1073:        done by others. See the CVS manual, chapter
1.128     wiz      1074:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1075: </div>
                   1076: </div>
                   1077: </div>
                   1078: </div>
1.148     asau     1079: <div class="chapter">
1.75      rillig   1080: <div class="titlepage"><div><div><h2 class="title">
                   1081: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1082: <div class="toc">
                   1083: <p><b>Table of Contents</b></p>
1.210     leot     1084: <dl class="toc">
1.82      rillig   1085: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1086: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1087: </dl>
                   1088: </div>
1.148     asau     1089: <div class="sect1">
1.75      rillig   1090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1091: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1092: <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   1093: </div>
1.148     asau     1094: <div class="sect1">
1.82      rillig   1095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1096: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1097: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1098:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1099:     to privileged one all programs are installed under one particular user
1.149     asau     1100:     and cannot utilise privileged operations (packages don't create
                   1101:     special users and all special file permissions like setuid are ignored).
                   1102:     </p>
1.82      rillig   1103: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1104: <pre class="screen">
1.167     asau     1105: <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   1106: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1107: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1108:     </pre>
1.149     asau     1109: <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>
                   1110: <p>By default, in privileged mode pkgsrc uses
                   1111:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1112:     where programs will be installed in,
1.230     sevan    1113:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1114:     directory where pkgsrc will do its internal bookkeeping,
                   1115:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1116:     where packages install their persistent data.
                   1117:     In unprivileged mode pkgsrc uses
                   1118:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1119:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1120:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1121:     </p>
                   1122: <p>You can change default layout using command-line arguments.
                   1123:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1124:     </p>
1.148     asau     1125: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1126: <h3 class="title">Note</h3>
1.110     hubertf  1127: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1128:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1129:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1130:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1131: </div>
1.149     asau     1132: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1133: <h3 class="title">Note</h3>
                   1134: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1135:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1136:       corresponding to the installation you're working with to build
                   1137:       and install packages.
                   1138:       </p>
                   1139: </div>
1.75      rillig   1140: </div>
                   1141: </div>
1.148     asau     1142: <div class="chapter">
1.75      rillig   1143: <div class="titlepage"><div><div><h2 class="title">
                   1144: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1145: <div class="toc">
                   1146: <p><b>Table of Contents</b></p>
1.210     leot     1147: <dl class="toc">
1.75      rillig   1148: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1149: <dd><dl>
                   1150: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1151: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1152: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1153: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1154: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1155: <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>
                   1156: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75      rillig   1157: </dl></dd>
                   1158: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1159: <dd><dl>
                   1160: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1161: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1162: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1163: </dl></dd>
                   1164: </dl>
                   1165: </div>
                   1166: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1167: is to only install the package tools and to use binary packages
1.128     wiz      1168: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1169: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1170: of pkgsrc, too. Then you are able to build your own packages,
                   1171: and you can still use binary packages from someone else.</p>
1.148     asau     1172: <div class="sect1">
1.75      rillig   1173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1174: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1175: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1176:   server and its mirrors, there are collections of binary packages,
                   1177:   ready to be installed. These binary packages have been built using the
                   1178:   default settings for the directories, that is:</p>
1.148     asau     1179: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1180: <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>
                   1181: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1182: <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   1183: </ul></div>
                   1184: <p>If you cannot use these directories for whatever reasons (maybe
                   1185:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1186:   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     1187: <div class="sect2">
1.75      rillig   1188: <div class="titlepage"><div><div><h3 class="title">
                   1189: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1190: <p>To install binary packages, you first need to know from where
                   1191:     to get them. The first place where you should look is on the main
1.110     hubertf  1192:     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   1193: <p>This directory contains binary packages for multiple
                   1194:     platforms. First, select your operating system. (Ignore the
                   1195:     directories with version numbers attached to it, they just exist for
                   1196:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1197:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1198: <p>In this directory, you often find a file called
                   1199:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1200:     management tools. If the file is missing, it is likely that your
                   1201:     operating system already provides those tools. Download the file and
                   1202:     extract it in the <code class="filename">/</code> directory. It will create
                   1203:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1204:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1205: </div>
1.148     asau     1206: <div class="sect2">
1.75      rillig   1207: <div class="titlepage"><div><div><h3 class="title">
                   1208: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1209: <p>In the directory from the last section, there is a
1.196     wiz      1210:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1211:     binary packages that are available for the platform, excluding those
                   1212:     that may not be distributed via FTP or CDROM (depending on which
1.128     wiz      1213:     medium you are using).</p>
1.109     rillig   1214: <p>To install packages directly from an FTP or HTTP server, run
                   1215:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1216:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1217: <pre class="screen">
                   1218: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.196     wiz      1219: <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   1220: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1221: </pre>
                   1222: <p>Instead of URLs, you can also use local paths, for example if
                   1223:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1224:     repository. If you want to install packages from multiple sources,
                   1225:     you can separate them by a semicolon in
                   1226:     <code class="varname">PKG_PATH</code>.</p>
                   1227: <p>After these preparations, installing a package is very
                   1228:     easy:</p>
                   1229: <pre class="screen">
1.230     sevan    1230: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1.109     rillig   1231: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1.230     sevan    1232: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.109     rillig   1233: </pre>
1.75      rillig   1234: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1235:     package in question will be installed, too, assuming they are
                   1236:     present where you install from.</p>
1.128     wiz      1237: <p>Adding packages might install vulnerable packages.
                   1238:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
                   1239:     regularly, especially after installing new packages, and verify
                   1240:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1241: <p>After you've installed packages, be sure to have
1.88      wiz      1242:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1243:     <code class="varname">PATH</code> so you can actually start the just
                   1244:     installed program.</p>
1.75      rillig   1245: </div>
1.148     asau     1246: <div class="sect2">
1.75      rillig   1247: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1248: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1249: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1250:     installed from source code or from a binary package. The
1.110     hubertf  1251:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1252:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1253:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1254:     name can be given with or without version number. Wildcards can
                   1255:     also be used to deinstall a set of packages, for example
                   1256:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1257:     so that the shell does not expand them before
                   1258:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1259: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1260:     removes all the packages that require the package in question
                   1261:     and then removes the package itself. For example:
1.82      rillig   1262: 
1.88      wiz      1263:     </p>
1.82      rillig   1264: <pre class="screen">
1.88      wiz      1265: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1266:     </pre>
1.82      rillig   1267: <p>
                   1268: 
1.88      wiz      1269:     will remove jpeg and all the packages that used it; this allows
                   1270:     upgrading the jpeg package.</p>
1.82      rillig   1271: </div>
1.148     asau     1272: <div class="sect2">
1.82      rillig   1273: <div class="titlepage"><div><div><h3 class="title">
                   1274: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1275: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1276:     installed packages or binary package files.</p>
1.82      rillig   1277: </div>
1.148     asau     1278: <div class="sect2">
1.82      rillig   1279: <div class="titlepage"><div><div><h3 class="title">
                   1280: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1281: <p>
1.88      wiz      1282:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1283:       known security vulnerabilities to packages which are (or have been)
                   1284:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1285:       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      1286:     </p>
1.82      rillig   1287: <p>
1.125     wiz      1288:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1289:       this list can be downloaded
                   1290:       automatically, and a security audit of all packages installed on a system
                   1291:       can take place.
                   1292:     </p>
1.82      rillig   1293: <p>
1.125     wiz      1294:       There are two components to auditing.  The first
                   1295:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1296:       is for downloading
1.88      wiz      1297:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1298:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1299:       installed packages are vulnerable.  If a package is vulnerable, you
                   1300:       will see output similar to the following:
                   1301:     </p>
1.82      rillig   1302: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1303:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1304: <p>
1.125     wiz      1305:       You may wish to have the
1.110     hubertf  1306:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1307:       file downloaded daily so that
                   1308:       it remains current.  This may be done by adding an appropriate entry
1.189     snj      1309:       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      1310:       </p>
                   1311: <pre class="screen">
                   1312: # download vulnerabilities file
1.230     sevan    1313: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
                   1314: # audit the installed packages and email results to root
                   1315: 9 3 * * * /usr/pkg/sbin/pkg_admin auit |mail -s "Installed package audit result" root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1316:       </pre>
                   1317: <p>
1.230     sevan    1318:       will update the vulnerability list every day at 3AM, followed by an audit
                   1319:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1320: 
1.230     sevan    1321:       On NetBSD this may be accomplished instead by adding the following
                   1322:       line to <code class="filename">/etc/daily.conf</code>:
                   1323:       </p>
                   1324: <pre class="screen">
                   1325: fetch_pkg_vulnerabilities=YES
                   1326:       </pre>
                   1327: <p>
                   1328:       to fetch the vulnerability list from the daily security script. The system
                   1329:       is set to audit the packages by default but can be set explicitly, if
                   1330:       desired (not required), by adding the follwing line to
                   1331: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1332:       </p>
                   1333: <pre class="screen">
1.230     sevan    1334: check_pkg_vulnerabilities=YES
1.125     wiz      1335:       </pre>
                   1336: <p>
1.230     sevan    1337:       see <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1338:     </p>
1.82      rillig   1339: </div>
1.148     asau     1340: <div class="sect2">
1.82      rillig   1341: <div class="titlepage"><div><div><h3 class="title">
                   1342: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1343: <p>
1.189     snj      1344:       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      1345:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.88      wiz      1346:       argument to check if your packages are up-to-date, e.g.
                   1347:     </p>
                   1348: <pre class="screen">
                   1349: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1350: ...
1.88      wiz      1351: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1352:     </pre>
1.110     hubertf  1353: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1354:     package on your system and rebuild any dependencies.
                   1355:     </p>
1.82      rillig   1356: </div>
1.148     asau     1357: <div class="sect2">
1.82      rillig   1358: <div class="titlepage"><div><div><h3 class="title">
                   1359: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1360: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1361:     administrative functions on the package system.</p>
1.82      rillig   1362: </div>
1.75      rillig   1363: </div>
1.148     asau     1364: <div class="sect1">
1.75      rillig   1365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1366: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1367: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1368:   directory now contains a set of packages, organized into
                   1369:   categories. You can browse the online index of packages, or run
1.110     hubertf  1370:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1371:   directory to build local <code class="filename">README.html</code> files for
1.189     snj      1372:   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      1373: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1374:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1375:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1376:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1377:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1378:   system (inside a chroot is an exception). </p>
                   1379: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1380:   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      1381:   instructions how to create your own packages.</p>
1.148     asau     1382: <div class="sect2">
1.75      rillig   1383: <div class="titlepage"><div><div><h3 class="title">
                   1384: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1385: <p>To build packages from source, you need a working C
1.88      wiz      1386:     compiler. On NetBSD, you need to install the
1.128     wiz      1387:     <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      1388:     sets. If you want to build X11-related packages, the
1.128     wiz      1389:     <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      1390:     sets are required, too.</p>
1.75      rillig   1391: </div>
1.148     asau     1392: <div class="sect2">
1.75      rillig   1393: <div class="titlepage"><div><div><h3 class="title">
                   1394: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1395: <p>The first step for building a package is downloading the
1.88      wiz      1396:     distfiles (i.e. the unmodified source). If they have not yet been
                   1397:     downloaded, pkgsrc will fetch them automatically.</p>
                   1398: <p>If you have all files that you need in the
                   1399:     <code class="filename">distfiles</code> directory,
                   1400:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1401:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1402:     </p>
1.82      rillig   1403: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1404: <p>
1.110     hubertf  1405:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1406: <p>By default a list of distribution sites will be randomly
                   1407:     intermixed to prevent huge load on servers which holding popular
                   1408:     packages (for example, SourceForge.net mirrors). Thus, every
                   1409:     time when you need to fetch yet another distfile all the mirrors
                   1410:     will be tried in new (random) order. You can turn this feature
                   1411:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1412:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1413: <p>You can overwrite some of the major distribution sites to
                   1414:     fit to sites that are close to your own.  By setting one or two
                   1415:     variables you can modify the order in which the master sites are
                   1416:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1417:     delimited list of domain suffixes.
                   1418:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1419:     contains a whitespace delimited list of regular expressions.  It
                   1420:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1421:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1422:     some examples.  This may save some of your bandwidth and
                   1423:     time.</p>
1.75      rillig   1424: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1425:     if you want to keep the settings, by editing the
1.110     hubertf  1426:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1427:     and adding the definitions there.</p>
1.82      rillig   1428: <p>
1.88      wiz      1429:       If a package depends on many other packages (such as
1.189     snj      1430:       <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      1431:       alternate between periods of
                   1432:       downloading source, and compiling. To ensure you have all the source
                   1433:       downloaded initially you can run the command:
                   1434:       </p>
1.82      rillig   1435: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1436: <p>
1.88      wiz      1437:       which will output and run a set of shell commands to fetch the
                   1438:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1439:       also choose to download the files manually.
                   1440:     </p>
1.75      rillig   1441: </div>
1.148     asau     1442: <div class="sect2">
1.75      rillig   1443: <div class="titlepage"><div><div><h3 class="title">
                   1444: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1445: <p>
1.88      wiz      1446:       Once the software has downloaded, any patches will be applied, then it
                   1447:       will be compiled for you. This may take some time depending on your
                   1448:       computer, and how many other packages the software depends on and their
                   1449:       compile time.
                   1450:     </p>
1.148     asau     1451: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1452: <h3 class="title">Note</h3>
                   1453: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1454:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1455:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1456: </div>
1.87      wiz      1457: <p>For example, type</p>
1.88      wiz      1458: <pre class="screen">
                   1459: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1460: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1461:     </pre>
1.75      rillig   1462: <p>at the shell prompt to build the various components of the
1.88      wiz      1463:     package.</p>
1.82      rillig   1464: <p>The next stage is to actually install the newly compiled
1.88      wiz      1465:     program onto your system. Do this by entering:
1.82      rillig   1466: 
1.88      wiz      1467:     </p>
1.82      rillig   1468: <pre class="screen">
1.88      wiz      1469: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1470:     </pre>
1.82      rillig   1471: <p>
                   1472: 
1.88      wiz      1473:     while you are still in the directory for whatever package you
                   1474:     are installing.</p>
1.82      rillig   1475: <p>Installing the package on your system may require you to
1.88      wiz      1476:     be root.  However, pkgsrc has a
                   1477:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1478:     to only become root for the actual installation step.</p>
1.82      rillig   1479: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1480:     You can now enter:
1.82      rillig   1481: 
1.88      wiz      1482:     </p>
1.82      rillig   1483: <pre class="screen">
1.88      wiz      1484: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1485:     </pre>
1.82      rillig   1486: <p>
                   1487: 
1.88      wiz      1488:     to remove the compiled files in the work directory, as you shouldn't need
                   1489:     them any more. If other packages were also added to your system
                   1490:     (dependencies) to allow your program to compile, you can tidy these up
                   1491:     also with the command:</p>
1.82      rillig   1492: <pre class="screen">
1.88      wiz      1493: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1494:     </pre>
1.75      rillig   1495: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  1496:     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      1497: <p>The program is installed under the default root of the
                   1498:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1499:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1500:     variable in your environment, and it will use that value as the
                   1501:     root of your packages tree. So, to use
                   1502:     <code class="filename">/usr/local</code>, set
                   1503:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1504:     Please note that you should use a directory which is dedicated to
                   1505:     packages and not shared with other programs (i.e., do not try and
                   1506:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1507:     to add any of your own files or directories (such as
                   1508:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1509:     <code class="filename">pkgsrc/</code>) below the
                   1510:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1511:     conflicts between programs and other files installed by the
                   1512:     package system and whatever else may have been installed
                   1513:     there.</p>
1.110     hubertf  1514: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1515:     alter some configuration options at build time.  Have a look at
                   1516:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1517:     of what will be set there by default.  Environment variables such
                   1518:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1519:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1520:     set them each time you want to use pkgsrc.</p>
1.128     wiz      1521: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1522:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      1523:     or being installed. This may be for debugging purposes, or out of
                   1524:     simple curiosity. A number of utility values have been added to
                   1525:     help with this.</p>
1.128     wiz      1526: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1527: <li class="listitem">
1.189     snj      1528: <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      1529:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1530:        information will be displayed. For example,</p>
1.75      rillig   1531: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1532: <p>will show all the commands that are invoked, up to and
1.128     wiz      1533:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   1534: </li>
1.128     wiz      1535: <li class="listitem">
1.189     snj      1536: <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      1537:        definition, then the <code class="varname">VARNAME</code> definition
                   1538:        should be used, in conjunction with the show-var
1.189     snj      1539:        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      1540:        variable <code class="varname">LOCALBASE</code>:</p>
                   1541: <pre class="screen">
                   1542: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1543: /usr/pkg
                   1544: <code class="prompt">%</code>
1.88      wiz      1545:        </pre>
1.75      rillig   1546: </li>
                   1547: </ol></div>
                   1548: <p>If you want to install a binary package that you've either
1.88      wiz      1549:     created yourself (see next section), that you put into
                   1550:     pkgsrc/packages manually or that is located on a remote FTP
                   1551:     server, you can use the "bin-install" target. This target will
1.189     snj      1552:     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  1553:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1554:     sites searched is kept in the variable
                   1555:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.189     snj      1556:     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      1557:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1558:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1559:     details.</p>
                   1560: <p>A final word of warning: If you set up a system that has a
                   1561:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1562:     set that before any packages are installed, as you cannot use
                   1563:     several directories for the same purpose. Doing so will result in
                   1564:     pkgsrc not being able to properly detect your installed packages,
                   1565:     and fail miserably. Note also that precompiled binary packages are
                   1566:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1567:     <code class="filename">/usr/pkg</code>, and that you should
                   1568:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1569:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1570: </div>
                   1571: </div>
                   1572: </div>
1.148     asau     1573: <div class="chapter">
1.75      rillig   1574: <div class="titlepage"><div><div><h2 class="title">
                   1575: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   1576: <div class="toc">
                   1577: <p><b>Table of Contents</b></p>
1.210     leot     1578: <dl class="toc">
1.75      rillig   1579: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   1580: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   1581: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      1582: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      1583: <dd><dl>
1.103     wiz      1584: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz      1585: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1586: <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      1587: </dl></dd>
1.103     wiz      1588: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   1589: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   1590: </dl>
                   1591: </div>
1.104     rillig   1592: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1593: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1594: that file depends on the installation. On NetBSD, when you use
1.189     snj      1595: <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   1596: <code class="filename">/etc/</code>. In all other cases the default location is
                   1597: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1598: bootstrap program to install the binary packages.</p>
                   1599: <p>The format of the configuration file is that of the usual
                   1600: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1601: is done by setting variables in this file. Note that you can define all
                   1602: kinds of variables, and no special error checking (for example for
1.223     rillig   1603: spelling mistakes) takes place.</p>
1.148     asau     1604: <div class="sect1">
1.75      rillig   1605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1606: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.223     rillig   1607: <p>The following variables apply to all
1.89      rillig   1608:     pkgsrc packages. A complete list of the variables that can be
                   1609:     configured by the user is available in
                   1610:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1611:     comments that describe each variable's intent.</p>
1.148     asau     1612: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1613: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1614:            packages will be installed. The default is
1.76      rillig   1615:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1616:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1617: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1618:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   1619:            installed. The default is
1.76      rillig   1620:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1621: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1622:            X11 is installed on the system. The default is
1.194     bsiegert 1623:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1624: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1625:            downloaded copies of the original source distributions used
                   1626:            for building pkgsrc packages. The default is
1.76      rillig   1627:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1628: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1629:            database about installed packages is stored.  The default is
1.230     sevan    1630:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1631: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1632:            If set, override the packages'
                   1633:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1634: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1635:            Backup location(s) for distribution files and patch files
                   1636:            if not found locally or in
1.76      rillig   1637:            <code class="filename">${MASTER_SITES}</code> or
                   1638:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1639:            The defaults is
                   1640:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1641: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1642:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1643:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      1644:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1645:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1646: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1647:            List of acceptable licenses. License names are case-sensitive.
                   1648:            Whenever you try to build a package whose license is not in this
                   1649:            list, you will get an error message. If the license condition is
                   1650:            simple enough, the error message will include specific
                   1651:            instructions on how to change this variable.</p></li>
1.75      rillig   1652: </ul></div>
                   1653: </div>
1.148     asau     1654: <div class="sect1">
1.75      rillig   1655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1656: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1657: <p>
1.75      rillig   1658:       </p>
1.148     asau     1659: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1660: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1661:            directory for the binary packages. The default is
1.76      rillig   1662:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1663: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1664:            The top level directory where, if defined, the separate
                   1665:            working directories will get created, and symbolically
1.76      rillig   1666:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1667:            This is useful for building packages on several
1.76      rillig   1668:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1669:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1670:            is local to every architecture. (It should be noted that
                   1671:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1672:            &mdash; it is an internal definition which refers to the
1.75      rillig   1673:            root of the pkgsrc tree. It is possible to have many
                   1674:            pkgsrc tree instances.)</p></li>
1.128     wiz      1675: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1676:            Directory for local patches that aren't part of pkgsrc.
1.219     rillig   1677:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more
1.93      rillig   1678:            information.</p></li>
1.128     wiz      1679: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1680:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1681:            BSD-style Makefile. If this is not set,
                   1682:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1683:            <code class="filename">/dev/null</code> to avoid picking up
                   1684:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128     wiz      1685: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82      rillig   1686:            By default, dependencies are only installed, and no binary
                   1687:            package is created for them. You can set this variable to
1.174     asau     1688:            <code class="literal">package-install</code> to automatically create binary
1.190     wiz      1689:            packages after installing dependencies. Please note that the
1.194     bsiegert 1690:            <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.190     wiz      1691:            <code class="literal">yes</code> to preserve binary packages when
                   1692:            using the <code class="literal">install</code> as well.</p></li>
1.75      rillig   1693: </ul></div>
                   1694: </div>
1.148     asau     1695: <div class="sect1">
1.75      rillig   1696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   1697: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.217     jnemeth  1698: <p>Packages have to support installation into a
1.103     wiz      1699:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1700:     to be built, before the actual filesystem is touched. DESTDIR
                   1701:     support exists in two variations:</p>
1.148     asau     1702: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1703: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1704:       installation and packaging is still run as root.</p></li>
                   1705: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1706:       build, installation and packaging as normal user. Root
                   1707:       privileges are only needed to add packages.</p></li>
                   1708: </ul></div>
1.103     wiz      1709: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1710:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1711: <p>Considering the <code class="filename">foo/bar</code> package,
                   1712:     DESTDIR full support can be tested using the following commands
                   1713: 
                   1714: </p>
                   1715: <pre class="programlisting">
                   1716: <code class="prompt">$</code> id
                   1717: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1718: <code class="prompt">$</code> mkdir $HOME/packages
                   1719: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1720: </pre>
                   1721: <p>
                   1722: 
                   1723:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1724:     should be needed
                   1725: 
                   1726: </p>
                   1727: <pre class="programlisting">
1.174     asau     1728: <code class="prompt">$</code> make stage-install
1.118     imil     1729: </pre>
                   1730: <p>
                   1731: 
                   1732:     Create a package without root privileges
                   1733: 
                   1734: </p>
                   1735: <pre class="programlisting">
1.174     asau     1736: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1737: </pre>
                   1738: <p>
                   1739: 
                   1740:     For the following command, you must be able to gain root
1.189     snj      1741:     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     1742: 
                   1743: </p>
                   1744: <pre class="programlisting">
1.174     asau     1745: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1746: </pre>
                   1747: <p>
                   1748: 
                   1749:     Then, as a simple user
                   1750: 
                   1751: </p>
                   1752: <pre class="programlisting">
                   1753: <code class="prompt">$</code> make clean
                   1754: </pre>
                   1755: <p>
                   1756: 
                   1757:     </p>
1.103     wiz      1758: </div>
1.148     asau     1759: <div class="sect1">
1.103     wiz      1760: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1761: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1762: <div class="sect2">
1.78      rillig   1763: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      1764: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1765: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1766:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1767: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1768: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1769: <dd>
                   1770: <p>This is a list of values specifying the chain of
                   1771:          compilers to invoke when building packages.  Valid values
                   1772:          are:</p>
1.148     asau     1773: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1774: <li class="listitem"><p><code class="varname">ccc</code>:
                   1775:            Compaq C Compilers (Tru64)</p></li>
                   1776: <li class="listitem"><p><code class="varname">ccache</code>:
                   1777:            compiler cache (chainable)</p></li>
                   1778: <li class="listitem"><p><code class="varname">clang</code>:
                   1779:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1780: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1781:            distributed C/C++ (chainable)</p></li>
1.174     asau     1782: <li class="listitem"><p><code class="varname">f2c</code>:
                   1783:            Fortran 77 to C compiler (chainable)</p></li>
                   1784: <li class="listitem"><p><code class="varname">icc</code>:
                   1785:            Intel C++ Compiler (Linux)</p></li>
                   1786: <li class="listitem"><p><code class="varname">ido</code>:
                   1787:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1788: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1789:            GNU C/C++ Compiler</p></li>
1.174     asau     1790: <li class="listitem"><p><code class="varname">hp</code>:
                   1791:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1792: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1793:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1794: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1795:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1796: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1797:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1798: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1799:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1800: </ul></div>
                   1801: <p>The default is
1.128     wiz      1802:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   1803:          <code class="varname">ccache</code> and/or
                   1804:          <code class="varname">distcc</code> with an appropriate
                   1805:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      1806:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 1807:          variable should always be terminated with a value for
                   1808:          a real compiler.  Note that only one real compiler
1.128     wiz      1809:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 1810:          is not allowed).</p>
1.89      rillig   1811: </dd>
                   1812: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1813: <dd><p>This specifies the minimum version of GCC to use
                   1814:          when building packages.  If the system GCC doesn't
                   1815:          satisfy this requirement, then pkgsrc will build and
                   1816:          install one of the GCC packages to use instead.</p></dd>
1.225     maya     1817: <dt><span class="term"><code class="varname">PYTHON_DEFAULT_VERSION</code>:</span></dt>
                   1818: <dd><p>Specifies which version of python to use when several
                   1819:          options are available.</p></dd>
                   1820: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
                   1821: <dd><p>Specifies the fortran compiler to use.
                   1822:          The default is <code class="varname">g95</code>, and
                   1823:          <code class="varname">gfortran</code> is an alternative.</p></dd>
                   1824: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1825: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1826:          <code class="varname">gfortran</code> is used, this option specifies which
                   1827:          version to use.</p></dd>
1.89      rillig   1828: </dl></div>
                   1829: </div>
1.148     asau     1830: <div class="sect2">
1.89      rillig   1831: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      1832: <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   1833: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1834:        please make sure to use the <code class="literal">+=</code> operator
                   1835:        instead of the <code class="literal">=</code> operator:</p>
                   1836: <pre class="programlisting">
1.100     rillig   1837: CFLAGS+=        -your -flags
1.78      rillig   1838: </pre>
                   1839: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      1840:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  1841:        need to add their own flags.  You may want to take a look
1.189     snj      1842:        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      1843:        package if you're interested in optimization specifically
                   1844:        for the current CPU. </p>
1.78      rillig   1845: </div>
1.148     asau     1846: <div class="sect2">
1.88      wiz      1847: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      1848: <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      1849: <p>If you want to pass flags to the linker, both in the configure
                   1850: step and the build step, you can do this in two ways.  Either set
                   1851: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1852: between the two is that <code class="varname">LIBS</code> will be appended to
                   1853: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1854: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1855: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1856: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1857: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1858: settings, use the <code class="literal">+=</code> operator:</p>
                   1859: <pre class="programlisting">
1.100     rillig   1860: LDFLAGS+=        -your -linkerflags
1.88      wiz      1861: </pre>
                   1862: </div>
1.78      rillig   1863: </div>
1.148     asau     1864: <div class="sect1">
1.78      rillig   1865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      1866: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 1867: <p>
1.75      rillig   1868:       </p>
1.148     asau     1869: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1870: <li class="listitem">
1.75      rillig   1871: <p><code class="varname">PKG_DEVELOPER</code>:
                   1872:            Run some sanity checks that package developers want:
                   1873:            </p>
1.148     asau     1874: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      1875: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      1876:              fuzz</p></li>
1.128     wiz      1877: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      1878:              binaries will find their shared libs.</p></li>
1.75      rillig   1879: </ul></div>
                   1880: <p>
1.87      wiz      1881:        </p>
1.75      rillig   1882: </li>
1.128     wiz      1883: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      1884:        of debugging output which is displayed whilst making and
                   1885:        installing the package.  The default value for this is 0,
                   1886:        which will not display the commands as they are executed
                   1887:        (normal, default, quiet operation); the value 1 will display
                   1888:        all shell commands before their invocation, and the value 2
                   1889:        will display both the shell commands before their invocation,
1.223     rillig   1890:        as well as their actual execution progress with <span class="command"><strong>set
                   1891:        -x</strong></span>.</p></li>
1.75      rillig   1892: </ul></div>
                   1893: <p>
                   1894:     </p>
                   1895: </div>
1.148     asau     1896: <div class="sect1">
1.75      rillig   1897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      1898: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      1899: <p>Some packages have build time options, usually to select
                   1900:     between different dependencies, enable optional support for big
                   1901:     dependencies or enable experimental features.</p>
1.75      rillig   1902: <p>To see which options, if any, a package supports, and which
1.110     hubertf  1903:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      1904:     show-options</strong></span>, for example:</p>
1.75      rillig   1905: <pre class="programlisting">
                   1906:     The following options are supported by this package:
                   1907:         ssl      Enable SSL support.
                   1908:     Exactly one of the following gecko options is required:
                   1909:         firefox  Use firefox as gecko rendering engine.
                   1910:         mozilla  Use mozilla as gecko rendering engine.
                   1911:     At most one of the following database options may be selected:
                   1912:         mysql    Enable support for MySQL database.
                   1913:         pgsql    Enable support for PostgreSQL database.
1.1       grant    1914: 
1.75      rillig   1915:     These options are enabled by default: firefox
                   1916:     These options are currently enabled: mozilla ssl
1.1       grant    1917: </pre>
1.75      rillig   1918: <p>The following variables can be defined in
1.110     hubertf  1919:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      1920:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   1921:     which can be used to select or disable options for all packages
                   1922:     that support them, and
                   1923:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   1924:     which can be used to select or disable options specifically for
                   1925:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      1926:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      1927:     are disabled. A few examples:</p>
1.75      rillig   1928: <pre class="screen">
1.110     hubertf  1929: <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   1930: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   1931: PKG_OPTIONS.kdebase=    debug -sasl
                   1932: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   1933: <p>It is important to note that options that were specifically
1.120     snj      1934:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   1935:     you do not wish to include the option.  If you are unsure you can view
                   1936:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      1937: <p>The following settings are consulted in the order given, and
                   1938:     the last setting that selects or disables an option is
                   1939:     used:</p>
1.128     wiz      1940: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1941: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      1942:       maintainer</p></li>
1.128     wiz      1943: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      1944:       variables (see below)</p></li>
1.128     wiz      1945: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   1946: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   1947: </ol></div>
                   1948: <p>For groups of mutually exclusive options, the last option
1.88      wiz      1949:     selected is used, all others are automatically disabled.  If an
                   1950:     option of the group is explicitly disabled, the previously
                   1951:     selected option, if any, is used.  It is an error if no option
                   1952:     from a required group of options is selected, and building the
                   1953:     package will fail.</p>
                   1954: <p>Before the options framework was introduced, build options
                   1955:     were selected by setting a variable (often named
                   1956:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  1957:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      1958:     transition to the options framework for the user, these legacy
                   1959:     variables are converted to the appropriate options setting
                   1960:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   1961:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  1962:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      1963:     directly.  Support for the legacy variables will be removed
                   1964:     eventually.</p>
1.75      rillig   1965: </div>
                   1966: </div>
1.148     asau     1967: <div class="chapter">
1.75      rillig   1968: <div class="titlepage"><div><div><h2 class="title">
                   1969: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   1970: <div class="toc">
                   1971: <p><b>Table of Contents</b></p>
1.210     leot     1972: <dl class="toc">
1.75      rillig   1973: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   1974: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   1975: </dl>
                   1976: </div>
1.148     asau     1977: <div class="sect1">
1.75      rillig   1978: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1979: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      1980: <p>Once you have built and installed a package, you can create
                   1981:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.189     snj      1982:     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      1983:     the same package on a group of hosts and wasting CPU time. It also
                   1984:     provides a simple means for others to install your package, should
                   1985:     you distribute it.</p>
                   1986: <p>To create a binary package, change into the appropriate
1.110     hubertf  1987:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      1988:     package</strong></span>:</p>
                   1989: <pre class="screen">
1.223     rillig   1990: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1991: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   1992: </pre>
1.87      wiz      1993: <p>This will build and install your package (if not already done),
                   1994:     and then build a binary package from what was installed. You can
1.110     hubertf  1995:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      1996:     it. Binary packages are created by default in
                   1997:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  1998:     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      1999:     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  2000: <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      2001:     such a binary package.</p>
1.75      rillig   2002: </div>
1.148     asau     2003: <div class="sect1">
1.75      rillig   2004: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2005: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2006: <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   2007: </div>
                   2008: </div>
1.148     asau     2009: <div class="chapter">
1.106     rillig   2010: <div class="titlepage"><div><div><h2 class="title">
                   2011: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2012: builds)</h2></div></div></div>
                   2013: <div class="toc">
                   2014: <p><b>Table of Contents</b></p>
1.210     leot     2015: <dl class="toc">
1.180     wiz      2016: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                   2017: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                   2018: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                   2019: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau     2020: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2021: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2022: </dl>
                   2023: </div>
1.180     wiz      2024: <p>For a number of reasons you may want to build binary packages
                   2025: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
                   2026: For instance, when you have multiple machines that should run the same software,
                   2027: it is wasted time if they all build their packages themselves from source.
                   2028: Or you may want to build a list of packages you want and check them before
                   2029: deploying onto production system.
                   2030: There is a way of getting a set of binary packages:
1.223     rillig   2031: The bulk build system, or pbulk ("p" stands for "parallel").
                   2032: This chapter describes how to set it up.</p>
1.148     asau     2033: <div class="sect1">
1.106     rillig   2034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2035: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
                   2036: <p>First of all, you have to decide whether you build all packages
                   2037: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2038: both space and time, than builds for some practical sets of packages.
                   2039: There exists a number of particularly heavy packages that are not actually
                   2040: interesting to a wide audience.
                   2041: 
                   2042: For a limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2043: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2044: </p>
                   2045: <p>During bulk builds various packages are installed and deinstalled
                   2046: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2047: so make sure that you don't need any package during the builds.
1.223     rillig   2048: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2049: or something even more restrictive, depending on what the operating system provides,
                   2050: or dedicate the whole physical machine.
                   2051: As a useful side effect this makes sure that bulk builds cannot
                   2052: break anything in your system. There have been numerous cases where
1.106     rillig   2053: certain packages tried to install files outside the
                   2054: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2055: <code class="filename">/etc</code>.
                   2056: </p>
1.106     rillig   2057: </div>
1.148     asau     2058: <div class="sect1">
1.106     rillig   2059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2060: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   2061: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148     asau     2062: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2063: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2064: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2065: </ul></div>
1.148     asau     2066: <div class="sect2">
1.116     rillig   2067: <div class="titlepage"><div><div><h3 class="title">
1.180     wiz      2068: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.223     rillig   2069: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2070: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2071: Configure network access to fetch distribution files.
1.223     rillig   2072: Create a user with name "pbulk".</p>
1.178     asau     2073: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2074: <pre class="screen">
1.181     wiz      2075: <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>
                   2076: <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>
                   2077: <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     2078: </pre>
                   2079: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2080: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2081: <pre class="screen">
1.230     sevan    2082: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.178     asau     2083: <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>
                   2084: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2085: </pre>
                   2086: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2087: <h3 class="title">Note</h3>
                   2088: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2089: <code class="filename">mk.conf</code> that contains settings you want to
                   2090: apply to packages you build. For instance,</p>
                   2091: <pre class="programlisting">
1.223     rillig   2092: PKG_DEVELOPER=          yes     # perform more checks
                   2093: X11_TYPE=               modular # use pkgsrc X11
                   2094: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2095:                                 # when building all packages)
1.178     asau     2096: </pre>
                   2097: </div>
                   2098: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2099: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2100: <pre class="programlisting">
                   2101: www/firefox
                   2102: mail/thunderbird
                   2103: misc/libreoffice4
                   2104: </pre>
1.179     asau     2105: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2106: and make final amendments, if wanted.</p>
1.178     asau     2107: <p>Start it:</p>
                   2108: <pre class="screen">
                   2109: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2110: </pre>
                   2111: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2112: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2113: </p>
                   2114: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2115: <h3 class="title">Note</h3>
                   2116: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2117: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2118: The script is kept small enough for better understanding.</p>
                   2119: </div>
                   2120: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2121: <h3 class="title">Note</h3>
                   2122: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2123: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2124: </div>
1.106     rillig   2125: </div>
                   2126: </div>
1.148     asau     2127: <div class="sect1">
1.106     rillig   2128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2129: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
                   2130: <p>A complete bulk build requires lots of disk space. Some of the
                   2131: disk space can be read-only, some other must be writable. Some can be on
                   2132: remote filesystems (such as NFS) and some should be local. Some can be
                   2133: temporary filesystems, others must survive a sudden reboot.</p>
                   2134: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2135: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2136: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2137: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2138: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2139: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2140: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2141: </ul></div>
                   2142: </div>
                   2143: <div class="sect1">
                   2144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174     asau     2145: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2146: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2147:     create a CD-ROM set of the resulting binary packages to assist
                   2148:     in installing packages on other machines.  The
1.189     snj      2149:     <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      2150:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2151:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2152:     way that keeps all the dependencies for a given package on the same
                   2153:     CD as that package.</p>
1.148     asau     2154: <div class="sect2">
1.75      rillig   2155: <div class="titlepage"><div><div><h3 class="title">
1.174     asau     2156: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2157: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2158:       man page. The following short example assumes that the binary
                   2159:       packages are left in
                   2160:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2161:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2162:       hold the ISO 9660 images.</p>
                   2163: <pre class="screen">
                   2164: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2165: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2166: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2167:       </pre>
                   2168: <p>If you wish to include a common set of files
                   2169:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2170:       etc.) on each CD in the collection, then you need to create a
                   2171:       directory which contains these files. e.g.</p>
                   2172: <pre class="screen">
                   2173: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2174: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2175: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2176: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2177: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2178: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2179: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2180:       </pre>
1.75      rillig   2181: <p>Now create the images:</p>
                   2182: <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   2183: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2184:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2185:       in their root directories.</p>
1.75      rillig   2186: </div>
                   2187: </div>
                   2188: </div>
1.148     asau     2189: <div class="chapter">
1.75      rillig   2190: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2191: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2192: <div class="toc">
                   2193: <p><b>Table of Contents</b></p>
1.210     leot     2194: <dl class="toc">
1.128     wiz      2195: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2196: <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   2197: </dl>
                   2198: </div>
                   2199: <p>The files that are installed by pkgsrc are organized in a way that
                   2200: is similar to what you find in the <code class="filename">/usr</code> directory
                   2201: of the base system. But some details are different. This is because
                   2202: pkgsrc initially came from FreeBSD and had adopted its file system
                   2203: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2204: which operating system you are using pkgsrc with, you can expect the
                   2205: same layout for pkgsrc.</p>
1.91      rillig   2206: <p>There are mainly four root directories for pkgsrc, which are all
                   2207: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2208: When pkgsrc has been installed as root, the default locations
                   2209: are:</p>
                   2210: <pre class="programlisting">
1.100     rillig   2211: LOCALBASE=              /usr/pkg
                   2212: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2213: VARBASE=                /var
1.231   ! sevan    2214: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2215: </pre>
                   2216: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2217: user), the default locations are:</p>
                   2218: <pre class="programlisting">
1.100     rillig   2219: LOCALBASE=              ${HOME}/pkg
                   2220: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2221: VARBASE=                ${HOME}/pkg/var
1.231   ! sevan    2222: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2223: </pre>
                   2224: <p>What these four directories are for, and what they look like is
                   2225: explained below.</p>
1.148     asau     2226: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2227: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2228: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2229: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2230: the well-known subdirectories like <code class="filename">bin</code>,
                   2231: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2232: <code class="filename">share</code> and
                   2233: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2234: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2235: <code class="filename">/var</code> in the base system. Some programs (especially
                   2236: games, network daemons) need write access to it during normal
                   2237: operation.</p></li>
1.128     wiz      2238: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2239: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2240: 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   2241: itself.</p></li>
                   2242: </ul></div>
1.148     asau     2243: <div class="sect1">
1.90      rillig   2244: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2245: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2246: </h2></div></div></div>
1.90      rillig   2247: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2248: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2249: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2250: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2251: <dd><p>Contains executable programs that are intended to be
                   2252: directly used by the end user.</p></dd>
                   2253: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2254: <dd><p>Contains files for the emulation layers of various other
                   2255: operating systems, especially for
                   2256: NetBSD.</p></dd>
                   2257: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2258: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2259: <dd><p>Contains
                   2260: the configuration files.</p></dd>
                   2261: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2262: <dd><p>Contains headers for the C and C++ programming
                   2263: languages.</p></dd>
                   2264: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2265: <dd><p>Contains GNU info files of various
                   2266: packages.</p></dd>
                   2267: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2268: <dd><p>Contains shared and static
                   2269: libraries.</p></dd>
                   2270: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2271: <dd><p>Contains data files that don't change after
                   2272: installation. Other data files belong into
                   2273: <code class="filename">${VARBASE}</code>.</p></dd>
                   2274: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2275: <dd><p>Contains programs that are not intended to be used by
                   2276: end users, such as helper programs or network
                   2277: daemons.</p></dd>
                   2278: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2279: <dd><p>Contains programs that are intended to be executed as
                   2280: CGI scripts by a web server.</p></dd>
                   2281: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2282: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2283: <dd><p>Contains brief
                   2284: documentation in form of manual pages.</p></dd>
                   2285: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2286: <dd><p>Contains programs that are intended to be used only by
                   2287: the super-user.</p></dd>
                   2288: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2289: <dd><p>Contains platform-independent data files that don't
                   2290: change after installation.</p></dd>
                   2291: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2292: <dd><p>Contains documentation files provided by the
                   2293: packages.</p></dd>
                   2294: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2295: <dd><p>Contains example files provided by the packages. Among
                   2296: others, the original configuration files are saved here and copied to
                   2297: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2298: installation.</p></dd>
                   2299: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2300: <dd><p>Contains the original files for rc.d
                   2301: scripts.</p></dd>
                   2302: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2303: <code class="filename">${VARBASE}</code>)</span></dt>
                   2304: <dd><p>Contains files
                   2305: that may be modified after
                   2306: installation.</p></dd>
                   2307: </dl></div>
                   2308: </div>
1.148     asau     2309: <div class="sect1">
1.90      rillig   2310: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2311: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2312: </h2></div></div></div>
1.148     asau     2313: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2314: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2315: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2316: <dd><p>Contains
                   2317: information about the currently installed
                   2318: packages.</p></dd>
                   2319: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2320: <dd><p>Contains highscore
                   2321: files.</p></dd>
                   2322: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2323: <dd><p>Contains log files.</p></dd>
                   2324: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2325: <dd><p>Contains informational files about daemons that are
                   2326: currently running.</p></dd>
                   2327: </dl></div>
                   2328: </div>
                   2329: </div>
1.148     asau     2330: <div class="chapter">
1.90      rillig   2331: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2332: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2333: <div class="toc">
                   2334: <p><b>Table of Contents</b></p>
1.210     leot     2335: <dl class="toc">
1.106     rillig   2336: <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 2337: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                   2338: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                   2339: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2340: <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>
                   2341: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                   2342: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                   2343: <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>
                   2344: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                   2345: <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      2346: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert 2347: <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>
                   2348: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2349: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   2350: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                   2351: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2352: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                   2353: <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   2354: </dl>
                   2355: </div>
                   2356: <p>This section contains hints, tips &amp; tricks on special things in
                   2357: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2358: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2359: <div class="sect1">
1.75      rillig   2360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2361: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2362: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2363: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2364: <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   2365:          This is a general purpose list for most issues regarding
                   2366:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2367:          for pkgsrc configuration, unexpected build failures, using
                   2368:          particular packages, upgrading pkgsrc installations,
                   2369:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2370:          proposals for changes that impact the pkgsrc user community,
                   2371:          e.g. major infrastructure changes, new features, package
                   2372:          removals, etc., may also be posted.</p></li>
1.128     wiz      2373: <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   2374:          A list where the results of pkgsrc bulk builds are sent and
                   2375:          discussed.</p></li>
1.128     wiz      2376: <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   2377:          This list is for those who are interested in getting a
                   2378:          commit message for every change committed to pkgsrc. It is
                   2379:          also available in digest form, meaning one daily message
                   2380:          containing all commit messages for changes to the package
                   2381:          source tree in that 24 hour period.</p></li>
                   2382: </ul></div>
                   2383: <p>To subscribe, do:</p>
                   2384: <pre class="programlisting">
1.100     rillig   2385: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2386: </pre>
                   2387: <p>Archives for all these mailing lists are available from
1.110     hubertf  2388: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2389: </div>
1.148     asau     2390: <div class="sect1">
1.75      rillig   2391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2392: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2393: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2394: a number of useful utilities for both users and developers of pkgsrc.  This
                   2395: section attempts only to make the reader aware of the utilities and when
                   2396: they might be useful, and not to duplicate the documentation that comes
                   2397: with each package.</p>
                   2398: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.189     snj      2399: <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   2400:       Symlinks for use by buildlink.</p></li></ul></div>
                   2401: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2402: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2403: <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   2404:       Calculates various kinds of checksums (including SHA1).</p></li>
1.189     snj      2405: <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   2406:       Compatibility library for pkgsrc tools.</p></li>
1.189     snj      2407: <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      2408:       non-BSD systems due to lack of native mtree.</p></li>
1.189     snj      2409: <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   2410:       Up-to-date replacement for
1.76      rillig   2411:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2412:       systems where pkg_install is not present.</p></li>
                   2413: </ul></div>
                   2414: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2415: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2416: <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   2417:       Create a binary package from an
1.110     hubertf  2418:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2419:       save the old package.</p></li>
1.189     snj      2420: <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   2421:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2422:       from multiple locations. It currently supports the following
                   2423:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.189     snj      2424: <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  2425:       the best compiler flags to optimise code for your current
1.128     wiz      2426:       CPU and compiler. </p></li>
1.75      rillig   2427: </ul></div>
                   2428: <p>Utilities for keeping track of installed packages, being up to date,
                   2429: etc:</p>
1.148     asau     2430: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2431: <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      2432:     update tool similar to apt(1). Download, install, and upgrade
                   2433:     binary packages easily.</p></li>
1.189     snj      2434: <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   2435:       packages whose installed versions do not match the latest pkgsrc
                   2436:       entries.</p></li>
1.189     snj      2437: <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   2438:       dependency graphs of packages, to aid in choosing a strategy for
                   2439:       updating.</p></li>
1.189     snj      2440: <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
                   2441:       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>
                   2442: <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   2443:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.189     snj      2444: <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   2445:       does various checks on the complete pkgsrc system.</p></li>
1.189     snj      2446: <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   2447:       packages you have installed.</p></li>
                   2448: </ul></div>
                   2449: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2450: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2451: <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   2452:       making and maintaining patches for a package (includes pkgdiff,
                   2453:       pkgvi, mkpatches, etc.).</p></li>
1.189     snj      2454: <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   2455:       converting to pkgsrc.</p></li>
                   2456: </ul></div>
                   2457: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2458: utilities)</p>
1.148     asau     2459: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2460: <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   2461:       packages in a chrooted area.</p></li>
1.189     snj      2462: <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   2463:       kernel version for chrooted cross builds.</p></li>
                   2464: </ul></div>
                   2465: </div>
1.148     asau     2466: <div class="sect1">
1.75      rillig   2467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2468: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2469: <p>To install packages from source as a non-root user, download
                   2470: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
                   2471: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2472: --unprivileged</strong></span>.</p>
                   2473: <p>This will install the binary part of pkgsrc to
                   2474: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2475: into <code class="filename">~/pkg/etc</code>.</p>
                   2476: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2477: </div>
1.148     asau     2478: <div class="sect1">
1.75      rillig   2479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2480: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2481: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2482: enable this feature by adding the option
                   2483: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2484: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2485: distfile is found, pkgsrc will try to resume it.</p>
                   2486: <p>You can also
1.168     wiz      2487: use a different program than the platform default program by changing the
1.117     jnemeth  2488: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2489: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2490: by using the value manual.  A value of custom disables the system defaults
                   2491: and dependency tracking for the fetch program.  In that case you have to
                   2492: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2493: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2494: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2495: <p>For example, if you want to use
1.117     jnemeth  2496: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2497: like:</p>
                   2498: <pre class="programlisting">
1.223     rillig   2499: FETCH_USING=    wget
1.1       grant    2500: </pre>
1.75      rillig   2501: </div>
1.148     asau     2502: <div class="sect1">
1.75      rillig   2503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2504: <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      2505: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   2506: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   2507: you will have to add the following line into
1.110     hubertf  2508: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   2509: <pre class="programlisting">
1.103     wiz      2510: X11_TYPE=modular
1.1       grant    2511: </pre>
1.148     asau     2512: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   2513: <h3 class="title">Note</h3>
1.103     wiz      2514: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   2515: </p>
1.75      rillig   2516: </div>
                   2517: </div>
1.148     asau     2518: <div class="sect1">
1.75      rillig   2519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2520: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   2521: <p>If you are sitting behind a firewall which does not allow direct
                   2522: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2523: relevant proxy hosts.  This is done using an environment variable in the
                   2524: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      2525: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   2526: port 80 as the proxy port number.  So the proxy environment variables
                   2527: are:</p>
                   2528: <pre class="programlisting">
1.100     rillig   2529: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2530: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    2531: </pre>
1.75      rillig   2532: </div>
1.148     asau     2533: <div class="sect1">
1.75      rillig   2534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2535: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      2536: <p>Some fetch tools are not prepared to support HTTPS by default
                   2537: (for example, the one in NetBSD 6.0), or the one installed by the
                   2538: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2539: dependency graph).</p>
                   2540: <p>Usually you won't notice, because distribution files are
                   2541: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2542: be often enough if you are following pkgsrc-current. In that case, set
                   2543: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2544: <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
                   2545: with HTTPS support by default. Of course, these tools need to be
                   2546: installed before you can use them this way.</p>
                   2547: </div>
                   2548: <div class="sect1">
                   2549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2550: <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   2551: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   2552: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   2553: the first available command from the following list:</p>
1.148     asau     2554: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2555: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2556: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   2557: </ul></div>
                   2558: <p>On a default NetBSD installation, this will be
1.76      rillig   2559: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   2560: connections first, and falls back to active connections if the server
                   2561: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  2562: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   2563: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2564: <p>Having that option present will prevent
1.76      rillig   2565: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   2566: transfers.</p>
                   2567: </div>
1.148     asau     2568: <div class="sect1">
1.75      rillig   2569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2570: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      2571: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  2572: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      2573: 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   2574: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  2575: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   2576: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   2577: resulting list to your machine at work/school and use it there.  If you
1.189     snj      2578: 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   2579: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2580: URL:</p>
                   2581: <p>At home:</p>
                   2582: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2583: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2584: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2585: <p>At work:</p>
                   2586: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   2587: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   2588: home.</p>
                   2589: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      2590: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2591: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  2592: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      2593: directly by running:</p>
1.75      rillig   2594: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2595: <p>If you even decide to ignore
                   2596: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2597: by running:</p>
                   2598: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2599: </div>
1.148     asau     2600: <div class="sect1">
1.75      rillig   2601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2602: <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      2603: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.189     snj      2604: <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   2605: package, you get the error from make that it doesn't know how to make
1.76      rillig   2606: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      2607: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   2608: the NetBSD base distribution on your machine.  It is recommended to do
                   2609: that to format man pages.</p>
1.189     snj      2610: <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   2611: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  2612: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   2613: </div>
1.148     asau     2614: <div class="sect1">
1.75      rillig   2615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2616: <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      2617: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   2618: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   2619: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   2620: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2621: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   2622: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  2623: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   2624: -r</strong></span>).</p>
                   2625: </div>
1.148     asau     2626: <div class="sect1">
1.75      rillig   2627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2628: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   2629: <p>When installing packages as non-root user and using the just-in-time
1.189     snj      2630: <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   2631: password for each required package installed.  To avoid this, the sudo
                   2632: package can be used, which does password caching over a limited time.  To
                   2633: use it, install sudo (either as binary package or from
1.189     snj      2634: <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  2635: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      2636: <span class="emphasis"><em>after</em></span> the definition of the
                   2637: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   2638: <pre class="programlisting">
1.100     rillig   2639: .if exists(${LOCALBASE}/bin/sudo)
                   2640: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2641: .endif
1.1       grant    2642: </pre>
1.75      rillig   2643: </div>
1.148     asau     2644: <div class="sect1">
1.75      rillig   2645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2646: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   2647: <p>As the system administrator, you can choose where configuration files
                   2648: are installed.  The default settings make all these files go into
1.76      rillig   2649: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   2650: be suboptimal depending on your expectations (e.g., a read-only,
                   2651: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   2652: configuration of the provided packages).</p>
                   2653: <p>In order to change the defaults, you can modify the
                   2654: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  2655: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   2656: directory; some common examples include <code class="filename">/etc</code> or
                   2657: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   2658: <p>Furthermore, you can change this value on a per-package basis by
                   2659: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   2660: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   2661: package you would like to modify, that is, the contents of
                   2662: <code class="varname">PKGBASE</code>.</p>
                   2663: <p>Note that after changing these settings, you must rebuild and
                   2664: reinstall any affected packages.</p>
                   2665: </div>
1.148     asau     2666: <div class="sect1">
1.75      rillig   2667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2668: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75      rillig   2669: <p>Please be aware that there can often be bugs in third-party software,
                   2670: and some of these bugs can leave a machine vulnerable to exploitation by
                   2671: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   2672: maintains a database of known-exploits to packages which have at one time
                   2673: been included in pkgsrc.  The database can be downloaded automatically, and
                   2674: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 2675: do this, refer to the following two tools (installed as part of the
1.189     snj      2676: <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      2677: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2678: <li class="listitem">
1.122     reed     2679: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   2680:     download a list of the security vulnerabilities information.  This list
1.132     spz      2681:     is kept up to date by the pkgsrc security team, and is distributed
                   2682:     from the NetBSD ftp server:</p>
                   2683: <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   2684: </li>
1.128     wiz      2685: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   2686:     current machine, checking each known vulnerability.  If a
1.75      rillig   2687:     vulnerable package is installed, it will be shown by output to stdout,
                   2688:     including a description of the type of vulnerability, and a URL
                   2689:     containing more information.</p></li>
                   2690: </ol></div>
1.114     jmcneill 2691: <p>Use of these tools is strongly recommended!  After
1.128     wiz      2692: <span class="quote">&#8220;<span class="quote">pkg_install</span>&#8221;</span> is installed, please read
1.75      rillig   2693: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114     jmcneill 2694: pkg_install</code></strong>.</p>
1.87      wiz      2695: <p>If this package is installed, pkgsrc builds will use it to
1.110     hubertf  2696: 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      2697: check.</p>
1.75      rillig   2698: </div>
1.148     asau     2699: <div class="sect1">
1.75      rillig   2700: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2701: <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   2702: <p>When you add your own preferences to the
                   2703:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  2704:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   2705:        environment variables to the <code class="filename">./configure</code>
1.189     snj      2706:        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   2707:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   2708:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   2709:        package.</p>
                   2710: <p>Currently there is no solution to this problem. If you
                   2711:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  2712:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   2713:        directory and then inspect any <code class="filename">Makefile</code> and
                   2714:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   2715:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      2716:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   2717:        programmers write so bad code that it only works for the
                   2718:        specific combination of <code class="varname">CFLAGS</code> they have
                   2719:        chosen.</p>
                   2720: </div>
1.148     asau     2721: <div class="sect1">
1.80      rillig   2722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2723: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      2724: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     2725: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   2726:        case that occurs often is that people only update pkgsrc in
                   2727:        parts, because of performance reasons. Since pkgsrc is one large
                   2728:        system, not a collection of many small systems, there are
                   2729:        sometimes changes that only work when the whole pkgsrc tree is
                   2730:        updated.</p></li>
1.148     asau     2731: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      2732:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   2733:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   2734:        files.</p></li>
1.148     asau     2735: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  2736:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   2737:        verify this.</p></li>
1.218     rillig   2738: <li class="step"><p>If you are a package developer who wants to invest
                   2739:        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     2740: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   2741:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   2742: </ol></div>
                   2743: </div>
1.148     asau     2744: <div class="sect1">
1.88      wiz      2745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2746: <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   2747: <p>You have modified a file from pkgsrc, and someone else has
                   2748: modified that same file afterwards in the CVS repository. Both changes
                   2749: are in the same region of the file, so when you updated pkgsrc, the
                   2750: <code class="literal">cvs</code> command marked the conflicting changes in the
                   2751: file. Because of these markers, the file is no longer a valid
                   2752: <code class="filename">Makefile</code>.</p>
                   2753: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  2754: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   2755: -dP</strong></span> in that directory to download the current version.</p>
                   2756: </div>
1.75      rillig   2757: </div>
                   2758: </div>
1.148     asau     2759: <div class="part">
1.75      rillig   2760: <div class="titlepage"><div><div><h1 class="title">
                   2761: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     2762: <div class="partintro">
1.77      rillig   2763: <div></div>
                   2764: <p>This part of the book deals with creating and
1.128     wiz      2765:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   2766:        guide on creating a new package. The remaining chapters are more
                   2767:        like a reference manual for pkgsrc.</p>
1.75      rillig   2768: <div class="toc">
                   2769: <p><b>Table of Contents</b></p>
1.210     leot     2770: <dl class="toc">
1.106     rillig   2771: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   2772: <dd><dl>
1.106     rillig   2773: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   2774: <dd><dl>
1.106     rillig   2775: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174     asau     2776: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118     imil     2777: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   2778: </dl></dd>
1.106     rillig   2779: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   2780: <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>
                   2781: </dl></dd>
                   2782: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   2783: <dd><dl>
1.128     wiz      2784: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   2785: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219     rillig   2786: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig   2787: <dd><dl>
                   2788: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   2789: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   2790: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   2791: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   2792: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   2793: </dl></dd>
                   2794: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   2795: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   2796: <dd><dl>
                   2797: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   2798: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   2799: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   2800: </dl></dd>
1.128     wiz      2801: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   2802: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   2803: </dl></dd>
1.128     wiz      2804: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   2805: <dd><dl>
                   2806: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      2807: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   2808: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   2809: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   2810: <dd><dl>
                   2811: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228     yyamano  2812: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220     wiz      2813: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                   2814: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig   2815: </dl></dd>
                   2816: </dl></dd>
                   2817: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   2818: <dd><dl>
                   2819: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      2820: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   2821: <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   2822: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   2823: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      2824: <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   2825: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz      2826: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   2827: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106     rillig   2828: </dl></dd>
                   2829: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   2830: <dd><dl>
                   2831: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      2832: <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   2833: <dd><dl>
                   2834: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      2835: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   2836:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2837:       and
                   2838:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2839:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   2840: </dl></dd>
1.128     wiz      2841: <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   2842: <dd><dl>
1.128     wiz      2843: <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   2844: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   2845: </dl></dd>
                   2846: </dl></dd>
                   2847: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   2848: <dd><dl>
                   2849: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   2850: <dd><dl>
                   2851: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   2852: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   2853: </dl></dd>
                   2854: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   2855: <dd><dl>
1.128     wiz      2856: <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   2857: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   2858: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   2859: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   2860: </dl></dd>
                   2861: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   2862: <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>
                   2863: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   2864: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   2865: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   2866: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   2867: <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>
                   2868: </dl></dd>
                   2869: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   2870: <dd><dl>
                   2871: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      2872: <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   2873: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   2874: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   2875: </dl></dd>
                   2876: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   2877: <dd><dl>
                   2878: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   2879: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   2880: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   2881: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      2882: <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   2883: <dd><dl>
                   2884: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   2885: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   2886: </dl></dd>
1.128     wiz      2887: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   2888: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   2889: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   2890: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   2891: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   2892: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2893: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2894: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   2895: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2896: <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   2897: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   2898: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   2899: </dl></dd>
                   2900: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   2901: <dd><dl>
                   2902: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   2903: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   2904: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   2905: </dl></dd>
                   2906: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   2907: <dd><dl>
                   2908: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   2909: <dd><dl>
1.218     rillig   2910: <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>
                   2911: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                   2912: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                   2913: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                   2914: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                   2915: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                   2916: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                   2917: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   2918: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                   2919: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   2920: <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   2921: </dl></dd>
1.218     rillig   2922: <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   2923: <dd><dl>
                   2924: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   2925: <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      2926: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig   2927: </dl></dd>
1.218     rillig   2928: <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   2929: <dd><dl>
                   2930: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   2931: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   2932: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   2933: </dl></dd>
                   2934: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   2935: <dd><dl>
                   2936: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   2937: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   2938: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      2939: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   2940: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   2941: </dl></dd>
1.218     rillig   2942: <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   2943: <dd><dl>
                   2944: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   2945: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      2946: <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   2947: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   2948: </dl></dd>
1.218     rillig   2949: <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   2950: <dd><dl>
                   2951: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   2952: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   2953: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   2954: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   2955: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   2956: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   2957: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   2958: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   2959: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   2960: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   2961: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   2962: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   2963: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   2964: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   2965: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   2966: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   2967: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   2968: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      2969:     emulation</a></span></dt>
1.106     rillig   2970: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   2971: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   2972: </dl></dd>
1.106     rillig   2973: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   2974: </dl></dd>
1.106     rillig   2975: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   2976: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   2977: <dd><dl>
1.106     rillig   2978: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   2979: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   2980: <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      2981: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig   2982: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     2983: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   2984: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig   2985: </dl></dd>
                   2986: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   2987: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   2988: <dd><dl>
                   2989: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   2990: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   2991: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   2992: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     2993: </dl></dd>
1.75      rillig   2994: </dl>
                   2995: </div>
1.77      rillig   2996: </div>
1.148     asau     2997: <div class="chapter">
1.77      rillig   2998: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2999: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3000: <div class="toc">
                   3001: <p><b>Table of Contents</b></p>
1.210     leot     3002: <dl class="toc">
1.106     rillig   3003: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3004: <dd><dl>
1.106     rillig   3005: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174     asau     3006: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118     imil     3007: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3008: </dl></dd>
1.106     rillig   3009: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3010: <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   3011: </dl>
                   3012: </div>
1.77      rillig   3013: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3014: most likely have a URL from where you can download the source
                   3015: code. Starting with this URL, creating a package involves only a
                   3016: few steps.</p>
1.128     wiz      3017: <div class="procedure"><ol class="procedure" type="1">
1.189     snj      3018: <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     3019: <li class="step"><p>Then, choose one of the top-level directories as the
1.91      rillig   3020: category in which you want to place your package. You can also create a
                   3021: directory of your own (maybe called <code class="filename">local</code>). In that
                   3022: category directory, create another directory for your package and change
                   3023: into it.</p></li>
1.148     asau     3024: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3025: you for a URL. Enter the URL of the distribution file (in most cases a
                   3026: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3027: of your package are created automatically. The distribution file is
                   3028: extracted automatically to fill in some details in the
                   3029: <code class="filename">Makefile</code> that would otherwise have to be done
                   3030: manually.</p></li>
1.148     asau     3031: <li class="step">
1.91      rillig   3032: <p>Examine the extracted files to determine the dependencies of
                   3033: your package. Ideally, this is mentioned in some
                   3034: <code class="filename">README</code> file, but things may differ. For each of
                   3035: these dependencies, look where it exists in pkgsrc, and if there is a
                   3036: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3037: line to your package <code class="filename">Makefile</code> which includes that
                   3038: file just before the last line. If the
1.132     spz      3039: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3040: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3041: <p>If you just need binaries from a package, add a
1.91      rillig   3042: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3043: version of the dependency and where it can be found in pkgsrc. This line
                   3044: should be placed in the third paragraph. If the dependency is only
                   3045: needed for building the package, but not when using it, use
                   3046: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3047: Your package may then look like this:</p>
1.77      rillig   3048: <pre class="programlisting">
1.100     rillig   3049: [...]
1.77      rillig   3050: 
1.174     asau     3051: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100     rillig   3052: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3053: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3054: 
1.100     rillig   3055: [...]
1.77      rillig   3056: 
1.100     rillig   3057: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3058: .include "../../devel/glib2/buildlink3.mk"
                   3059: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3060: </pre>
                   3061: </li>
1.148     asau     3062: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128     wiz      3063: 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  3064: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3065: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3066: -e</strong></span>, which outputs additional
                   3067: explanations.</p></li>
1.148     asau     3068: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  3069: 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   3070: over there, you can hopefully continue here.</p></li>
1.148     asau     3071: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3072: directory from the extracted files. Besides these files, a lot of cache
                   3073: files and other system information has been saved in the working
                   3074: directory, which may become wrong after you edited the
                   3075: <code class="filename">Makefile</code>.</p></li>
1.148     asau     3076: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110     hubertf  3077: 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     3078: <li class="step"><p>When the package builds fine, the next step is to install
1.110     hubertf  3079: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3080: everything works.</p></li>
1.148     asau     3081: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91      rillig   3082: contains a list of the files that are installed by the package, is
1.110     hubertf  3083: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3084: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3085: the file using your preferred text editor to see if the list of
                   3086: files looks plausible.</p></li>
1.148     asau     3087: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3088: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148     asau     3089: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3090: has been registered in the database of installed files, but with an
1.110     hubertf  3091: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3092: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3093: registered with the list of files from
                   3094: <code class="filename">PLIST</code>.</p></li>
1.148     asau     3095: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3096: package from the set of installed files.</p></li>
1.77      rillig   3097: </ol></div>
1.148     asau     3098: <div class="sect1">
1.91      rillig   3099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3100: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148     asau     3101: <div class="sect2">
1.91      rillig   3102: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3103: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   3104: <p>Simple Perl modules are handled automatically by
1.110     hubertf  3105: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   3106: </div>
1.148     asau     3107: <div class="sect2">
1.91      rillig   3108: <div class="titlepage"><div><div><h3 class="title">
1.174     asau     3109: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
                   3110: <p>KDE3 applications should always include
1.91      rillig   3111: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.174     asau     3112: settings that are typical of KDE3 packages.</p>
1.91      rillig   3113: </div>
1.148     asau     3114: <div class="sect2">
1.118     imil     3115: <div class="titlepage"><div><div><h3 class="title">
                   3116: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   3117: <p>Python modules and programs packages are easily created using a
                   3118: set of predefined variables.</p>
                   3119: <p>
1.171     wiz      3120: If some Python versions are not supported by the software, set the
                   3121: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   3122: that are not supported, e.g.
1.118     imil     3123: </p>
                   3124: <pre class="programlisting">
1.203     sevan    3125: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.118     imil     3126: </pre>
                   3127: <p>
1.213     wiz      3128: If the packaged software is a Python module, include one of
                   3129: <code class="filename">../../lang/python/egg.mk</code>,
                   3130: <code class="filename">../../lang/python/distutils.mk</code>, or
                   3131: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   3132: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3133: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3134: if the packaged software is using setuptools, you only need
                   3135: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   3136: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   3137: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>.
                   3138: so pkgsrc will use this framework.
                   3139: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3140: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   3141: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3142: to the name of the script.</p>
                   3143: <p>Either way, the package directory should be called
1.128     wiz      3144: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3145: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.118     imil     3146: </p>
                   3147: <pre class="programlisting">
                   3148: DISTNAME=   foopymodule-1.2.10
                   3149: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3150: </pre>
1.171     wiz      3151: <p>If it is an application, include
                   3152: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   3153: In order to correctly set the path to the Python interpreter, use the
1.118     imil     3154: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142     wiz      3155: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171     wiz      3156: For example:
1.118     imil     3157: </p>
                   3158: <pre class="programlisting">
1.142     wiz      3159: REPLACE_PYTHON=   *.py
1.118     imil     3160: </pre>
1.171     wiz      3161: <p>Some Python modules have separate distributions for Python-2.x
                   3162: and Python-3.x support. In pkgsrc this is handled by the
                   3163: <code class="filename">versioned_dependencies.mk</code> file. Set
                   3164: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   3165: packages that should be depended upon and include
                   3166: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   3167: then the pkgsrc infrastructure will depend on the appropriate package
                   3168: version. For example:
                   3169: </p>
                   3170: <pre class="programlisting">
1.221     wiz      3171: PYTHON_VERSIONED_DEPENDENCIES=dateutil
1.171     wiz      3172: </pre>
                   3173: <p>
                   3174: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   3175: of supported packages.</p>
1.118     imil     3176: </div>
1.91      rillig   3177: </div>
1.148     asau     3178: <div class="sect1">
1.91      rillig   3179: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3180: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148     asau     3181: <div class="sect2">
1.91      rillig   3182: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3183: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148     asau     3184: <div class="sect3">
1.91      rillig   3185: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3186: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   3187: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128     wiz      3188: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.91      rillig   3189: pkgsrc. As the description says it has to do with the web, the obvious
1.128     wiz      3190: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.91      rillig   3191: <pre class="programlisting">
1.100     rillig   3192: <code class="prompt">$</code> mkdir www/nvu
                   3193: <code class="prompt">$</code> cd www/nvu
1.91      rillig   3194: </pre>
                   3195: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  3196: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   3197: <pre class="programlisting">
1.100     rillig   3198: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   3199: </pre>
                   3200: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3201: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128     wiz      3202: 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   3203: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3204: <code class="varname">COMMENT</code> fields. Then the package
                   3205: <code class="filename">Makefile</code> looked like that:</p>
                   3206: <pre class="programlisting">
1.100     rillig   3207: # $NetBSD$
                   3208: #
1.91      rillig   3209: 
1.100     rillig   3210: DISTNAME=       nvu-1.0-sources
                   3211: PKGNAME=        nvu-1.0
                   3212: CATEGORIES=     www
                   3213: MASTER_SITES=   http://cvs.nvu.com/download/
                   3214: EXTRACT_SUFX=   .tar.bz2
                   3215: 
                   3216: MAINTAINER=     rillig@NetBSD.org
                   3217: HOMEPAGE=       http://cvs.nvu.com/
                   3218: COMMENT=        Web Authoring System
1.91      rillig   3219: 
1.100     rillig   3220: # url2pkg-marker (please do not remove this line.)
                   3221: .include "../../mk/bsd.pkg.mk"
1.91      rillig   3222: </pre>
                   3223: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3224: source archive:</p>
                   3225: <pre class="programlisting">
1.100     rillig   3226: url2pkg&gt; Running "make makesum" ...
                   3227: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3228: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3229: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3230: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3231: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3232: url2pkg&gt; Running "make extract" ...
                   3233: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3234: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3235: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3236: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3237: ===&gt; Installing dependencies for nvu-1.0
                   3238: ===&gt; Overriding tools for nvu-1.0
                   3239: ===&gt; Extracting for nvu-1.0
                   3240: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   3241: 
1.100     rillig   3242: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   3243: 
1.100     rillig   3244: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   3245: </pre>
                   3246: </div>
1.148     asau     3247: <div class="sect3">
1.91      rillig   3248: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3249: <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   3250: <p>Now that the package has been extracted, let's see what's inside
                   3251: it. The package has a <code class="filename">README.txt</code>, but that only
                   3252: says something about mozilla, so it's probably useless for seeing what
                   3253: dependencies this package has. But since there is a GNU configure script
                   3254: in the package, let's hope that it will complain about everything it
                   3255: needs.</p>
                   3256: <pre class="programlisting">
1.100     rillig   3257: <code class="prompt">$</code> bmake
                   3258: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3259: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3260: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3261: ===&gt; Patching for nvu-1.0
                   3262: ===&gt; Creating toolchain wrappers for nvu-1.0
                   3263: ===&gt; Configuring for nvu-1.0
                   3264: [...]
                   3265: configure: error: Perl 5.004 or higher is required.
                   3266: [...]
                   3267: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3268: [...]
1.91      rillig   3269: </pre>
                   3270: <p>That worked quite well. So I opened the package Makefile in my
                   3271: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128     wiz      3272: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.91      rillig   3273: package have changed now, and since a perl wrapper is automatically
1.128     wiz      3274: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.91      rillig   3275: from scratch.</p>
                   3276: <pre class="programlisting">
1.100     rillig   3277: <code class="prompt">$</code> bmake clean
                   3278: ===&gt; Cleaning for nvu-1.0
                   3279: <code class="prompt">$</code> bmake
                   3280: [...]
                   3281: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   3282: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   3283: [...]
1.91      rillig   3284: </pre>
1.128     wiz      3285: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.91      rillig   3286: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   3287: <pre class="programlisting">
1.100     rillig   3288: [...]
                   3289: checking for GTK - version &gt;= 1.2.0... no
                   3290: *** Could not run GTK test program, checking why...
                   3291: [...]
1.91      rillig   3292: </pre>
                   3293: <p>Now to the other dependencies. The first question is: Where is the
                   3294: GTK package hidden in pkgsrc?</p>
                   3295: <pre class="programlisting">
1.100     rillig   3296: <code class="prompt">$</code> echo ../../*/gtk*
                   3297: [many packages ...]
                   3298: <code class="prompt">$</code> echo ../../*/gtk
                   3299: ../../x11/gtk
                   3300: <code class="prompt">$</code> echo ../../*/gtk2
                   3301: ../../x11/gtk2
                   3302: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   3303: ../../x11/gtk2/buildlink3.mk
1.91      rillig   3304: </pre>
                   3305: <p>The first try was definitely too broad. The second one had exactly
                   3306: one result, which is very good. But there is one pitfall with GNOME
                   3307: packages. Before GNOME 2 had been released, there were already many
                   3308: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   3309: packages, the GNOME 2 packages were imported as separate packages, and
1.128     wiz      3310: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.91      rillig   3311: whether this was the case here, and indeed it was.</p>
                   3312: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   3313: file, adding the dependency is very easy. I just inserted an
                   3314: <code class="literal">.include</code> line before the last line of the package
                   3315: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   3316: <pre class="programlisting">
1.100     rillig   3317: [...]
                   3318: .include "../../x11/gtk2/buildlink3.mk"
                   3319: .include "../../mk/bsd.pkg.mk
1.91      rillig   3320: </pre>
1.110     hubertf  3321: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   3322: was:</p>
                   3323: <pre class="programlisting">
1.100     rillig   3324: [...]
                   3325: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   3326: checking for GTK - version &gt;= 1.2.0... no
                   3327: *** Could not run GTK test program, checking why...
                   3328: *** The test program failed to compile or link. See the file config.log for the
                   3329: *** exact error that occured. This usually means GTK was incorrectly installed
                   3330: *** or that you have moved GTK since it was installed. In the latter case, you
                   3331: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   3332: configure: error: Test for GTK failed.
                   3333: [...]
1.91      rillig   3334: </pre>
1.128     wiz      3335: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   3336: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.91      rillig   3337: told me that this package really wanted to have the GNOME 1 version of
                   3338: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  3339: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   3340: So I changed the <code class="literal">x11/gtk2</code> to
                   3341: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   3342: and tried again.</p>
                   3343: <pre class="programlisting">
1.100     rillig   3344: [...]
1.166     jnemeth  3345: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
1.100     rillig   3346: In file included from xpidl.c:42:
                   3347: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   3348: In file included from xpidl.c:42:
                   3349: xpidl.h:132: error: parse error before "IDL_ns"
                   3350: [...]
1.91      rillig   3351: </pre>
                   3352: <p>The package still does not find all of its dependencies. Now the
                   3353: question is: Which package provides the
                   3354: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   3355: <pre class="programlisting">
1.100     rillig   3356: <code class="prompt">$</code> echo ../../*/*idl*
                   3357: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   3358: <code class="prompt">$</code> echo ../../*/*IDL*
                   3359: ../../net/libIDL
1.91      rillig   3360: </pre>
                   3361: <p>Let's take the one from the second try. So I included the
                   3362: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   3363: again. But the error didn't change. After digging through some of the
                   3364: code, I concluded that the build process of the package was broken and
                   3365: couldn't have ever worked, but since the Mozilla source tree is quite
                   3366: large, I didn't want to fix it. So I added the following to the package
                   3367: <code class="filename">Makefile</code> and tried again:</p>
                   3368: <pre class="programlisting">
1.100     rillig   3369: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   3370: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   3371: </pre>
                   3372: <p>The latter line is needed because the package expects the library
                   3373: <code class="filename">libIDL.so</code>, but only
                   3374: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   3375: wrapper to rewrite that on the fly.</p>
                   3376: <p>The next problem was related to a recent change of the FreeType
1.189     snj      3377: 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   3378: which patch files were relevant for this issue and copied them to the
                   3379: <code class="filename">patches</code> directory. Then I retried, fixed the
                   3380: patches so that they applied cleanly and retried again. This time,
                   3381: everything worked.</p>
                   3382: </div>
1.148     asau     3383: <div class="sect3">
1.91      rillig   3384: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3385: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   3386: <pre class="programlisting">
1.100     rillig   3387: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   3388: [...]
                   3389: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   3390: <code class="prompt">$</code> bmake deinstall
                   3391: <code class="prompt">$</code> bmake install
1.91      rillig   3392: </pre>
                   3393: </div>
                   3394: </div>
                   3395: </div>
1.77      rillig   3396: </div>
1.148     asau     3397: <div class="chapter">
1.75      rillig   3398: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3399: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   3400: <div class="toc">
                   3401: <p><b>Table of Contents</b></p>
1.210     leot     3402: <dl class="toc">
1.128     wiz      3403: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3404: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219     rillig   3405: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig   3406: <dd><dl>
                   3407: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3408: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3409: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3410: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3411: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3412: </dl></dd>
                   3413: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3414: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3415: <dd><dl>
                   3416: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3417: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3418: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   3419: </dl></dd>
1.128     wiz      3420: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3421: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   3422: </dl>
                   3423: </div>
1.87      wiz      3424: <p>Whenever you're preparing a package, there are a number of
                   3425: files involved which are described in the following
                   3426: sections.</p>
1.148     asau     3427: <div class="sect1">
1.75      rillig   3428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3429: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93      rillig   3430: </h2></div></div></div>
1.75      rillig   3431: <p>Building, installation and creation of a binary package are all
1.87      wiz      3432:   controlled by the package's <code class="filename">Makefile</code>.
                   3433:   The <code class="filename">Makefile</code> describes various things about
                   3434:   a package, for example from where to get it, how to configure,
                   3435:   build, and install it.</p>
1.76      rillig   3436: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      3437:   sections that describe the package.</p>
1.75      rillig   3438: <p>In the first section there are the following variables, which
1.87      wiz      3439:   should appear exactly in the order given here.  The order and
                   3440:   grouping of the variables is mostly historical and has no further
                   3441:   meaning.</p>
1.148     asau     3442: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3443: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      3444:     distribution file to be downloaded from the package's
                   3445:     website.</p></li>
1.128     wiz      3446: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174     asau     3447:     package, as used by pkgsrc. You need to provide it if
1.87      wiz      3448:     <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174     asau     3449:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3450:     provided (no distribution file is required).  Usually it is the pkgsrc
1.87      wiz      3451:     directory name together with the version number. It must match the
                   3452:     regular expression
                   3453:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3454:     starts with a letter or digit, and contains only letters, digits,
                   3455:     dashes, underscores, dots and plus signs.</p></li>
1.128     wiz      3456: <li class="listitem">
1.75      rillig   3457: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      3458:     which the package fits in. You can choose any of the top-level
                   3459:     directories of pkgsrc for it.</p>
1.75      rillig   3460: <p>Currently the following values are available for
1.87      wiz      3461:     <code class="varname">CATEGORIES</code>. If more than
                   3462:     one is used, they need to be separated by spaces:</p>
1.75      rillig   3463: <pre class="programlisting">
1.100     rillig   3464: archivers     cross         geography     meta-pkgs     security
                   3465: audio         databases     graphics      misc          shells
                   3466: benchmarks    devel         ham           multimedia    sysutils
                   3467: biology       editors       inputmethod   net           textproc
                   3468: cad           emulators     lang          news          time
                   3469: chat          finance       mail          parallel      wm
                   3470: comms         fonts         math          pkgtools      www
                   3471: converters    games         mbone         print         x11
                   3472: </pre>
1.75      rillig   3473: </li>
1.128     wiz      3474: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      3475:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3476:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3477:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.128     wiz      3478:     <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   3479: </ul></div>
                   3480: <p>The second section contains information about separately
1.87      wiz      3481:   downloaded patches, if any.
                   3482:   </p>
1.148     asau     3483: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190     wiz      3484: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87      wiz      3485:     Name(s) of additional files that contain distribution patches.
                   3486:     There is no default. pkgsrc will look for them at
                   3487:     <code class="varname">PATCH_SITES</code>.
                   3488:     They will automatically be uncompressed before patching if
                   3489:     the names end with <code class="filename">.gz</code> or
                   3490:     <code class="filename">.Z</code>.</p></li>
1.128     wiz      3491: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      3492:     Primary location(s) for distribution patch files (see
1.190     wiz      3493:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3494: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
                   3495:     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
                   3496:     help find the correct files to patch. It defaults to
                   3497:     <span class="command"><strong>-p0</strong></span>.</p></li>
1.75      rillig   3498: </ul></div>
                   3499: <p>The third section contains the following variables.
1.87      wiz      3500:   </p>
1.148     asau     3501: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3502: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114     jmcneill 3503:     address of the person who feels responsible for this package,
                   3504:     and who is most likely to look at problems or questions regarding
1.189     snj      3505:     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 3506:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3507:     before making changes to the package, but are not required to
                   3508:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3509:     to yourself. If you really can't maintain the package for future
                   3510:     updates, set it to
1.110     hubertf  3511:     <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      3512: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114     jmcneill 3513:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3514:     developers to update or change the package without contacting
                   3515:     you first. A package Makefile should contain one of
                   3516:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3517:     not both.  </p></li>
1.128     wiz      3518: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      3519:     find more information about the package.</p></li>
1.128     wiz      3520: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      3521:     description of the package (should not include the package
                   3522:     name).</p></li>
1.75      rillig   3523: </ul></div>
                   3524: <p>Other variables that affect the build:
1.87      wiz      3525:   </p>
1.148     asau     3526: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75      rillig   3527: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      3528:       interesting distribution files of the package are found. The
                   3529:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3530:       works for most packages.</p>
1.75      rillig   3531: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      3532:       (most GNU software does, for instance), but extracts itself in
                   3533:       the current directory, you should set
                   3534:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3535: <p>If a package doesn't create a subdirectory with the
                   3536:       name of <code class="varname">DISTNAME</code> but some different name,
                   3537:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3538:       <code class="filename">${WRKDIR}</code>, for example
                   3539:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.189     snj      3540:       <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   3541: <p>The name of the working directory created by pkgsrc is
1.87      wiz      3542:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3543:       variable. By default, its value is
                   3544:       <code class="filename">work</code>. If you want to use the same
                   3545:       pkgsrc tree for building different kinds of binary packages,
                   3546:       you can change the variable according to your needs. Two
                   3547:       other variables handle common cases of setting
                   3548:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3549:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  3550:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      3551:       the host's name is attached to the directory name. If
                   3552:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3553:       is attached, which might look like
                   3554:       <code class="filename">work.i386</code> or
                   3555:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   3556: </li></ul></div>
                   3557: <p>Please pay attention to the following gotchas:</p>
1.148     asau     3558: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3559: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      3560:       installed in compressed form by the package.  For packages using
                   3561:       BSD-style makefiles which honor MANZ, there is
                   3562:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128     wiz      3563: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3564:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.88      wiz      3565:       below).</p></li>
1.128     wiz      3566: <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   3567: </ul></div>
                   3568: </div>
1.148     asau     3569: <div class="sect1">
1.75      rillig   3570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3571: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   3572: </h2></div></div></div>
1.76      rillig   3573: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      3574:   digest, or checksum, of each distfile needed for the package. This
                   3575:   ensures that the distfiles retrieved from the Internet have not been
                   3576:   corrupted during transfer or altered by a malign force to introduce
1.219     rillig   3577:   a security hole. To provide maximum security, all distfiles are
                   3578:   protected using three different message digest algorithms (SHA1,
                   3579:   RMD160, SHA512), as well as the file size.</p>
1.76      rillig   3580: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      3581:   checksums for all the patches found in the
1.219     rillig   3582:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;<code class="filename">patches/*</code>&#8221;</a>).</p>
1.76      rillig   3583: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.219     rillig   3584:   <span class="command"><strong>make distinfo</strong></span> command.</p>
1.75      rillig   3585: <p>Some packages have different sets of distfiles depending on
1.189     snj      3586:   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      3587:   <code class="filename">distinfo</code> file and care should be taken when
                   3588:   upgrading such a package to ensure distfile information is not
                   3589:   lost.</p>
1.75      rillig   3590: </div>
1.148     asau     3591: <div class="sect1">
1.75      rillig   3592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219     rillig   3593: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
                   3594: </h2></div></div></div>
                   3595: <p>Some packages don't work out-of-the box on the various
                   3596:   platforms that are supported by pkgsrc. These packages need
                   3597:   to be patched to make them work. The patch files can be
1.93      rillig   3598:   found in the <code class="filename">patches/</code> directory.</p>
                   3599: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3600:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.219     rillig   3601:   extracting them, in alphabetic order.</p>
1.148     asau     3602: <div class="sect2">
1.93      rillig   3603: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3604: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   3605: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  3606:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   3607:   problems. (To force patches to apply with fuzz you can set
                   3608:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 3609:   should contain only changes for a single file, and no file should be
1.93      rillig   3610:   patched by more than one patch file. This helps to keep future
                   3611:   modifications simple.</p>
                   3612: <p>Each patch file is structured as follows: In the first line,
                   3613:   there is the RCS Id of the patch itself. The second line should be
                   3614:   empty for aesthetic reasons. After that, there should be a comment for
                   3615:   each change that the patch does. There are a number of standard
                   3616:   cases:</p>
1.148     asau     3617: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3618: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93      rillig   3619:   mention the vulnerability ID (CAN, CVE).</p></li>
1.128     wiz      3620: <li class="listitem"><p>Patches that change source code should mention the
1.93      rillig   3621:   platform and other environment (for example, the compiler) that the
                   3622:   patch is needed for.</p></li>
                   3623: </ul></div>
1.219     rillig   3624: <p>The patch should be commented so that any
1.93      rillig   3625:   developer who knows the code of the application can make some use of
                   3626:   the patch. Special care should be taken for the upstream developers,
                   3627:   since we generally want that they accept our patches, so we have less
                   3628:   work in the future.</p>
                   3629: </div>
1.148     asau     3630: <div class="sect2">
1.93      rillig   3631: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3632: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   3633: <p>One important thing to mention is to pay attention that no RCS
                   3634:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      3635:   later checked into the NetBSD CVS tree. Use the
1.189     snj      3636:   <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   3637:   problems.</p>
1.87      wiz      3638: <p>For even more automation, we recommend using
1.110     hubertf  3639:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      3640:   whole set of patches. You just have to backup files before you
                   3641:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  3642:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3643:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      3644:   you upgrade a package this way, you can easily compare the new
                   3645:   set of patches with the previously existing one with
1.130     wiz      3646:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3647:   are replaced by new files, so carefully check if you want to take all
                   3648:   the changes.</p>
1.87      wiz      3649: <p>When you have finished a package, remember to generate
1.110     hubertf  3650:   the checksums for the patch files by using the <span class="command"><strong>make
1.128     wiz      3651:   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      3652: <p>When adding a patch that corrects a problem in the
                   3653:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3654:   man pages should go), send the patch as a bug report to the
                   3655:   maintainer.  This benefits non-pkgsrc users of the package,
                   3656:   and usually makes it possible to remove the patch in future
                   3657:   version.</p>
1.101     rillig   3658: <p>The file names of the patch files are usually of the form
1.130     wiz      3659:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3660:   Many packages still use the previous convention
                   3661:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3662:   but new patches should be of the form containing the filename.
1.189     snj      3663:   <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      3664:   automatically.</p>
1.93      rillig   3665: </div>
1.148     asau     3666: <div class="sect2">
1.93      rillig   3667: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3668: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      3669: <p>If you want to share patches between multiple packages
                   3670:   in pkgsrc, e.g. because they use the same distfiles, set
                   3671:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3672:   can be found, e.g.:</p>
                   3673: <pre class="programlisting">
1.100     rillig   3674: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   3675: </pre>
1.75      rillig   3676: <p>Patch files that are distributed by the author or other
1.87      wiz      3677:     maintainers can be listed in
                   3678:     <code class="varname">PATCHFILES</code>.</p>
                   3679: <p>If it is desired to store any patches that should not be
                   3680:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3681:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3682:     directory tree there is expected to have the same
1.128     wiz      3683:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.87      wiz      3684:     patches are expected to be stored inside these dirs (also
                   3685:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3686:     example, if you want to keep a private patch for
                   3687:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3688:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3689:     files in the named directory are expected to be patch files,
                   3690:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3691:     applied</em></span>.</p>
1.93      rillig   3692: </div>
1.148     asau     3693: <div class="sect2">
1.85      jmmv     3694: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3695: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     3696: <p>When fixing a portability issue in the code do not use
                   3697:       preprocessor magic to check for the current operating system nor
                   3698:       platform.  Doing so hurts portability to other platforms because
                   3699:       the OS-specific details are not abstracted appropriately.</p>
                   3700: <p>The general rule to follow is: instead of checking for the
                   3701:       operating system the application is being built on, check for the
                   3702:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3703:       instead of assuming that kqueue is available under NetBSD and
                   3704:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126     jakllsch 3705:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     3706:       yes, this generally involves patching the
1.110     hubertf  3707:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     3708:       that prevents some OSes from adopting interfaces from other OSes
                   3709:       (e.g. Linux implementing kqueue), something that the above checks
                   3710:       cannot take into account.</p>
                   3711: <p>Of course, checking for features generally involves more
                   3712:       work on the developer's side, but the resulting changes are
1.87      wiz      3713:       cleaner and there are chances they will work on many other
1.85      jmmv     3714:       platforms.  Not to mention that there are higher chances of being
                   3715:       later integrated into the mainstream sources.  Remember:
                   3716:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3717: <p>Some typical examples:</p>
                   3718: <div class="table">
1.106     rillig   3719: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.216     tnn      3720: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.85      jmmv     3721: <colgroup>
                   3722: <col>
                   3723: <col>
                   3724: <col>
                   3725: </colgroup>
                   3726: <thead><tr>
                   3727: <th>Where</th>
                   3728: <th>Incorrect</th>
                   3729: <th>Correct</th>
                   3730: </tr></thead>
                   3731: <tbody>
                   3732: <tr>
                   3733: <td>configure script</td>
                   3734: <td>
1.100     rillig   3735: <pre class="programlisting">
                   3736: case ${target_os} in
                   3737: netbsd*) have_kvm=yes ;;
                   3738: *)       have_kvm=no  ;;
                   3739: esac
                   3740: </pre>
1.85      jmmv     3741:              </td>
                   3742: <td>
1.100     rillig   3743: <pre class="programlisting">
                   3744: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   3745: </pre>
1.85      jmmv     3746:              </td>
                   3747: </tr>
                   3748: <tr>
                   3749: <td>C source file</td>
                   3750: <td>
1.100     rillig   3751: <pre class="programlisting">
                   3752: #if defined(__NetBSD__)
                   3753: #  include &lt;sys/event.h&gt;
                   3754: #endif
                   3755: </pre>
1.85      jmmv     3756:              </td>
                   3757: <td>
1.100     rillig   3758: <pre class="programlisting">
                   3759: #if defined(HAVE_SYS_EVENT_H)
                   3760: #  include &lt;sys/event.h&gt;
                   3761: #endif
                   3762: </pre>
1.85      jmmv     3763:              </td>
                   3764: </tr>
                   3765: <tr>
                   3766: <td>C source file</td>
                   3767: <td>
1.100     rillig   3768: <pre class="programlisting">
                   3769: int
                   3770: monitor_file(...)
                   3771: {
                   3772: #if defined(__NetBSD__)
                   3773:         int fd = kqueue();
                   3774:         ...
                   3775: #else
                   3776:         ...
                   3777: #endif
                   3778: }
                   3779: </pre>
1.85      jmmv     3780:              </td>
                   3781: <td>
1.100     rillig   3782: <pre class="programlisting">
                   3783: int
                   3784: monitor_file(...)
                   3785: {
                   3786: #if defined(HAVE_KQUEUE)
                   3787:         int fd = kqueue();
                   3788:         ...
                   3789: #else
1.223     rillig   3790:         ...
1.100     rillig   3791: #endif
                   3792: }
                   3793: </pre>
1.85      jmmv     3794:              </td>
                   3795: </tr>
                   3796: </tbody>
1.91      rillig   3797: </table></div>
1.85      jmmv     3798: </div>
1.91      rillig   3799: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110     hubertf  3800:       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
                   3801:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85      jmmv     3802:       2</a>).  It summarizes multiple details on how to make
                   3803:       software easier to package; all the suggestions in it were
                   3804:       collected from our experience in pkgsrc work, so they are possibly
                   3805:       helpful when creating patches too.</p>
                   3806: </div>
1.148     asau     3807: <div class="sect2">
1.85      jmmv     3808: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3809: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     3810: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3811:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3812:       improvements you do to a package to the mainstream developers.
                   3813:       This is the only way to get their attention on portability issues
                   3814:       and to ensure that future versions can be built out-of-the box on
                   3815:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3816:       the fixes straight from the packaged code.</p>
1.93      rillig   3817: <p>This generally involves cleaning up the patches
                   3818:       (because sometimes the patches that are
1.147     wiz      3819:       added to pkgsrc are quick hacks), filing bug reports in the
1.85      jmmv     3820:       appropriate trackers for the projects and working with the
                   3821:       mainstream authors to accept your changes.  It is
                   3822:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3823:       the packages in pkgsrc are kept simple and thus further changes
                   3824:       can be done without much hassle.</p>
1.130     wiz      3825: <p>When you have done this, please add a URL to the upstream
                   3826:       bug report to the patch comment.</p>
1.85      jmmv     3827: <p>Support the idea of free software!</p>
                   3828: </div>
1.75      rillig   3829: </div>
1.148     asau     3830: <div class="sect1">
1.75      rillig   3831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3832: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148     asau     3833: <div class="variablelist"><dl class="variablelist">
1.76      rillig   3834: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   3835: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      3836:          any credits where they are due.  Please bear in mind that others do not
                   3837:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3838:          will read everything that you write here.</p></dd>
1.76      rillig   3839: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      3840: <dd><p>This file governs the files that are installed on your
                   3841:          system: all the binaries, manual pages, etc. There are other
                   3842:          directives which may be entered in this file, to control the
                   3843:          creation and deletion of directories, and the location of
1.110     hubertf  3844:          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      3845:          information.</p></dd>
1.75      rillig   3846: </dl></div>
                   3847: </div>
1.148     asau     3848: <div class="sect1">
1.75      rillig   3849: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3850: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148     asau     3851: <div class="sect2">
1.78      rillig   3852: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3853: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148     asau     3854: <div class="variablelist"><dl class="variablelist">
1.76      rillig   3855: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135     wiz      3856: <dd>
1.189     snj      3857: <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      3858:            First time after package extraction and before files are
                   3859:            moved in place, the second time after the files to install
                   3860:            are moved in place. This can be used to do any custom
                   3861:            procedures not possible with @exec commands in
1.189     snj      3862:            <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
                   3863:            <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      3864:            Please note that you can modify variables in it easily by using
                   3865:            <code class="varname">FILES_SUBST</code> in the package's
                   3866:            <code class="filename">Makefile</code>:</p>
                   3867: <pre class="programlisting">
                   3868: FILES_SUBST+=  SOMEVAR="somevalue"
                   3869: </pre>
                   3870: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3871:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3872:            performed for <code class="varname">PREFIX</code>,
                   3873:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3874:            <code class="varname">VARBASE</code>, and a few others, type
                   3875:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3876:            complete list.</p>
                   3877: </dd>
1.76      rillig   3878: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   3879: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      3880:            this script's responsibility to clean up any additional messy details
                   3881:            around the package's installation, since all pkg_delete knows is how to
                   3882:            delete the files created in the original distribution.
1.189     snj      3883:            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>
                   3884:            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      3885:            The same methods to replace variables can be used as for
                   3886:            the <code class="filename">INSTALL</code> file.</p></dd>
1.76      rillig   3887: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   3888: <dd>
                   3889: <p>This file is displayed after installation of the package.
1.87      wiz      3890:            Useful for things like legal notices on almost-free
                   3891:            software and hints for updating config files after
                   3892:            installing modules for apache, PHP etc.
                   3893:            Please note that you can modify variables in it easily by using
                   3894:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3895:            <code class="filename">Makefile</code>:</p>
1.75      rillig   3896: <pre class="programlisting">
1.100     rillig   3897: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   3898: </pre>
1.128     wiz      3899: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.87      wiz      3900:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3901:            performed for <code class="varname">PKGNAME</code>,
                   3902:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.209     sevan    3903:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.87      wiz      3904:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3905:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  3906:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      3907: <p>You can display a different or additional files by
                   3908:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3909:            default is <code class="filename">MESSAGE</code>, if the file
                   3910:            exists.</p>
1.75      rillig   3911: </dd>
1.78      rillig   3912: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174     asau     3913: <dd>
                   3914: <p>This file is used by the alternatives framework.
                   3915:            It creates, configures, and destroys generic wrappers used to
                   3916:            run programs with similar interfaces.
                   3917:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3918:             for more information.</p>
                   3919: <p>Each line of the file contains two filenames, first
                   3920:            the wrapper and then the alternative provided by the package.
                   3921:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3922: </dd>
1.78      rillig   3923: </dl></div>
                   3924: </div>
1.148     asau     3925: <div class="sect2">
1.78      rillig   3926: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3927: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148     asau     3928: <div class="variablelist"><dl class="variablelist">
1.78      rillig   3929: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3930: <dd><p>This file contains arbitrary things that could
                   3931:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3932:        to be used by more than one package. This file should only be
                   3933:        used when the packages that will use the file are known in
                   3934:        advance. For other purposes it is often better to write a
                   3935:        <code class="filename">*.mk</code> file and give it a good name that
                   3936:        describes what it does.</p></dd>
                   3937: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3938: <dd><p>This file contains the dependency information
1.110     hubertf  3939:        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   3940: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3941: <dd><p>This file contains workarounds for compiler bugs
                   3942:        and similar things. It is included automatically by the pkgsrc
                   3943:        infrastructure, so you don't need an extra
                   3944:        <code class="literal">.include</code> line for
                   3945:        it.</p></dd>
                   3946: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3947: <dd><p>This file contains the code for the
1.110     hubertf  3948:        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   3949:        selected by the user. If a package has only one or two options,
                   3950:        it is equally acceptable to put the code directly into the
                   3951:        <code class="filename">Makefile</code>.</p></dd>
                   3952: </dl></div>
                   3953: </div>
1.148     asau     3954: <div class="sect2">
1.78      rillig   3955: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3956: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148     asau     3957: <div class="variablelist"><dl class="variablelist">
1.78      rillig   3958: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   3959: <dd><p>These files do not take place in the creation of
                   3960:        a package and thus are purely informative to the package
                   3961:        developer.</p></dd>
                   3962: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   3963: <dd><p>This file contains things that need to be done
                   3964:        to make the package even
                   3965:        better.</p></dd>
1.75      rillig   3966: </dl></div>
                   3967: </div>
1.78      rillig   3968: </div>
1.148     asau     3969: <div class="sect1">
1.75      rillig   3970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3971: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   3972: </h2></div></div></div>
1.110     hubertf  3973: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      3974:     unpacked into the directory denoted by
                   3975:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  3976:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      3977:     directory is also used to keep various timestamp files.
                   3978:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   3979:     The default is <code class="filename">${.CURDIR}/work</code>
                   3980:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   3981:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   3982: </div>
1.148     asau     3983: <div class="sect1">
1.75      rillig   3984: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3985: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   3986: </h2></div></div></div>
1.75      rillig   3987: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      3988:     to configuration or building, you could place these files here and use
1.110     hubertf  3989:     a <span class="command"><strong>${CP}</strong></span> command in the
1.128     wiz      3990:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.87      wiz      3991:     this. Alternatively, you could simply diff the file against
                   3992:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   3993:     the creation of this file.</p>
                   3994: <p>If you want to share files in this way with other
                   3995:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   3996:     to the other package's <code class="filename">files</code> directory,
                   3997:     e.g.:</p>
                   3998: <pre class="programlisting">
1.100     rillig   3999: FILESDIR=${.CURDIR}/../xemacs/files
                   4000: </pre>
1.75      rillig   4001: </div>
                   4002: </div>
1.148     asau     4003: <div class="chapter">
1.75      rillig   4004: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4005: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4006: <div class="toc">
                   4007: <p><b>Table of Contents</b></p>
1.210     leot     4008: <dl class="toc">
1.106     rillig   4009: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      4010: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   4011: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4012: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4013: <dd><dl>
                   4014: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228     yyamano  4015: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220     wiz      4016: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                   4017: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.75      rillig   4018: </dl></dd>
                   4019: </dl>
                   4020: </div>
1.76      rillig   4021: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4022:   each of which forms a well-defined part of the pkgsrc system. Using
1.189     snj      4023:   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   4024:   like pkgsrc requires some discipline to keep the code correct and
                   4025:   understandable.</p>
1.76      rillig   4026: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4027:   programming are variables (which are actually macros) and shell
                   4028:   commands. Among these shell commands may even be more complex ones
1.189     snj      4029:   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   4030:   as intended it is necessary to quote all variables correctly when they
                   4031:   are used.</p>
                   4032: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4033:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4034:   with them.</p>
1.148     asau     4035: <div class="sect1">
1.75      rillig   4036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4037: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148     asau     4038: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97      rillig   4039: <p>When you are creating a file as a
                   4040:     target of a rule, always write the data to a temporary file first
                   4041:     and finally rename that file. Otherwise there might occur an error
                   4042:     in the middle of generating the file, and when the user runs
1.189     snj      4043:     <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   4044:     regenerated properly. Example:</p>
                   4045: <pre class="programlisting">
1.100     rillig   4046: wrong:
                   4047:         @echo "line 1" &gt; ${.TARGET}
                   4048:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4049:         @false
                   4050: 
                   4051: correct:
                   4052:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4053:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4054:         @false
                   4055:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4056: </pre>
1.110     hubertf  4057: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4058:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4059:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4060:     correct</strong></span> gives an error message twice, as expected.</p>
1.189     snj      4061: <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   4062:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4063:     happens when it is interrupted, for example by pressing
                   4064:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.189     snj      4065:     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   4066: </li></ul></div>
                   4067: </div>
1.148     asau     4068: <div class="sect1">
1.97      rillig   4069: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4070: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4071: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4072:     can be processed using the five operators ``='', ``+='', ``?='',
1.189     snj      4073:     ``:='', 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   4074:     page.</p>
                   4075: <p>When a variable's value is parsed from a
1.76      rillig   4076:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4077:     backslash character ``\'' are handled specially. If a backslash is
                   4078:     followed by a newline, any whitespace immediately in front of the
                   4079:     backslash, the backslash, the newline, and any whitespace
                   4080:     immediately behind the newline are replaced with a single space. A
                   4081:     backslash character and an immediately following hash character are
                   4082:     replaced with a single hash character. Otherwise, the backslash is
                   4083:     passed as is. In a variable assignment, any hash character that is
                   4084:     not preceded by a backslash starts a comment that continues upto the
                   4085:     end of the logical line.</p>
1.219     rillig   4086: <p>The evaluation of variables either happens immediately or lazy.
                   4087:     It happens immediately when the variable occurs
                   4088:     on the right-hand side of the ``:='' or the ``!='' operator, in a
                   4089:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   4090:     In the other cases, it is evaluated lazily.</p>
1.75      rillig   4091: <p>Some of the modifiers split the string into words and then
                   4092:     operate on the words, others operate on the string as a whole. When
1.219     rillig   4093:     a string is split into words, it is split like in <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.75      rillig   4094: <p>There are several types of variables that should be handled
                   4095:     differently. Strings and two types of lists.</p>
1.148     asau     4096: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4097: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75      rillig   4098:       characters. Nevertheless, you should restrict yourself to only
                   4099:       using printable characters. Examples are
                   4100:       <code class="varname">PREFIX</code> and
                   4101:       <code class="varname">COMMENT</code>.</p></li>
1.128     wiz      4102: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75      rillig   4103:       are never exported to any shell command. Their elements are
                   4104:       separated by whitespace. Therefore, the elements themselves cannot
                   4105:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  4106:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   4107:       Examples are <code class="varname">DEPENDS</code> and
                   4108:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128     wiz      4109: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75      rillig   4110:       may be exported to a shell command. Their elements can contain any
                   4111:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  4112:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   4113:       <code class="varname">DISTFILES</code> and
                   4114:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4115: </ul></div>
1.148     asau     4116: <div class="sect2">
1.75      rillig   4117: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4118: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148     asau     4119: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4120: <li class="listitem"><p>All variable names starting with an underscore
1.75      rillig   4121:        are reserved for use by the pkgsrc infrastructure. They shall
                   4122:        not be used by package
1.76      rillig   4123:        <code class="filename">Makefile</code>s.</p></li>
1.128     wiz      4124: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4125:        lowercase variable names for the iteration
                   4126:        variables.</p></li>
1.128     wiz      4127: <li class="listitem"><p>All list variables should have a ``plural''
1.75      rillig   4128:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4129:        <code class="varname">DISTFILES</code>.</p></li>
                   4130: </ul></div>
                   4131: </div>
                   4132: </div>
1.148     asau     4133: <div class="sect1">
1.75      rillig   4134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4135: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.148     asau     4136: <div class="sect2">
1.75      rillig   4137: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4138: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.220     wiz      4139: <p>When adding a string that possibly contains whitespace or quotes to
                   4140: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   4141: modifier.</p>
                   4142: <p>When adding another list to a list (example 2), it must not be
                   4143: quoted, since its elements are already quoted.</p>
1.75      rillig   4144: <pre class="programlisting">
1.220     wiz      4145: STRING=         foo * bar `date`
                   4146: LIST=           # empty
                   4147: ANOTHER_LIST=   a=b c=d
                   4148: 
                   4149: LIST+=          ${STRING:Q}       # 1
                   4150: LIST+=          ${ANOTHER_LIST}   # 2
                   4151: </pre>
1.75      rillig   4152: </div>
1.148     asau     4153: <div class="sect2">
1.75      rillig   4154: <div class="titlepage"><div><div><h3 class="title">
1.228     yyamano  4155: <a name="echo-literal"></a>12.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.220     wiz      4156: <p>Echoing a string containing special characters needs special
                   4157: work.</p>
1.75      rillig   4158: <pre class="programlisting">
1.100     rillig   4159: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
1.219     rillig   4160: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
1.1       grant    4161: 
1.100     rillig   4162: all:
                   4163:         echo ${STRING}                  # 1
1.219     rillig   4164:         echo ${STRING:Q}                # 2
                   4165:         printf '%s\n' ${STRING:Q}''     # 3
1.220     wiz      4166:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.1       grant    4167: </pre>
1.220     wiz      4168: <p>Example 1 leads to a syntax error in the shell, as the characters
                   4169: are just copied.</p>
                   4170: <p>Example 2 quotes the string so that the shell interprets it
                   4171: correctly. But the echo command may additionally interpret strings with a
                   4172: leading dash or those containing backslashes.</p>
                   4173: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
                   4174: interprets the format string, but not the next argument.</p>
                   4175: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   4176: need to be quoted because the quoting has already been done
                   4177: when adding elements to the list.</p>
1.75      rillig   4178: </div>
1.148     asau     4179: <div class="sect2">
1.75      rillig   4180: <div class="titlepage"><div><div><h3 class="title">
1.220     wiz      4181: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   4182: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   4183: GNU-style configure script (especially those that call other configure
                   4184: scripts), it must not have leading or trailing whitespace, since
                   4185: otherwise the configure script gets confused. To trim leading and
                   4186: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   4187: following example:</p>
1.75      rillig   4188: <pre class="programlisting">
1.100     rillig   4189: CPPFLAGS=               # empty
1.220     wiz      4190: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
1.100     rillig   4191: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4192: 
                   4193: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4194: 
                   4195: all:
                   4196:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
1.220     wiz      4197:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
1.1       grant    4198: </pre>
1.220     wiz      4199: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   4200: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   4201: space.</p>
                   4202: </div>
                   4203: <div class="sect2">
                   4204: <div class="titlepage"><div><div><h3 class="title">
                   4205: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
                   4206: <p>When a possibly empty variable is used in a shell program, it may
                   4207: lead to a syntax error.</p>
                   4208: <pre class="programlisting">
                   4209: EGFILES=        # empty
                   4210: 
                   4211: install-examples:   # produces a syntax error in the shell
                   4212:         for egfile in ${EGFILES}; do            \
                   4213:                 echo "Installing $$egfile";     \
                   4214:         done
                   4215: </pre>
                   4216: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
                   4217: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
                   4218: To fix this syntax error, use one of the snippets below.</p>
                   4219: <pre class="programlisting">
                   4220: EMPTY=          # empty
                   4221: 
                   4222: install-examples:
                   4223:         for egfile in ${EGFILES} ""; do         \
                   4224:                 [ -n "$$egfile" ] || continue;  \
                   4225:                 echo "Installing $$egfile";     \
1.100     rillig   4226:         done
1.220     wiz      4227: </pre>
                   4228: <p>In this case, an empty string is appended to the iteration list (to
                   4229: prevent the syntax error) and filtered out later.</p>
                   4230: <pre class="programlisting">
                   4231: EGFILES=        # empty
1.100     rillig   4232: 
1.220     wiz      4233: install-examples:
                   4234: .for egfile in ${EGFILES}
                   4235:         echo "Installing ${egfile}"
1.100     rillig   4236: .endfor
1.1       grant    4237: </pre>
1.220     wiz      4238: <p>This variant only works when <code class="varname">EGFILES</code> does not
                   4239: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
                   4240: simple whitespace.</p>
                   4241: <p>To have a shell command test whether a make variable is empty, use
                   4242: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.75      rillig   4243: </div>
                   4244: </div>
                   4245: </div>
1.148     asau     4246: <div class="chapter">
1.75      rillig   4247: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4248: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   4249: <div class="toc">
                   4250: <p><b>Table of Contents</b></p>
1.210     leot     4251: <dl class="toc">
1.106     rillig   4252: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      4253: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   4254: <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   4255: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   4256: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      4257: <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   4258: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz      4259: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   4260: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.75      rillig   4261: </dl>
                   4262: </div>
1.87      wiz      4263: <p>The <code class="filename">PLIST</code> file contains a package's
1.128     wiz      4264:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.87      wiz      4265:   the package (relative to the <code class="filename">${PREFIX}</code>
                   4266:   directory it's been installed in) plus some additional statements
1.189     snj      4267:   - 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      4268:   This chapter addresses some issues that need attention when
                   4269:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   4270:   below!).</p>
1.148     asau     4271: <div class="sect1">
1.75      rillig   4272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4273: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      4274: <p>Be sure to add a RCS ID line as the first thing in any
                   4275:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   4276: <pre class="programlisting">
1.100     rillig   4277: @comment $NetBSD$
1.222     sevan    4278: </pre>
1.75      rillig   4279: </div>
1.148     asau     4280: <div class="sect1">
1.75      rillig   4281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4282: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  4283: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      4284:     to output a PLIST that matches any new files since the package
1.110     hubertf  4285:     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      4286:     more information on this target.</p>
1.75      rillig   4287: </div>
1.148     asau     4288: <div class="sect1">
1.75      rillig   4289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  4290: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   4291: </h2></div></div></div>
1.87      wiz      4292: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   4293:     of AWK patterns and actions that are used to filter the output of
                   4294:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   4295:     scripting you like to it, but be careful with quoting.</p>
                   4296: <p>For example, to get all files inside the
                   4297:     <code class="filename">libdata/foo</code> directory removed from the
                   4298:     resulting PLIST:</p>
                   4299: <pre class="programlisting">
1.100     rillig   4300: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.222     sevan    4301: </pre>
1.75      rillig   4302: </div>
1.148     asau     4303: <div class="sect1">
1.75      rillig   4304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4305: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      4306: <p>A number of variables are substituted automatically in
                   4307:     PLISTs when a package is installed on a system. This includes the
                   4308:     following variables:</p>
1.148     asau     4309: <div class="variablelist"><dl class="variablelist">
1.75      rillig   4310: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   4311: <dd>
                   4312: <p>Some packages like emacs and perl embed information
1.87      wiz      4313:          about which architecture they were built on into the
                   4314:          pathnames where they install their files. To handle this
                   4315:          case, PLIST will be preprocessed before actually used, and
                   4316:          the symbol
1.128     wiz      4317:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.110     hubertf  4318:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      4319:          same is done if the string
                   4320:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   4321:          PLIST somewhere - use this on packages that have GNU
                   4322:          autoconf-created configure scripts.</p>
1.148     asau     4323: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   4324: <h3 class="title">Legacy note</h3>
                   4325: <p>There used to be a symbol
1.128     wiz      4326:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.110     hubertf  4327:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      4328:            -m</strong></span>, but that's no longer supported and has
                   4329:            been removed.</p>
1.75      rillig   4330: </div>
                   4331: </dd>
                   4332: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   4333: <dd>
                   4334: <p>Some packages want to embed the OS name and version
1.87      wiz      4335:          into some paths.  To do this, use these variables in the
                   4336:          <code class="filename">PLIST</code>:
                   4337:          </p>
1.148     asau     4338: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4339: <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>
                   4340: <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>
                   4341: <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   4342: </ul></div>
                   4343: </dd>
                   4344: </dl></div>
1.199     tnn      4345: <p>For a list of values which are replaced by
                   4346:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   4347: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   4348: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87      wiz      4349: <p>If you want to change other variables not listed above, you
                   4350:     can add variables and their expansions to this variable in the
1.110     hubertf  4351:     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   4352: <pre class="programlisting">
1.100     rillig   4353: PLIST_SUBST+=   SOMEVAR="somevalue"
1.222     sevan    4354: </pre>
1.128     wiz      4355: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.87      wiz      4356:     in the <code class="filename">PLIST</code> with
1.128     wiz      4357:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.120     snj      4358: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119     mishka   4359:     the common case of conditionally including some
                   4360:     <code class="filename">PLIST</code> entries. It can be done by adding
                   4361:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120     snj      4362:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   4363:     to <code class="literal">yes</code> if the entry should be included.
1.128     wiz      4364:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.119     mishka   4365:     in the <code class="filename">PLIST</code> with either
1.128     wiz      4366:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   4367:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.119     mishka   4368:     For example, in <code class="filename">Makefile</code>:</p>
                   4369: <pre class="programlisting">
1.223     rillig   4370: PLIST_VARS+=    foo
1.119     mishka   4371: .if <em class="replaceable"><code>condition</code></em>
1.223     rillig   4372: PLIST.foo=      yes
1.119     mishka   4373: .else
1.222     sevan    4374: </pre>
1.119     mishka   4375: <p>And then in <code class="filename">PLIST</code>:</p>
                   4376: <pre class="programlisting">
                   4377: @comment $NetBSD$
                   4378: bin/bar
                   4379: man/man1/bar.1
                   4380: ${PLIST.foo}bin/foo
                   4381: ${PLIST.foo}man/man1/foo.1
                   4382: ${PLIST.foo}share/bar/foo.data
1.222     sevan    4383: </pre>
1.75      rillig   4384: </div>
1.148     asau     4385: <div class="sect1">
1.75      rillig   4386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4387: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   4388: <p>Man pages should be installed in compressed form if
1.87      wiz      4389:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   4390:     and uncompressed otherwise. To handle this in the
1.128     wiz      4391:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.87      wiz      4392:     appended/removed automatically for man pages according to
                   4393:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   4394:     or not, see above for details. This modification of the
                   4395:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   4396:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   4397: </div>
1.148     asau     4398: <div class="sect1">
1.75      rillig   4399: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4400: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   4401: </h2></div></div></div>
1.76      rillig   4402: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      4403:     in generating the binary package, set the variable
                   4404:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.189     snj      4405:     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      4406:     important. The default for <code class="varname">PLIST_SRC</code> is
                   4407:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   4408: </div>
1.148     asau     4409: <div class="sect1">
1.75      rillig   4410: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4411: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   4412: <p>Some packages decide to install a different set of files based on
1.87      wiz      4413:     the operating system being used. These differences can be
                   4414:     automatically handled by using the following files:</p>
1.148     asau     4415: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4416: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   4417: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   4418: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   4419: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   4420: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   4421: </ul></div>
                   4422: </div>
1.148     asau     4423: <div class="sect1">
1.75      rillig   4424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.197     wiz      4425: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
                   4426: <p>Some packages decide to generate hard-to-guess file names
                   4427:     during installation that are hard to wire down.</p>
                   4428: <p>In such cases, you can set the
                   4429:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   4430:     terminated (with a semicolon) that will output PLIST entries which
                   4431:     will be appended to the PLIST</p>
                   4432: <p>You can find one example in editors/xemacs:</p>
                   4433: <pre class="programlisting">
1.222     sevan    4434: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   4435: </pre>
1.197     wiz      4436: <p>which will append something like
                   4437:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   4438:     <code class="filename">PLIST</code>.
                   4439:     </p>
                   4440: </div>
                   4441: <div class="sect1">
                   4442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4443: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.128     wiz      4444: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.87      wiz      4445:     multiple (and unrelated) packages install files.  These
1.125     wiz      4446:     directories were problematic because you had to add special
                   4447:     tricks in the PLIST to conditionally remove them, or have some
1.87      wiz      4448:     centralized package handle them.</p>
1.125     wiz      4449: <p>In pkgsrc, it is now easy: Each package should create
                   4450:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   4451:     will remove any directories left empty after uninstalling a
                   4452:     package.</p>
                   4453: <p>If a package needs an empty directory to work, create
                   4454:     the directory during installation as usual, and also add an
                   4455:     entry to the PLIST:
1.222     sevan    4456: 
                   4457: </p>
1.87      wiz      4458: <pre class="programlisting">
1.125     wiz      4459: @pkgdir path/to/empty/directory
1.222     sevan    4460: </pre>
1.125     wiz      4461: <p>
1.222     sevan    4462: 
1.197     wiz      4463:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   4464:     <code class="varname">OWN_DIRS</code>.
1.125     wiz      4465:     </p>
1.75      rillig   4466: </div>
                   4467: </div>
1.148     asau     4468: <div class="chapter">
1.75      rillig   4469: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4470: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   4471: <div class="toc">
                   4472: <p><b>Table of Contents</b></p>
1.210     leot     4473: <dl class="toc">
1.106     rillig   4474: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      4475: <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   4476: <dd><dl>
1.106     rillig   4477: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      4478: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   4479:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4480:       and
                   4481:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4482:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   4483: </dl></dd>
1.128     wiz      4484: <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   4485: <dd><dl>
1.128     wiz      4486: <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   4487: <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   4488: </dl></dd>
                   4489: </dl>
                   4490: </div>
                   4491: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      4492:   are seen by a package's configure and build processes.  This is implemented
                   4493:   in a two step process:</p>
1.128     wiz      4494: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4495: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87      wiz      4496:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   4497:       of <code class="varname">WRKDIR</code>.</p></li>
1.128     wiz      4498: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      4499:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   4500:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   4501:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   4502:       native compiler on some operating systems look like GCC, so that
                   4503:       packages that expect GCC won't require modifications to build with
                   4504:       those native compilers.</p></li>
1.75      rillig   4505: </ol></div>
                   4506: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      4507:   package may be built consistently despite what other software may be
                   4508:   installed. Please note that the normal system header and library paths,
                   4509:   e.g. <code class="filename">/usr/include</code>,
                   4510:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   4511:   designed to insulate the package build from non-system-supplied
                   4512:   software.</p>
1.148     asau     4513: <div class="sect1">
1.75      rillig   4514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4515: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   4516: <p>The process of converting packages to use the buildlink3
1.128     wiz      4517:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.87      wiz      4518:     The things to keep in mind are:</p>
1.128     wiz      4519: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4520: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87      wiz      4521:        instead of the actual toolchain.  Some packages are tricky,
                   4522:        and the only way to know for sure is the check
                   4523:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   4524:        wrappers are being invoked.</p></li>
1.128     wiz      4525: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87      wiz      4526:        the package Makefile, e.g. Java VMs, standalone shells,
                   4527:        etc., because the code to symlink files into
                   4528:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128     wiz      4529:        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      4530:        </p></li>
1.128     wiz      4531: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87      wiz      4532:        <code class="filename">buildlink3.mk</code> files that you list in a
                   4533:        package's Makefile are added as dependencies for that package.
                   4534:        </p></li>
1.75      rillig   4535: </ol></div>
1.87      wiz      4536: <p>If a dependency on a particular package is required for its libraries and
                   4537:     headers, then we replace:</p>
1.75      rillig   4538: <pre class="programlisting">
1.100     rillig   4539: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   4540: </pre>
1.75      rillig   4541: <p>with</p>
                   4542: <pre class="programlisting">
1.100     rillig   4543: .include "../../category/foo/buildlink3.mk"
                   4544: </pre>
1.75      rillig   4545: <p>The buildlink3.mk files usually define the required dependencies.
                   4546:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      4547:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   4548: <pre class="programlisting">
1.100     rillig   4549: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   4550: .include "../../category/foo/buildlink3.mk"
                   4551: </pre>
1.76      rillig   4552: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      4553:     files in <code class="filename">pkgsrc/mk</code>
                   4554:     that handle special package issues:</p>
1.148     asau     4555: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4556: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      4557:        the native or a pkgsrc Berkeley DB implementation based on
                   4558:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   4559:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128     wiz      4560: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      4561:        comes with neither Curses nor NCurses, this will take care
1.189     snj      4562:        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      4563: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      4564:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   4565:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   4566:        require a Kerberos 5 implementation.</p></li>
1.128     wiz      4567: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88      wiz      4568:        system-provided Motif installation or adds a dependency on
1.189     snj      4569:        <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      4570:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.151     obache   4571:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span> or
                   4572:        <span class="quote">&#8220;<span class="quote">openmotif</span>&#8221;</span> to choose
1.88      wiz      4573:        which Motif version will be used.</p></li>
1.161     ryoon    4574: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162     wiz      4575:        system-provided GNU readline or editline (libedit) installation,
1.189     snj      4576:        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>,
                   4577:        <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    4578:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   4579:        If your package really needs GNU readline library, its Makefile
                   4580:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   4581:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128     wiz      4582: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      4583:        variables that may be used by packages that use the
                   4584:        Open Sound System (OSS) API.</p></li>
1.128     wiz      4585: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142     wiz      4586:        any of the Postgres versions in the variable
                   4587:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   4588:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87      wiz      4589:        the file for more information.</p></li>
1.128     wiz      4590: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      4591:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.189     snj      4592:        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      4593: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      4594:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   4595:        library.</p></li>
1.75      rillig   4596: </ul></div>
1.76      rillig   4597: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      4598:     files provide a more complete
                   4599:     description of how to use them properly.</p>
1.75      rillig   4600: </div>
1.148     asau     4601: <div class="sect1">
1.75      rillig   4602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4603: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   4604: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      4605:     included by Makefiles to indicate the need to compile and link
                   4606:     against header files and libraries provided by the package.  A
                   4607:     <code class="filename">buildlink3.mk</code> file should always provide
                   4608:     enough information to add the correct type of dependency
                   4609:     relationship and include any other
                   4610:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   4611:     headers and libraries that it needs in turn.</p>
                   4612: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.189     snj      4613:     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      4614:     package is highly recommended.  For most packages, the following
                   4615:     command will generate a good starting point for
                   4616:     <code class="filename">buildlink3.mk</code> files:</p>
                   4617: <pre class="screen">
                   4618: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   4619: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   4620:     </pre>
1.148     asau     4621: <div class="sect2">
1.75      rillig   4622: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4623: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   4624: <p>The following real-life example
1.87      wiz      4625:       <code class="filename">buildlink3.mk</code> is taken
                   4626:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   4627: <pre class="programlisting">
1.120     snj      4628: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       grant    4629: 
1.223     rillig   4630: BUILDLINK_TREE+=        tiff
1.1       grant    4631: 
1.120     snj      4632: .if !defined(TIFF_BUILDLINK3_MK)
                   4633: TIFF_BUILDLINK3_MK:=
1.87      wiz      4634: 
1.223     rillig   4635: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   4636: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   4637: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
1.87      wiz      4638: 
1.100     rillig   4639: .include "../../devel/zlib/buildlink3.mk"
                   4640: .include "../../graphics/jpeg/buildlink3.mk"
1.120     snj      4641: .endif # TIFF_BUILDLINK3_MK
1.87      wiz      4642: 
1.223     rillig   4643: BUILDLINK_TREE+=        -tiff
1.100     rillig   4644: </pre>
1.87      wiz      4645: <p>The header and footer manipulate
1.120     snj      4646:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87      wiz      4647:       <code class="filename">buildlink3.mk</code> files and is used to track
1.120     snj      4648:       the dependency tree.</p>
                   4649: <p>The main section is protected from multiple inclusion
1.87      wiz      4650:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   4651:       added.  Several important variables are set in the section:</p>
1.148     asau     4652: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4653: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4654:          is the actual dependency recorded in the installed
                   4655:          package; this should always be set using
1.110     hubertf  4656:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      4657:          we're appending to any pre-existing list of values.  This
                   4658:          variable should be set to the first version of the
1.133     wiz      4659:          package that had an backwards-incompatible API change.
1.87      wiz      4660:          </p></li>
1.128     wiz      4661: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4662:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   4663:          pkgsrc directory.</p></li>
1.128     wiz      4664: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4665:          (not shown above) controls whether we use
                   4666:          <code class="varname">BUILD_DEPENDS</code> or
                   4667:          <code class="varname">DEPENDS</code> to add the dependency on
                   4668:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   4669:          selected by setting
                   4670:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4671:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.87      wiz      4672:          used.</p></li>
1.128     wiz      4673: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4674:            and
                   4675:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   4676:            (not shown above) are lists of subdirectories of
1.76      rillig   4677:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   4678:            to add to the header and library search paths.  These
1.128     wiz      4679:            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      4680:          respectively.</p></li>
1.128     wiz      4681: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4682:            (not shown above) is the list of preprocessor flags to add
                   4683:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128     wiz      4684:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.75      rillig   4685:            should be avoided and instead be handled using
                   4686:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      4687:          above.</p></li>
1.75      rillig   4688: </ul></div>
1.87      wiz      4689: <p>The following variables are all optionally defined within
                   4690:       this second section (protected against multiple inclusion) and
                   4691:       control which package files are symlinked into
                   4692:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   4693:       transformed during the symlinking:</p>
1.148     asau     4694: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4695: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4696:            (not shown above) is a shell glob pattern relative to
1.76      rillig   4697:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   4698:            to be symlinked into
1.76      rillig   4699:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      4700:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.128     wiz      4701: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4702:            (not shown above) is a shell pipeline that
                   4703:            outputs to stdout a list of files relative to
                   4704:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   4705:            The resulting files are to be symlinked
                   4706:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   4707:            this takes the <code class="filename">+CONTENTS</code> of a
                   4708:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   4709:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128     wiz      4710: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4711:            (not shown above) is a filter command that filters
1.76      rillig   4712:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   4713:            relative to
1.76      rillig   4714:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194     bsiegert 4715:            on stdout.  By default,
1.75      rillig   4716:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   4717:            outputs the contents of the <code class="filename">include</code>
                   4718:            and <code class="filename">lib</code> directories in the package
1.194     bsiegert 4719:            <code class="filename">+CONTENTS</code>.</p></li>
1.128     wiz      4720: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4721:            (not shown above) is a list of sed arguments used to
                   4722:            transform the name of the source filename into a
1.110     hubertf  4723:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      4724:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   4725: </ul></div>
1.120     snj      4726: <p>This section can additionally include any
1.87      wiz      4727:       <code class="filename">buildlink3.mk</code> needed for
                   4728:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   4729:       Including these <code class="filename">buildlink3.mk</code> files
                   4730:       means that the headers and libraries for these
                   4731:       dependencies are also symlinked into
                   4732:       <code class="filename">${BUILDLINK_DIR}</code>
                   4733:       whenever the <em class="replaceable"><code>pkg</code></em>
                   4734:       <code class="filename">buildlink3.mk</code>
1.120     snj      4735:       file is included. Dependencies are only added for directly
                   4736:       include <code class="filename">buildlink3.mk</code> files.</p>
1.153     wiz      4737: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   4738:       including other <code class="filename">buildlink3.mk</code> files in it,
1.156     wiz      4739:       please only add necessary ones, i.e., those whose libraries or
1.153     wiz      4740:       header files are automatically exposed when the package is
                   4741:       use.</p>
                   4742: <p>In particular, if only an executable
                   4743:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   4744:       library does not need to be propagated in the
                   4745:       <code class="filename">buildlink3.mk</code> file.</p>
                   4746: <p>The following steps should help you decide if a
                   4747:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   4748:       </p>
                   4749: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4750: <li class="listitem"><p>Look at the installed header files: What
                   4751:        headers do they include? The packages providing these files
                   4752:        must be buildlinked.</p></li>
1.155     wiz      4753: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   4754:        libraries and look against what other libraries they link.
                   4755:        Some of the packages providing these probably need to be
                   4756:        buildlinked; however, it's not automatic, since e.g. GTK on
                   4757:        some systems pulls in the X libraries, so they will show up in
                   4758:        the <code class="filename">ldd</code> output, while on others (like OS
1.156     wiz      4759:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.155     wiz      4760:        used as a hint.</p></li>
1.153     wiz      4761: </ul></div>
                   4762: <p>
                   4763:       </p>
1.75      rillig   4764: </div>
1.148     asau     4765: <div class="sect2">
1.75      rillig   4766: <div class="titlepage"><div><div><h3 class="title">
1.133     wiz      4767: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87      wiz      4768:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      4769:       and
                   4770:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4771:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   4772: <p>These two variables differ in that one describes source
                   4773:       compatibility (API) and the other binary compatibility (ABI).
                   4774:       The difference is that a change in the API breaks compilation of
                   4775:       programs while changes in the ABI stop compiled programs from
                   4776:       running.</p>
                   4777: <p>Changes to the
1.134     wiz      4778:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      4779:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   4780:       very rarely. One possible reason is that all packages depending
                   4781:       on this already need a newer version. In case it is bumped see
                   4782:       the description below.</p>
                   4783: <p>The most common example of an ABI change is that the major
                   4784:       version of a shared library is increased. In this case,
                   4785:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4786:       should be adjusted to require at least the new package version.
                   4787:       Then the packages that depend on this package need their
                   4788:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   4789:       <code class="filename">buildlink3.mk</code> files, their
                   4790:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4791:       adjusted, too. This is needed so pkgsrc will require the correct
                   4792:       package dependency and not settle for an older one when building
                   4793:       the source.</p>
1.218     rillig   4794: <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      4795:       more information about dependencies on other packages,
                   4796:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      4797:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   4798: <p>Please take careful consideration before adjusting
                   4799:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4800:       or
                   4801:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4802:       as we don't want to cause unneeded package deletions and
                   4803:       rebuilds.  In many cases, new versions of packages work just
                   4804:       fine with older dependencies.</p>
                   4805: <p>Also it is not needed to set
1.133     wiz      4806:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4807:       when it is identical to
1.87      wiz      4808:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   4809: </div>
                   4810: </div>
1.148     asau     4811: <div class="sect1">
1.75      rillig   4812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4813: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      4814: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   4815:       coincide with headers and libraries present in the base system.
1.76      rillig   4816:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   4817:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   4818:       file that includes the necessary checks to decide whether using
                   4819:       the built-in software or the pkgsrc software is
1.87      wiz      4820:     appropriate.</p>
                   4821: <p>The only requirements of a builtin.mk file for
                   4822:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.128     wiz      4823: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4824: <li class="listitem"><p>It should set
1.87      wiz      4825:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4826:        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      4827:        after it is included.</p></li>
1.128     wiz      4828: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87      wiz      4829:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4830:        which is already set before the
                   4831:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.128     wiz      4832: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.87      wiz      4833:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   4834:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   4835: </ol></div>
1.148     asau     4836: <div class="sect2">
1.75      rillig   4837: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4838: <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   4839: <p>The following is the recommended template for builtin.mk
1.87      wiz      4840:       files:</p>
1.75      rillig   4841: <pre class="programlisting">
1.100     rillig   4842: .if !defined(IS_BUILTIN.foo)
                   4843: #
                   4844: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   4845: # genuinely exists in the system or not.
                   4846: #
                   4847: IS_BUILTIN.foo?=        no
                   4848: 
                   4849: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   4850: # version can be determined.
                   4851: #
                   4852: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   4853: BUILTIN_PKG.foo?=       foo-1.0
                   4854: .  endif
                   4855: .endif  # IS_BUILTIN.foo
                   4856: 
                   4857: .if !defined(USE_BUILTIN.foo)
                   4858: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   4859: .  if defined(BUILTIN_PKG.foo)
                   4860: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   4861: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   4862: USE_BUILTIN.foo!=                                                       \
                   4863:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   4864:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   4865: .      endif
                   4866: .    endfor
                   4867: .  endif
                   4868: .endif  # USE_BUILTIN.foo
                   4869: 
                   4870: CHECK_BUILTIN.foo?=     no
                   4871: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   4872: #
                   4873: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   4874: # "yes" or "no".
                   4875: #
                   4876: .endif  # CHECK_BUILTIN.foo
                   4877: </pre>
1.87      wiz      4878: <p>The first section sets
                   4879:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4880:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   4881:       in the base system.  This should not be a base system software
                   4882:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128     wiz      4883:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.87      wiz      4884:       included as part of the base system.  This variable is only
                   4885:       used internally within the <code class="filename">builtin.mk</code>
                   4886:       file.</p>
                   4887: <p>The second section sets
                   4888:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4889:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   4890:       system if it exists (if
                   4891:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4892:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.87      wiz      4893:       within the <code class="filename">builtin.mk</code> file.</p>
                   4894: <p>The third section sets
                   4895:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4896:       and is <span class="emphasis"><em>required</em></span> in all
                   4897:       <code class="filename">builtin.mk</code> files.  The code in this
                   4898:       section must make the determination whether the built-in
                   4899:       software is adequate to satisfy the dependencies listed in
                   4900:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   4901:       This is typically done by comparing
                   4902:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4903:       against each of the dependencies in
                   4904:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   4905:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4906:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   4907:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   4908:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4909:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.87      wiz      4910:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4911:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.87      wiz      4912:       that the built-in version of the software is similar enough to
                   4913:       be used as a replacement.</p>
                   4914: <p>The last section is guarded by
                   4915:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   4916:       and includes code that uses the value of
                   4917:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4918:       set in the previous section.  This typically includes, e.g.,
                   4919:       adding additional dependency restrictions and listing additional
                   4920:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   4921:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   4922: </div>
1.148     asau     4923: <div class="sect2">
1.75      rillig   4924: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4925: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      4926: <p>When building packages, it's possible to choose whether to set
                   4927:        a global preference for using either the built-in (native)
                   4928:        version or the pkgsrc version of software to satisfy a
                   4929:        dependency.  This is controlled by setting
                   4930:        <code class="varname">PREFER_PKGSRC</code> and
                   4931:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.128     wiz      4932:        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      4933:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   4934:        use the pkgsrc versions of software, while
                   4935:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   4936:        built-in versions.  Preferences are determined by the most
                   4937:        specific instance of the package in either
                   4938:        <code class="varname">PREFER_PKGSRC</code> or
                   4939:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   4940:        in neither or in both variables, then
                   4941:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   4942:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   4943:        using pkgsrc versions of software for all but the most basic
                   4944:       bits on a NetBSD system, you can set:</p>
                   4945: <pre class="programlisting">
1.100     rillig   4946: PREFER_PKGSRC=  yes
                   4947: PREFER_NATIVE=  getopt skey tcp_wrappers
                   4948: </pre>
1.87      wiz      4949: <p>A package <span class="emphasis"><em>must</em></span> have a
                   4950:       <code class="filename">builtin.mk</code>
                   4951:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   4952:       otherwise it is simply ignored in that list.</p>
1.229     sevan    4953: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
                   4954:       straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
                   4955:       bootstrap.
                   4956:       Switching between settings globally at a later date can introduce
                   4957:       complications with dependency resolution. This is caused by packages
                   4958:       built with the opposite preference being installed alongside each other.</p>
                   4959: <pre class="screen">
                   4960: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
                   4961: </pre>
1.75      rillig   4962: </div>
                   4963: </div>
                   4964: </div>
1.148     asau     4965: <div class="chapter">
1.75      rillig   4966: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4967: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   4968: <div class="toc">
                   4969: <p><b>Table of Contents</b></p>
1.210     leot     4970: <dl class="toc">
1.106     rillig   4971: <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   4972: <dd><dl>
1.106     rillig   4973: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   4974: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   4975: </dl></dd>
1.106     rillig   4976: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   4977: <dd><dl>
1.128     wiz      4978: <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   4979: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   4980: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   4981: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   4982: </dl></dd>
                   4983: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   4984: <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>
                   4985: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   4986: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   4987: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   4988: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   4989: <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   4990: </dl>
                   4991: </div>
                   4992: <p>This chapter describes the framework known as
                   4993: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148     asau     4994: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4995: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75      rillig   4996:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      4997: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75      rillig   4998:     provided that packages are correctly designed.</p></li>
1.128     wiz      4999: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5000: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5001: <li class="listitem"><p>Registration of system shells.</p></li>
                   5002: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75      rillig   5003: </ul></div>
                   5004: <p>The following sections inspect each of the above points in detail.</p>
                   5005: <p>You may be thinking that many of the things described here could be
                   5006: easily done with simple code in the package's post-installation target
                   5007: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5008: as the code in them is only executed when building from source.  Machines
                   5009: using binary packages could not benefit from it at all (as the code itself
                   5010: could be unavailable).  Therefore, the only way to achieve any of the items
                   5011: described above is by means of the installation scripts, which are
                   5012: automatically generated by pkginstall.</p>
1.148     asau     5013: <div class="sect1">
1.75      rillig   5014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5015: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5016: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5017: of files and directories that belong to a package.  The names used in it
1.76      rillig   5018: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5019: which means that it cannot register files outside this directory (absolute
                   5020: path names are not allowed).  Despite this restriction, some packages need
                   5021: to install files outside this location; e.g., under
1.76      rillig   5022: <code class="filename">${VARBASE}</code> or
1.87      wiz      5023: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5024: is to create such files during installation time by using
                   5025: installation scripts.</p>
                   5026: <p>The generic installation scripts are shell scripts that can
                   5027: contain arbitrary code.  The list of scripts to execute is taken from
                   5028: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5029: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5030: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5031: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5032: commands, so they have the potential to create and manage files
                   5033: anywhere in the file system.</p>
                   5034: <p>Using these general installation files is not recommended, but
                   5035: may be needed in some special cases.  One reason for avoiding them is
                   5036: that the user has to trust the packager that there is no unwanted or
                   5037: simply erroneous code included in the installation script. Also,
                   5038: previously there were many similar scripts for the same functionality,
                   5039: and fixing a common error involved finding and changing all of
                   5040: them.</p>
                   5041: <p>The pkginstall framework offers another, standardized way.  It
                   5042: provides generic scripts to abstract the manipulation of such files
                   5043: and directories based on variables set in the package's
                   5044: <code class="filename">Makefile</code>.  The rest of this section describes
                   5045: these variables.</p>
1.148     asau     5046: <div class="sect2">
1.75      rillig   5047: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5048: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5049: <p>The following variables can be set to request the creation of
                   5050: directories anywhere in the file system:</p>
1.148     asau     5051: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.218     rillig   5052: <li class="listitem">
                   5053: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75      rillig   5054:     contain a list of directories that should be created and should attempt
                   5055:     to be destroyed by the installation scripts.  The difference between
                   5056:     the two is that the latter prompts the administrator to remove any
                   5057:     directories that may be left after deinstallation (because they were
1.218     rillig   5058:     not empty), while the former does not.  Example:</p>
                   5059: <pre class="programlisting">
                   5060: MAKE_DIRS+=             ${VARBASE}/foo/private
                   5061: </pre>
                   5062: </li>
1.128     wiz      5063: <li class="listitem">
1.75      rillig   5064: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5065:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5066:     which directories should be created and should attempt to be destroyed
                   5067:     by the installation scripts.  Each tuple holds the following values,
                   5068:     separated by spaces: the directory name, its owner, its group and its
                   5069:     numerical mode.  For example:</p>
                   5070: <pre class="programlisting">
1.218     rillig   5071: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   5072:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5073: </pre>
1.75      rillig   5074: <p>The difference between the two is exactly the same as their
                   5075:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5076: </li>
                   5077: </ul></div>
                   5078: </div>
1.148     asau     5079: <div class="sect2">
1.75      rillig   5080: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5081: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5082: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5083: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5084: To overcome this problem, the only solution is to extract the file in the
                   5085: known place (i.e., inside the installation prefix) and copy it to the
                   5086: appropriate location during installation (done by the installation scripts
                   5087: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5088: file</em></span> in the following paragraphs, which describe the variables
                   5089: that can be used to automatically and consistently handle files outside the
                   5090: installation prefix:</p>
1.148     asau     5091: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5092: <li class="listitem">
1.75      rillig   5093: <p><code class="varname">CONF_FILES</code> and
1.137     wiz      5094:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75      rillig   5095:     During installation time, the master file is copied to the target one
                   5096:     if and only if the latter does not exist.  Upon deinstallation, the
                   5097:     target file is removed provided that it was not modified by the
                   5098:     installation.</p>
                   5099: <p>The difference between the two is that the latter prompts the
                   5100:     administrator to remove any files that may be left after
                   5101:     deinstallation (because they were not empty), while the former does
                   5102:     not.</p>
                   5103: </li>
1.128     wiz      5104: <li class="listitem">
1.75      rillig   5105: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137     wiz      5106:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75      rillig   5107:     files as well as their target locations.  For each of them, it also
                   5108:     specifies their owner, their group and their numeric permissions, in
                   5109:     this order.  For example:</p>
                   5110: <pre class="programlisting">
1.218     rillig   5111: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   5112:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5113: </pre>
1.75      rillig   5114: <p>The difference between the two is exactly the same as their
                   5115:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5116: </li>
                   5117: </ul></div>
                   5118: </div>
                   5119: </div>
1.148     asau     5120: <div class="sect1">
1.75      rillig   5121: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5122: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   5123: <p>Configuration files are special in the sense that they are installed
                   5124: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5125: need special treatment during installation (most of which is automated by
                   5126: pkginstall).  The main concept you must bear in mind is that files marked
                   5127: as configuration files are automatically copied to the right place (somewhere
                   5128: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5129: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5130: be removed if they have local modifications.  This ensures that
                   5131: administrators never lose any custom changes they may have made.</p>
1.148     asau     5132: <div class="sect2">
1.75      rillig   5133: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5134: <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   5135: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5136: specifies where configuration files shall be installed.  Its contents are
                   5137: set based upon the following variables:</p>
1.148     asau     5138: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5139: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5140:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5141:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5142:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5143:     Packages must not use it directly.</p></li>
1.128     wiz      5144: <li class="listitem">
1.75      rillig   5145: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5146:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5147:     for the package being built shall be installed.  The definition of this
                   5148:     variable only makes sense in the package's
1.76      rillig   5149:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5150: <p>As an example, consider the Apache package,
1.189     snj      5151:     <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   5152:     configuration files under the
1.76      rillig   5153:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5154:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5155:     Makefile.</p>
                   5156: </li>
1.128     wiz      5157: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75      rillig   5158:     variable that holds this package's configuration directory (if
                   5159:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5160:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5161:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128     wiz      5162: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75      rillig   5163:     directory where the configuration files for the package identified by
                   5164:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5165: </ul></div>
                   5166: <p>Based on the above variables, pkginstall determines the value of
                   5167: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5168: variable that can be used within a package to refer to its configuration
                   5169: directory.  The algorithm used to set its value is basically the
                   5170: following:</p>
1.128     wiz      5171: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5172: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75      rillig   5173:     its value is used.</p></li>
1.128     wiz      5174: <li class="listitem"><p>If the previous variable is not defined but
1.75      rillig   5175:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5176:     <code class="filename">Makefile</code>, the resulting value is
                   5177:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128     wiz      5178: <li class="listitem"><p>Otherwise, it is set to
1.76      rillig   5179:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5180: </ol></div>
1.76      rillig   5181: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117     jnemeth  5182: 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
                   5183: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   5184: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   5185: </div>
1.148     asau     5186: <div class="sect2">
1.75      rillig   5187: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5188: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   5189: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5190: known place, you need to teach each package where it shall install its
                   5191: files.  In some cases you will have to patch the package Makefiles to
                   5192: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5193: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5194: generated files:</p>
                   5195: <pre class="programlisting">
1.100     rillig   5196: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    5197: </pre>
1.75      rillig   5198: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5199: for</em></span> its configuration files, not where they will be originally
                   5200: installed (although the difference is never explicit,
                   5201: unfortunately).</p>
                   5202: </div>
1.148     asau     5203: <div class="sect2">
1.75      rillig   5204: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5205: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   5206: <p>As said before, pkginstall automatically handles configuration files.
                   5207: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   5208: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   5209: directly</strong></span>.  Bad news is that many software installation scripts
                   5210: will, out of the box, mess with the contents of that directory.  So what is
                   5211: the correct procedure to fix this issue?</p>
                   5212: <p>You must teach the package (usually by manually patching it) to
                   5213: install any configuration files under the examples hierarchy,
1.76      rillig   5214: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5215: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   5216: has the original copies available.</p>
                   5217: <p>Once the required configuration files are in place (i.e., under the
                   5218: examples hierarchy), the pkginstall framework can use them as master copies
                   5219: during the package installation to update what is in
1.76      rillig   5220: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   5221: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  5222: 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   5223: about their syntax and their purpose.  Here is an example, taken from the
1.189     snj      5224: <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   5225: <pre class="programlisting">
1.100     rillig   5226: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5227: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    5228: </pre>
1.75      rillig   5229: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5230: package and has no meaning outside it.</p>
                   5231: </div>
1.148     asau     5232: <div class="sect2">
1.75      rillig   5233: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5234: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   5235: <p>The automatic copying of config files can be toggled by setting the
                   5236: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5237: installation.</p>
                   5238: </div>
                   5239: </div>
1.148     asau     5240: <div class="sect1">
1.75      rillig   5241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5242: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   5243: <p>System startup scripts are special files because they must be
                   5244: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  5245: 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   5246: can be used.  However, pkginstall provides a special mechanism to handle
                   5247: these files.</p>
                   5248: <p>In order to provide system startup scripts, the package has
                   5249: to:</p>
1.128     wiz      5250: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5251: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   5252:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.189     snj      5253:     <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   5254:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128     wiz      5255: <li class="listitem">
1.75      rillig   5256: <p>Tell pkginstall to handle it, appending the name of the script,
                   5257:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5258:     Continuing the previous example:</p>
                   5259: <pre class="programlisting">
1.100     rillig   5260: RCD_SCRIPTS+=   cupsd
1.1       grant    5261: </pre>
1.75      rillig   5262: </li>
                   5263: </ol></div>
                   5264: <p>Once this is done, pkginstall will do the following steps for each
                   5265: script in an automated fashion:</p>
1.128     wiz      5266: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5267: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76      rillig   5268:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   5269:     variable.</p></li>
1.128     wiz      5270: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76      rillig   5271:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   5272:     that this master file must be explicitly registered in the
1.76      rillig   5273:     <code class="filename">PLIST</code>.</p></li>
1.128     wiz      5274: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75      rillig   5275:     from the examples hierarchy into the system-wide startup scripts
                   5276:     directory.</p></li>
                   5277: </ol></div>
1.148     asau     5278: <div class="sect2">
1.75      rillig   5279: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5280: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   5281: <p>The automatic copying of config files can be toggled by setting the
                   5282: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   5283: installation.  Note that the scripts will be always copied inside the
1.76      rillig   5284: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   5285: matter what the value of this variable is.</p>
                   5286: </div>
                   5287: </div>
1.148     asau     5288: <div class="sect1">
1.75      rillig   5289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5290: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   5291: <p>If a package needs to create special users and/or groups during
                   5292: installation, it can do so by using the pkginstall framework.</p>
                   5293: <p>Users can be created by adding entries to the
                   5294: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   5295: syntax:</p>
                   5296: <pre class="programlisting">
1.100     rillig   5297: user:group
1.1       grant    5298: </pre>
1.87      wiz      5299: <p>Further specification of user details may be done by setting
                   5300: per-user variables.
                   5301: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   5302: numeric UID for the user.
                   5303: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   5304: user's description or comment.
                   5305: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   5306: user's home directory, and defaults to
                   5307: <code class="filename">/nonexistent</code> if not specified.
                   5308: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 5309: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      5310: not specified.</p>
1.75      rillig   5311: <p>Similarly, groups can be created by adding entries to the
                   5312: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   5313: <pre class="programlisting">
1.100     rillig   5314: group
1.1       grant    5315: </pre>
1.93      rillig   5316: <p>The numeric GID of the group may be set by defining
1.75      rillig   5317: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   5318: <p>If a package needs to create the users and groups at an earlier
1.227     wiz      5319: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   5320: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   5321: <code class="literal">pre-install</code> to indicate the phase before which the
                   5322: users and groups are created. In this case, the numeric UIDs and GIDs
                   5323: of the created users and groups are automatically hardcoded into the
                   5324: final installation scripts.</p>
1.75      rillig   5325: </div>
1.148     asau     5326: <div class="sect1">
1.75      rillig   5327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5328: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   5329: <p>Packages that install system shells should register them in the shell
1.76      rillig   5330: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   5331: administrator.  This must be done from the installation scripts to keep
                   5332: binary packages working on any system.  pkginstall provides an easy way to
                   5333: accomplish this task.</p>
                   5334: <p>When a package provides a shell interpreter, it has to set the
                   5335: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   5336: add some hooks to the installation scripts to handle it.  Consider the
1.189     snj      5337: 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   5338: <pre class="programlisting">
1.100     rillig   5339: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    5340: </pre>
1.148     asau     5341: <div class="sect2">
1.75      rillig   5342: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5343: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   5344: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   5345: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   5346: environment variable to <code class="literal">NO</code>.</p>
                   5347: </div>
                   5348: </div>
1.148     asau     5349: <div class="sect1">
1.75      rillig   5350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5351: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   5352: <p>Packages that install X11 fonts should update the database files
                   5353: that index the fonts within each fonts directory.  This can easily be
                   5354: accomplished within the pkginstall framework.</p>
                   5355: <p>When a package installs X11 fonts, it must list the directories in
                   5356: which fonts are installed in the
                   5357: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128     wiz      5358: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   5359: <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   5360: installation scripts to run the appropriate commands to update the fonts
                   5361: database files within each of those directories.  For convenience, if the
                   5362: directory path is relative, it is taken to be relative to the package's
1.189     snj      5363: 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   5364: <pre class="programlisting">
1.175     wiz      5365: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       grant    5366: </pre>
1.148     asau     5367: <div class="sect2">
1.75      rillig   5368: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5369: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   5370: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   5371: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   5372: environment variable to <code class="literal">NO</code>.</p>
                   5373: </div>
                   5374: </div>
                   5375: </div>
1.148     asau     5376: <div class="chapter">
1.75      rillig   5377: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5378: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   5379: <div class="toc">
                   5380: <p><b>Table of Contents</b></p>
1.210     leot     5381: <dl class="toc">
1.106     rillig   5382: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      5383: <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   5384: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   5385: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   5386: </dl>
                   5387: </div>
                   5388: <p>Many packages have the ability to be built to support different
1.76      rillig   5389: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   5390: in pkgsrc that provides generic handling of those options that
                   5391: determine different ways in which the packages can be built.  It's
                   5392: possible for the user to specify exactly which sets of options will be
                   5393: built into a package or to allow a set of global default options
                   5394: apply.</p>
1.107     rillig   5395: <p>There are two broad classes of behaviors that one might want to
                   5396: control via options.  One is whether some particular feature is
                   5397: enabled in a program that will be built anyway, often by including or
                   5398: not including a dependency on some other package.  The other is
                   5399: whether or not an additional program will be built as part of the
                   5400: package.  Generally, it is better to make a split package for such
                   5401: additional programs instead of using options, because it enables
                   5402: binary packages to be built which can then be added separately.  For
                   5403: example, the foo package might have minimal dependencies (those
                   5404: packages without which foo doesn't make sense), and then the foo-gfoo
                   5405: package might include the GTK frontend program gfoo.  This is better
                   5406: than including a gtk option to foo that adds gfoo, because either that
                   5407: option is default, in which case binary users can't get foo without
                   5408: gfoo, or not default, in which case they can't get gfoo.  With split
                   5409: packages, they can install foo without having GTK, and later decide to
                   5410: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5411: source users too, avoiding the need for rebuilds.</p>
                   5412: <p>Plugins with widely varying dependencies should usually be split
                   5413: instead of options.</p>
                   5414: <p>It is often more work to maintain split packages, especially if
                   5415: the upstream package does not support this.  The decision of split
                   5416: vs. option should be made based on the likelihood that users will want
                   5417: or object to the various pieces, the size of the dependencies that are
                   5418: included, and the amount of work.</p>
                   5419: <p>A further consideration is licensing.  Non-free parts, or parts
                   5420: that depend on non-free dependencies (especially plugins) should
                   5421: almost always be split if feasible.</p>
1.148     asau     5422: <div class="sect1">
1.75      rillig   5423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5424: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   5425: <p>Global default options are listed in
                   5426: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5427: that should be built into every package if that option is supported.
1.110     hubertf  5428: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5429: </div>
1.148     asau     5430: <div class="sect1">
1.75      rillig   5431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5432: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   5433: </h2></div></div></div>
1.75      rillig   5434: <p>The following example shows how
1.76      rillig   5435: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   5436: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   5437: <code class="filename">Makefile</code>, or in a file,
                   5438: e.g. <code class="filename">options.mk</code>, that is included by the
                   5439: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5440: <pre class="programlisting">
1.100     rillig   5441: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5442: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5443: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5444: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5445: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5446: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5447: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5448: 
                   5449: .include "../../mk/bsd.prefs.mk"
                   5450: 
                   5451: # this package was previously named wibble2
                   5452: .if defined(PKG_OPTIONS.wibble2)
                   5453: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5454: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5455:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5456: .endif
                   5457: 
                   5458: .include "../../mk/bsd.options.mk"
                   5459: 
                   5460: # Package-specific option-handling
                   5461: 
                   5462: ###
                   5463: ### FOO support
                   5464: ###
                   5465: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5466: CONFIGURE_ARGS+=    --enable-foo
                   5467: .endif
                   5468: 
                   5469: ###
                   5470: ### LDAP support
                   5471: ###
                   5472: .if !empty(PKG_OPTIONS:Mldap)
                   5473: .  include "../../databases/openldap-client/buildlink3.mk"
                   5474: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5475: .endif
                   5476: 
                   5477: ###
                   5478: ### database support
                   5479: ###
                   5480: .if !empty(PKG_OPTIONS:Mmysql)
                   5481: .  include "../../mk/mysql.buildlink3.mk"
                   5482: .endif
                   5483: .if !empty(PKG_OPTIONS:Mpgsql)
                   5484: .  include "../../mk/pgsql.buildlink3.mk"
                   5485: .endif
1.75      rillig   5486: </pre>
                   5487: <p>The first section contains the information about which build
                   5488: options are supported by the package, and any default options settings
                   5489: if needed.</p>
1.128     wiz      5490: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5491: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.189     snj      5492: <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   5493: options.  It should be set to
1.78      rillig   5494: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5495: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5496: at the point where the options are processed.</p></li>
1.128     wiz      5497: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75      rillig   5498: build options supported by the package.</p></li>
1.128     wiz      5499: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75      rillig   5500: list of names of groups of mutually exclusive options.  The options in
                   5501: each group are listed in
                   5502: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5503: The most specific setting of any option from the group takes
                   5504: precedence over all other options in the group.  Options from the
                   5505: groups will be automatically added to
                   5506: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128     wiz      5507: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75      rillig   5508: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5509: packages will fail if no option from the group is
                   5510: selected.</p></li>
1.128     wiz      5511: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75      rillig   5512: of names of sets of options.  At least one option from each set must
                   5513: be selected.  The options in each set are listed in
                   5514: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5515: Options from the sets will be automatically added to
                   5516: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5517: fail if no option from the set is selected.</p></li>
1.128     wiz      5518: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75      rillig   5519: build options which are enabled by default.</p></li>
1.128     wiz      5520: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75      rillig   5521: of
1.128     wiz      5522: <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  5523: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   5524: their option counterparts.  Pairs should be added with
1.128     wiz      5525: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.75      rillig   5526: warning will be issued if the user uses a legacy
                   5527: variable.</p></li>
1.128     wiz      5528: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75      rillig   5529: of
1.128     wiz      5530: <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   5531: pairs that map options that have been renamed to their new
1.128     wiz      5532: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.75      rillig   5533: the listing of global legacy options.  A warning will be issued if
                   5534: the user uses a legacy option.</p></li>
1.128     wiz      5535: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75      rillig   5536: options implied by deprecated variables used.  This can be used for
                   5537: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5538: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5539: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128     wiz      5540: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75      rillig   5541: a list of warnings about deprecated variables or options used, and
                   5542: what to use instead.</p></li>
                   5543: </ol></div>
                   5544: <p>A package should never modify
                   5545: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5546: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5547: To suggest a default set of options, use
                   5548: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5549: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   5550: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   5551: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5552: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5553: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5554: happen with platform-specific options if none of them is supported on
                   5555: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5556: empty list and the package is otherwise treated as not using the
                   5557: options framework.</p>
1.76      rillig   5558: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   5559: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5560: build options, properly filtered to remove unsupported and duplicate
                   5561: options.</p>
                   5562: <p>The remaining sections contain the logic that is specific to
                   5563: each option.  The correct way to check for an option is to check
                   5564: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5565: <pre class="programlisting">
1.100     rillig   5566: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   5567: </pre>
                   5568: </div>
1.148     asau     5569: <div class="sect1">
1.75      rillig   5570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5571: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   5572: <p>Options that enable similar features in different packages (like
                   5573: optional support for a library) should use a common name in all
                   5574: packages that support it (like the name of the library).  If another
                   5575: package already has an option with the same meaning, use the same
                   5576: name.</p>
                   5577: <p>Options that enable features specific to one package, where it's
                   5578: unlikely that another (unrelated) package has the same (or a similar)
                   5579: optional feature, should use a name prefixed with
                   5580: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5581: <p>If a group of related packages share an optional feature
                   5582: specific to that group, prefix it with the name of the
1.128     wiz      5583: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.75      rillig   5584: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5585: <p>For new options, add a line to
1.76      rillig   5586: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   5587: fields, separated by tab.  The first field is the option name, the
                   5588: second its description.  The description should be a whole sentence
                   5589: (starting with an uppercase letter and ending with a period) that
1.128     wiz      5590: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5591: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.75      rillig   5592: </div>
1.148     asau     5593: <div class="sect1">
1.107     rillig   5594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5595: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  5596: <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   5597: different dependencies based on the options with which the package was
                   5598: built. For querying these options, the file
                   5599: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5600: typical example looks like this:</p>
                   5601: <pre class="programlisting">
                   5602: pkgbase := libpurple
                   5603: .include "../../mk/pkg-build-options.mk"
                   5604: 
                   5605: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5606: ...
                   5607: .endif
                   5608: </pre>
                   5609: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5610: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5611: options of the libpurple package, which can then be queried like
                   5612: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5613: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5614: details.</p>
                   5615: </div>
1.75      rillig   5616: </div>
1.148     asau     5617: <div class="chapter">
1.75      rillig   5618: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5619: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   5620: <div class="toc">
                   5621: <p><b>Table of Contents</b></p>
1.210     leot     5622: <dl class="toc">
1.106     rillig   5623: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   5624: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   5625: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   5626: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      5627: <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   5628: <dd><dl>
                   5629: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   5630: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   5631: </dl></dd>
1.128     wiz      5632: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   5633: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   5634: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   5635: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   5636: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   5637: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   5638: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   5639: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   5640: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   5641: <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   5642: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   5643: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   5644: </dl>
                   5645: </div>
1.148     asau     5646: <div class="sect1">
1.75      rillig   5647: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5648: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   5649: <p>This chapter gives a detailed description on how a package is
1.87      wiz      5650:     built. Building a package is separated into different
                   5651:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   5652:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120     snj      5653:     described in the following sections. Each phase is split into
1.87      wiz      5654:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   5655:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   5656:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   5657:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   5658:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   5659: <p>Never override the regular targets (like
                   5660:     <code class="varname">fetch</code>), if you have to, override the
                   5661:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   5662: <p>The basic steps for building a program are always the same.  First
1.87      wiz      5663:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   5664:     the local system and then extracted. After any pkgsrc-specific patches
                   5665:     to compile properly are applied, the software can be configured, then
                   5666:     built (usually by compiling), and finally the generated binaries, etc.
                   5667:     can be put into place on the system.</p>
1.97      rillig   5668: <p>To get more details about what is happening at each step,
                   5669:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   5670:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   5671:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   5672: </div>
1.148     asau     5673: <div class="sect1">
1.75      rillig   5674: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5675: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   5676: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      5677:     the next section, here's a brief discussion on where programs are
                   5678:     installed, and which variables influence this.</p>
1.75      rillig   5679: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      5680:     where all files of the final program shall be installed. It is
                   5681:     usually set to <code class="varname">LOCALBASE</code>
                   5682:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      5683:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      5684:     <code class="varname">PREFIX</code> needs to be put
                   5685:     into the various places in the program's source where paths to
1.219     rillig   5686:     these files are encoded.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.75      rillig   5687: <p>When choosing which of these variables to use,
1.87      wiz      5688:     follow the following rules:</p>
1.148     asau     5689: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5690: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88      wiz      5691:        where the current pkg will be installed.  When referring to a
                   5692:        pkg's own installation path, use
1.128     wiz      5693:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   5694: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88      wiz      5695:        are installed.  If you need to construct a -I or -L argument
                   5696:        to the compiler to find includes and libraries installed by
1.128     wiz      5697:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.87      wiz      5698:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   5699:        installed all packages in <code class="filename">/usr/local</code>. As
                   5700:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   5701:        administrator, this variable is a misnomer.</p></li>
1.128     wiz      5702: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88      wiz      5703:        distribution (from xsrc, etc.) is installed. When looking for
                   5704:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128     wiz      5705:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
1.209     sevan    5706: <li class="listitem"><p>X11-based packages using imake must set
                   5707:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   5708:        <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      5709: <li class="listitem">
1.209     sevan    5710: <p>To determine the prefix of an
1.88      wiz      5711:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   5712:        definition can be used. It takes pairs in the format
1.189     snj      5713:        <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      5714:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   5715:        of the installed package &lt;package&gt;, or
1.209     sevan    5716:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> if the package is not
1.88      wiz      5717:        installed.</p>
1.75      rillig   5718: <p>This is best illustrated by example.</p>
                   5719: <p>The following lines are taken from
1.87      wiz      5720:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   5721: <pre class="programlisting">
1.100     rillig   5722: EVAL_PREFIX+=           GTKDIR=gtk+
                   5723: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   5724: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   5725: CONFIGURE_ARGS+=        --enable-multibyte
                   5726: </pre>
1.88      wiz      5727: <p>Specific defaults can be defined for the packages
                   5728:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   5729:        definition of the form:</p>
1.75      rillig   5730: <pre class="programlisting">
1.100     rillig   5731: GTKDIR_DEFAULT= ${LOCALBASE}
                   5732: </pre>
1.75      rillig   5733: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      5734:        to the first definition in
                   5735:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   5736: </li>
1.128     wiz      5737: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.189     snj      5738:        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      5739:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   5740:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   5741: </ul></div>
                   5742: </div>
1.148     asau     5743: <div class="sect1">
1.75      rillig   5744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5745: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 5746: <p>When building a package, various directories are used to store
1.87      wiz      5747:     source files, temporary files, pkgsrc-internal files, and so on. These
                   5748:     directories are explained here.</p>
1.75      rillig   5749: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      5750:     are two common base directories for these relative directories:
                   5751:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   5752:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   5753:     inside the package itself.</p>
1.148     asau     5754: <div class="variablelist"><dl class="variablelist">
1.75      rillig   5755: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   5756: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      5757:       root directory. Generally, you don't need
                   5758:       it.</p></dd>
1.97      rillig   5759: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   5760: <dd><p>This is an absolute pathname that points to the
                   5761:       current package.</p></dd>
1.75      rillig   5762: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   5763: <dd><p>This is a pathname relative to
1.87      wiz      5764:       <code class="varname">PKGSRCDIR</code> that points to the current
                   5765:       package.</p></dd>
1.75      rillig   5766: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   5767: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   5768:       where all work takes place. The distfiles are extracted to this
1.87      wiz      5769:       directory. It also contains temporary directories and log files used by
                   5770:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   5771:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   5772: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   5773: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      5774:       where the distfiles are extracted. It is usually a direct subdirectory
                   5775:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   5776:       that isn't hidden. This variable may be changed by a package
                   5777:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   5778: </dl></div>
1.114     jmcneill 5779: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   5780:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   5781:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 5782:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   5783:     If users would like to have their pkgsrc trees behave in a
                   5784:     read-only manner, then the value of
                   5785:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   5786:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   5787: </div>
1.148     asau     5788: <div class="sect1">
1.75      rillig   5789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5790: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  5791: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      5792:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   5793:     phase. This will automatically run all phases that are required for this
                   5794:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  5795:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      5796:     the package will be built, but not installed.</p>
1.75      rillig   5797: </div>
1.148     asau     5798: <div class="sect1">
1.75      rillig   5799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5800: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   5801: <p>The first step in building a package is to fetch the
1.88      wiz      5802:     distribution files (distfiles) from the sites that are providing
                   5803:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   5804:     phase.</p>
1.148     asau     5805: <div class="sect2">
1.81      rillig   5806: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5807: <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      5808: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   5809:       defines all URLs from where the distfile, whose name is
                   5810:       derived from the <code class="varname">DISTNAME</code> variable, is
                   5811:       fetched. The more complicated cases are described
                   5812:       below.</p>
                   5813: <p>The variable <code class="varname">DISTFILES</code> specifies
                   5814:       the list of distfiles that have to be fetched. Its value
1.174     asau     5815:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   5816:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88      wiz      5817:       so that most packages don't need to define it at all.
                   5818:       <code class="varname">EXTRACT_SUFX</code> is
                   5819:       <code class="literal">.tar.gz</code> by default, but can be changed
                   5820:       freely. Note that if your package requires additional
                   5821:       distfiles to the default one, you cannot just append the
                   5822:       additional filenames using the <code class="literal">+=</code>
                   5823:       operator, but you have write for example:</p>
1.81      rillig   5824: <pre class="programlisting">
1.174     asau     5825: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100     rillig   5826: </pre>
1.88      wiz      5827: <p>Each distfile is fetched from a list of sites, usually
                   5828:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   5829:       <code class="varname">DISTFILES</code> or multiple
                   5830:       <code class="varname">PATCHFILES</code> from different sites, you can
                   5831:       set
                   5832:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   5833:       to the list of URLs where the file
                   5834:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   5835:       (including the suffix) can be found.</p>
                   5836: <pre class="programlisting">
1.100     rillig   5837: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   5838: DISTFILES+=     foo-file.tar.gz
                   5839: SITES.foo-file.tar.gz= \
                   5840: http://www.somewhere.com/somehow/ \
                   5841: http://www.somewhereelse.com/mirror/somehow/
                   5842: </pre>
1.81      rillig   5843: <p>When actually fetching the distfiles, each item from
1.88      wiz      5844:       <code class="varname">MASTER_SITES</code> or
                   5845:       <code class="varname">SITES.*</code> gets the name of each distfile
                   5846:       appended to it, without an intermediate slash. Therefore,
                   5847:       all site values have to end with a slash or other separator
                   5848:       character. This allows for example to set
                   5849:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   5850:       that gets the name of the distfile as a parameter. In this
                   5851:       case, the definition would look like:</p>
1.81      rillig   5852: <pre class="programlisting">
1.100     rillig   5853: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   5854: </pre>
1.125     wiz      5855: <p> The exception to this rule are URLs starting with a dash.
1.174     asau     5856:       In that case the URL is taken as is, fetched and the result
                   5857:       stored under the name of the distfile. You can use this style
                   5858:       for the case when the download URL style does not match the
                   5859:       above common case. For example, if permanent download URL is a
                   5860:       redirector to the real download URL, or the download file name
                   5861:       is offered by an HTTP Content-Disposition header. In the
                   5862:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   5863:       created instead of the default
                   5864:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   5865: <pre class="programlisting">
                   5866: DISTNAME=       foo-1.0.0
                   5867: MASTER_SITES=   -http://www.example.com/archive/v1.0.0.tar.gz
                   5868: </pre>
1.81      rillig   5869: <p>There are some predefined values for
1.88      wiz      5870:       <code class="varname">MASTER_SITES</code>, which can be used in
                   5871:       packages.  The names of the variables should speak for
                   5872:       themselves.</p>
                   5873: <pre class="programlisting">
1.100     rillig   5874: ${MASTER_SITE_APACHE}
                   5875: ${MASTER_SITE_BACKUP}
                   5876: ${MASTER_SITE_CYGWIN}
                   5877: ${MASTER_SITE_DEBIAN}
                   5878: ${MASTER_SITE_FREEBSD}
                   5879: ${MASTER_SITE_FREEBSD_LOCAL}
                   5880: ${MASTER_SITE_GENTOO}
                   5881: ${MASTER_SITE_GNOME}
                   5882: ${MASTER_SITE_GNU}
                   5883: ${MASTER_SITE_GNUSTEP}
1.174     asau     5884: ${MASTER_SITE_HASKELL_HACKAGE}
1.100     rillig   5885: ${MASTER_SITE_IFARCHIVE}
                   5886: ${MASTER_SITE_KDE}
                   5887: ${MASTER_SITE_MOZILLA}
1.174     asau     5888: ${MASTER_SITE_MOZILLA_ALL}
                   5889: ${MASTER_SITE_MOZILLA_ESR}
1.100     rillig   5890: ${MASTER_SITE_MYSQL}
1.174     asau     5891: ${MASTER_SITE_NETLIB}
1.100     rillig   5892: ${MASTER_SITE_OPENOFFICE}
1.208     ryoon    5893: ${MASTER_SITE_OSDN}
1.100     rillig   5894: ${MASTER_SITE_PERL_CPAN}
                   5895: ${MASTER_SITE_PGSQL}
1.174     asau     5896: ${MASTER_SITE_RUBYGEMS}
1.100     rillig   5897: ${MASTER_SITE_R_CRAN}
                   5898: ${MASTER_SITE_SOURCEFORGE}
                   5899: ${MASTER_SITE_SUNSITE}
                   5900: ${MASTER_SITE_SUSE}
                   5901: ${MASTER_SITE_TEX_CTAN}
                   5902: ${MASTER_SITE_XCONTRIB}
                   5903: ${MASTER_SITE_XEMACS}
1.174     asau     5904: ${MASTER_SITE_XORG}
1.100     rillig   5905: </pre>
1.88      wiz      5906: <p>Some explanations for the less self-explaining ones:
                   5907:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133     wiz      5908:       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      5909:       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      5910: <p>If you choose one of these predefined sites, you may
                   5911:       want to specify a subdirectory of that site. Since these
                   5912:       macros may expand to more than one actual site, you
                   5913:       <span class="emphasis"><em>must</em></span> use the following construct to
                   5914:       specify a subdirectory:</p>
1.81      rillig   5915: <pre class="programlisting">
1.100     rillig   5916: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   5917: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   5918: </pre>
1.81      rillig   5919: <p>Note the trailing slash after the subdirectory
1.88      wiz      5920:       name.</p>
1.81      rillig   5921: </div>
1.148     asau     5922: <div class="sect2">
1.81      rillig   5923: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5924: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      5925: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   5926:       all the distfiles exist in a local directory
1.93      rillig   5927:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      5928:       user). If the files do not exist, they are fetched using
                   5929:       commands of the form</p>
1.75      rillig   5930: <pre class="programlisting">
1.100     rillig   5931: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   5932: </pre>
1.88      wiz      5933: <p>where <code class="literal">${site}</code> varies through
                   5934:       several possibilities in turn: first,
                   5935:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   5936:       sites specified in either <code class="varname">SITES.file</code> if
                   5937:       defined, else <code class="varname">MASTER_SITES</code> or
                   5938:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   5939:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   5940:       all except the first and the last can be optionally sorted
                   5941:       by the user, via setting either
                   5942:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   5943:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      5944:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  5945: <p> The specific command and arguments used depend on the
                   5946:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   5947:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   5948: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   5949:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   5950:       distfiles, if they are freely distributable.  Packages setting
                   5951:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128     wiz      5952:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.97      rillig   5953:       mirrored.</p>
1.81      rillig   5954: </div>
1.75      rillig   5955: </div>
1.148     asau     5956: <div class="sect1">
1.75      rillig   5957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5958: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      5959: <p>After the distfile(s) are fetched, their checksum is
                   5960:     generated and compared with the checksums stored in the
                   5961:     distinfo file. If the checksums don't match, the build is
                   5962:     aborted. This is to ensure the same distfile is used for
                   5963:     building, and that the distfile wasn't changed, e.g. by some
                   5964:     malign force, deliberately changed distfiles on the master
                   5965:     distribution site or network lossage.</p>
1.75      rillig   5966: </div>
1.148     asau     5967: <div class="sect1">
1.75      rillig   5968: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5969: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   5970: <p>When the distfiles are present on the local system, they
1.88      wiz      5971:     need to be extracted, as they usually come in the form of some
                   5972:     compressed archive format.</p>
1.75      rillig   5973: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      5974:     extracted. If you only need some of them, you can set the
                   5975:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   5976:     files.</p>
                   5977: <p>Extracting the files is usually done by a little
1.93      rillig   5978:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      5979:     already knows how to extract various archive formats, so most
                   5980:     likely you will not need to change anything here. But if you
                   5981:     need, the following variables may help you:</p>
1.148     asau     5982: <div class="variablelist"><dl class="variablelist">
1.75      rillig   5983: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   5984: <dd><p>Use these variables to override the default
1.88      wiz      5985:       options for an extract command, which are defined in
1.93      rillig   5986:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   5987: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   5988: <dd><p>This variable can be set to
1.114     jmcneill 5989:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   5990:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      5991:       absolute pathname pointing to the command with which tar
1.114     jmcneill 5992:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   5993:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   5994: </dl></div>
1.88      wiz      5995: <p>If the <code class="filename">extract</code> program doesn't
                   5996:     serve your needs, you can also override the
                   5997:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   5998:     command used for extracting the files. This command is
                   5999:     executed in the <code class="filename">${WRKSRC}</code>
                   6000:     directory. During execution of this command, the shell
                   6001:     variable <code class="varname">extract_file</code> holds the absolute
                   6002:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6003: <p>And if that still does not suffice, you can override the
1.88      wiz      6004:     <code class="varname">do-extract</code> target in the package
                   6005:     Makefile.</p>
1.75      rillig   6006: </div>
1.148     asau     6007: <div class="sect1">
1.75      rillig   6008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6009: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6010: <p>After extraction, all the patches named by the
1.88      wiz      6011:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6012:     subdirectory of the package as well as in
                   6013:     $LOCALPATCHES/$PKGPATH (e.g.
                   6014:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6015:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6016:     <code class="filename">.gz</code> are uncompressed before they are
                   6017:     applied, files ending in <code class="filename">.orig</code> or
                   6018:     <code class="filename">.rej</code> are ignored. Any special options to
1.189     snj      6019:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.219     rillig   6020:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more details.</p>
1.189     snj      6021: <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      6022:     it fail if the patches apply with some lines of fuzz. Please
                   6023:     fix (regen) the patches so that they apply cleanly. The
                   6024:     rationale behind this is that patches that don't apply cleanly
                   6025:     may end up being applied in the wrong place, and cause severe
                   6026:     harm there.</p>
1.75      rillig   6027: </div>
1.148     asau     6028: <div class="sect1">
1.75      rillig   6029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6030: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  6031: <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      6032:     </p>
1.75      rillig   6033: </div>
1.148     asau     6034: <div class="sect1">
1.75      rillig   6035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6036: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6037: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6038:     linkers. The following variables can be used to tweak the
                   6039:     wrappers.</p>
1.148     asau     6040: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6041: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6042: <dd><p>The command used to print progress
1.88      wiz      6043:       messages. Does nothing by default. Set to
                   6044:       <code class="literal">${ECHO}</code> to see the progress
                   6045:       messages.</p></dd>
1.75      rillig   6046: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6047: <dd><p>This variable can be set to
1.88      wiz      6048:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6049:       depending on whether you want additional information in the
                   6050:       wrapper log file.</p></dd>
1.75      rillig   6051: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6052: <dd><p>This variable can be set to
1.88      wiz      6053:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6054:       on whether the wrapper should use its cache, which will
                   6055:       improve the speed. The default value is
                   6056:       <code class="literal">yes</code>, but is forced to
                   6057:       <code class="literal">no</code> if the platform does not support
                   6058:       it.</p></dd>
1.75      rillig   6059: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6060: <dd><p>A list of reordering commands. A reordering
                   6061:       command has the form
                   6062:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6063:       It ensures that that
                   6064:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6065:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6066:       </p></dd>
1.75      rillig   6067: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6068: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6069:       investigate further]</p></dd>
1.75      rillig   6070: </dl></div>
                   6071: </div>
1.148     asau     6072: <div class="sect1">
1.75      rillig   6073: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6074: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6075: <p>Most pieces of software need information on the header
                   6076:     files, system calls, and library routines which are available
                   6077:     on the platform they run on. The process of determining this
                   6078:     information is known as configuration, and is usually
                   6079:     automated. In most cases, a script is supplied with the
                   6080:     distfiles, and its invocation results in generation of header
                   6081:     files, Makefiles, etc.</p>
                   6082: <p>If the package contains a configure script, this can be
                   6083:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128     wiz      6084:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.88      wiz      6085:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128     wiz      6086:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.88      wiz      6087:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6088: <pre class="programlisting">
1.100     rillig   6089: .for d in ${CONFIGURE_DIRS}
                   6090:         cd ${WRKSRC} \
                   6091:         &amp;&amp; cd ${d} \
                   6092:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6093: .endfor
                   6094: </pre>
1.88      wiz      6095: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128     wiz      6096:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6097:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6098:     configure script is run with the environment
                   6099:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6100:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6101:     <code class="varname">CONFIGURE_ENV</code>,
                   6102:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128     wiz      6103:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.88      wiz      6104:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6105:     package.</p>
1.144     wiz      6106: <p>If the program uses the Perl way of configuration (mainly Perl
                   6107:     modules, but not only), i.e. a file called
                   6108:     <code class="filename">Makefile.PL</code>, it should include
                   6109:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6110:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6111:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88      wiz      6112: <p>If the program uses an <code class="filename">Imakefile</code>
                   6113:     for configuration, the appropriate steps can be invoked by
                   6114:     setting <code class="varname">USE_IMAKE</code> to
1.209     sevan    6115:     <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>.
                   6116:     You can add variables to xmkmf's environment by adding them to the
1.97      rillig   6117:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   6118: <p>If the program uses <code class="filename">cmake</code>
                   6119:     for configuration, the appropriate steps can be invoked by
1.128     wiz      6120:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.111     rillig   6121:     You can add variables to cmake's environment by adding them to the
                   6122:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6123:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6124:     The top directory argument is given by the
                   6125:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128     wiz      6126:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   6127: <p>If there is no configure step at all, set
1.128     wiz      6128:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6129: </div>
1.148     asau     6130: <div class="sect1">
1.75      rillig   6131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6132: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6133: <p>For building a package, a rough equivalent of the
                   6134:     following code is executed.</p>
1.75      rillig   6135: <pre class="programlisting">
1.100     rillig   6136: .for d in ${BUILD_DIRS}
                   6137:         cd ${WRKSRC} \
                   6138:         &amp;&amp; cd ${d} \
                   6139:         &amp;&amp; env ${MAKE_ENV} \
                   6140:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6141:                 -f ${MAKE_FILE} \
                   6142:                 ${BUILD_TARGET}
                   6143: .endfor
                   6144: </pre>
1.88      wiz      6145: <p><code class="varname">BUILD_DIRS</code> (default:
1.128     wiz      6146:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6147:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6148:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6149:     <code class="varname">MAKE_ENV</code> and arguments
                   6150:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6151:     <code class="varname">MAKE_ENV</code>,
                   6152:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6153:     <code class="varname">MAKE_FILE</code> and
                   6154:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6155:     package.</p>
1.75      rillig   6156: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128     wiz      6157:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6158:     <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      6159:     default value of <code class="varname">MAKE_FILE</code> is
1.128     wiz      6160:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6161:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.97      rillig   6162: <p>If there is no build step at all, set
1.128     wiz      6163:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6164: </div>
1.148     asau     6165: <div class="sect1">
1.75      rillig   6166: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6167: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6168: <p>[TODO]</p>
                   6169: </div>
1.148     asau     6170: <div class="sect1">
1.75      rillig   6171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6172: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6173: <p>Once the build stage has completed, the final step is to
1.88      wiz      6174:     install the software in public directories, so users can
                   6175:     access the programs and files.</p>
1.75      rillig   6176: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6177:     equivalent of the following code is executed. Additionally,
                   6178:     before and after this code, much magic is performed to do
                   6179:     consistency checks, registering the package, and so on.</p>
                   6180: <pre class="programlisting">
1.100     rillig   6181: .for d in ${INSTALL_DIRS}
                   6182:         cd ${WRKSRC} \
                   6183:         &amp;&amp; cd ${d} \
                   6184:         &amp;&amp; env ${MAKE_ENV} \
                   6185:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6186:                 -f ${MAKE_FILE} \
                   6187:                 ${INSTALL_TARGET}
                   6188: .endfor
                   6189: </pre>
1.75      rillig   6190: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6191:     <span class="emphasis"><em>build</em></span> phase.
                   6192:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6193:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128     wiz      6194:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   6195:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.88      wiz      6196:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6197:     defined.</p>
1.75      rillig   6198: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6199:     variables are useful. They are all variations of the
1.189     snj      6200:     <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      6201:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6202:     install command. The specialized variants, together with their
                   6203:     intended use, are:</p>
1.148     asau     6204: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6205: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6206: <dd><p>directories that contain
                   6207:       binaries</p></dd>
1.75      rillig   6208: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6209: <dd><p>directories that contain
                   6210:       scripts</p></dd>
1.75      rillig   6211: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6212: <dd><p>directories that contain shared and static
                   6213:       libraries</p></dd>
1.75      rillig   6214: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6215: <dd><p>directories that contain data
                   6216:       files</p></dd>
1.75      rillig   6217: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6218: <dd><p>directories that contain man
                   6219:       pages</p></dd>
1.210     leot     6220: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   6221: <dd><p>directories that contain data files for games
                   6222:       </p></dd>
1.75      rillig   6223: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      6224: <dd><p>binaries that can be stripped from debugging
                   6225:       symbols</p></dd>
1.75      rillig   6226: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      6227: <dd><p>binaries that cannot be
                   6228:       stripped</p></dd>
1.75      rillig   6229: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      6230: <dd><p>game
                   6231:       binaries</p></dd>
1.75      rillig   6232: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      6233: <dd><p>shared and static
                   6234:       libraries</p></dd>
1.75      rillig   6235: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6236: <dd><p>data files</p></dd>
                   6237: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      6238: <dd><p>data files for
                   6239:       games</p></dd>
1.75      rillig   6240: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6241: <dd><p>man pages</p></dd>
                   6242: </dl></div>
                   6243: <p>Some other variables are:</p>
1.148     asau     6244: <div class="variablelist"><dl class="variablelist">
1.216     tnn      6245: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
                   6246: <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>
                   6247:       when installing binaries. Any debugging sections and symbols present in
                   6248:       binaries will be preserved.
                   6249:       </p></dd>
1.75      rillig   6250: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6251: <dd><p>A list of directories relative to
1.88      wiz      6252:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      6253:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6254:       The package is supposed to create all needed directories itself
                   6255:       before installing files to it and list all other directories here.
                   6256:       </p></dd>
1.75      rillig   6257: </dl></div>
1.97      rillig   6258: <p>In the rare cases that a package shouldn't install anything,
1.128     wiz      6259:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.97      rillig   6260:     mostly relevant for packages in the <code class="filename">regress</code>
                   6261:     category.</p>
1.75      rillig   6262: </div>
1.148     asau     6263: <div class="sect1">
1.75      rillig   6264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6265: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      6266: <p>Once the install stage has completed, a binary package of
                   6267:     the installed files can be built.  These binary packages can be
                   6268:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  6269:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   6270:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      6271: <p>By default, the binary packages are created in
                   6272:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6273:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6274:     one for each category in the <code class="varname">CATEGORIES</code>
                   6275:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6276:     <code class="filename">pkgsrc/packages</code>.</p>
                   6277: </div>
1.148     asau     6278: <div class="sect1">
1.88      wiz      6279: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6280: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      6281: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  6282:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      6283:     to clean the work directories of all dependencies too, use
1.110     hubertf  6284:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   6285: </div>
1.148     asau     6286: <div class="sect1">
1.75      rillig   6287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6288: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148     asau     6289: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6290: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      6291: <dd><p>For any of the main targets described in the
                   6292:          previous section, two auxiliary targets exist with
1.128     wiz      6293:          <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      6294:          prefix for the main target's name.  These targets are
1.88      wiz      6295:          invoked before and after the main target is called,
                   6296:          allowing extra configuration or installation steps be
                   6297:          performed from a package's Makefile, for example, which
                   6298:          a program's configure script or install target
                   6299:          omitted.</p></dd>
1.75      rillig   6300: <dt><span class="term">do-*</span></dt>
1.88      wiz      6301: <dd><p>Should one of the main targets do the wrong thing,
                   6302:          and should there be no variable to fix this, you can
                   6303:          redefine it with the do-* target.  (Note that redefining
                   6304:          the target itself instead of the do-* target is a bad
                   6305:          idea, as the pre-* and post-* targets won't be called
                   6306:          anymore, etc.) You will not usually need to do
                   6307:          this.</p></dd>
1.75      rillig   6308: <dt><span class="term">reinstall</span></dt>
1.88      wiz      6309: <dd>
1.110     hubertf  6310: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      6311:          you noticed some file was not installed properly, you
                   6312:          can repeat the installation with this target, which will
1.128     wiz      6313:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.88      wiz      6314: <p>This is the default value of
                   6315:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  6316:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      6317:          package</strong></span>, where the defaults are
1.128     wiz      6318:          <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      6319:          respectively.</p>
                   6320: </dd>
1.75      rillig   6321: <dt><span class="term">deinstall</span></dt>
                   6322: <dd>
1.189     snj      6323: <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      6324:          current directory, effectively de-installing the
                   6325:          package. The following variables can be used to tune the
                   6326:          behaviour:</p>
1.148     asau     6327: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6328: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.189     snj      6329: <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   6330: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      6331: <dd><p>Remove all packages that require (depend on)
                   6332:                the given package.  This can be used to remove any
                   6333:                packages that may have been pulled in by a given
1.110     hubertf  6334:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      6335:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      6336:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   6337:                likely to remove whole KDE. Works by adding
1.189     snj      6338:                <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      6339:                command line.</p></dd>
1.75      rillig   6340: </dl></div>
                   6341: </dd>
1.88      wiz      6342: <dt><span class="term">bin-install</span></dt>
                   6343: <dd><p>Install a binary package from local disk and via FTP
                   6344:          from a list of sites (see the
                   6345:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  6346:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      6347:          available anywhere.  The arguments given to
1.110     hubertf  6348:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      6349:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   6350:          operation, etc.</p></dd>
1.205     wiz      6351: <dt><span class="term">install-clean</span></dt>
                   6352: <dd><p>This target removes the state files for the "install" and later
                   6353:          phases so that the "install" target may be re-invoked. This can be
                   6354:          used after editing the PLIST to install the package without
                   6355:          rebuilding it.</p></dd>
                   6356: <dt><span class="term">build-clean</span></dt>
                   6357: <dd><p>This target removes the state files for the "build" and later
                   6358:          phases so that the "build" target may be re-invoked.</p></dd>
1.75      rillig   6359: <dt><span class="term">update</span></dt>
                   6360: <dd>
1.88      wiz      6361: <p>This target causes the current package to be
                   6362:          updated to the latest version.  The package and all
                   6363:          depending packages first get de-installed, then current
                   6364:          versions of the corresponding packages get compiled and
                   6365:          installed.  This is similar to manually noting which
                   6366:          packages are currently installed, then performing a
1.110     hubertf  6367:          series of <span class="command"><strong>make deinstall</strong></span> and
                   6368:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      6369:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   6370:          packages.</p>
1.128     wiz      6371: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.110     hubertf  6372:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      6373:          update</strong></span> was interrupted for some reason.
                   6374:          However, in this case, make sure you don't call
1.110     hubertf  6375:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      6376:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   6377:          Otherwise, you lose the ability to automatically update
                   6378:          the current package along with the dependent packages
                   6379:          you have installed.</p>
1.110     hubertf  6380: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      6381:          update</strong></span> will only work as long as the package
                   6382:          tree remains unchanged.  If the source code for one of
                   6383:          the packages to be updated has been changed, resuming
1.110     hubertf  6384:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      6385:          fail!</p>
                   6386: <p>The following variables can be used either on the
1.110     hubertf  6387:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   6388:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      6389:          update</strong></span>:</p>
1.148     asau     6390: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6391: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      6392: <dd><p>Install target to recursively use for the
                   6393:                updated package and the dependent packages.
                   6394:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128     wiz      6395:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.110     hubertf  6396:                <span class="command"><strong>make update</strong></span>.  Other good
1.128     wiz      6397:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   6398:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   6399:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.88      wiz      6400:                endless loop!</p></dd>
1.75      rillig   6401: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      6402: <dd><p>Don't clean up after updating.  Useful if
                   6403:                you want to leave the work sources of the updated
                   6404:                packages around for inspection or other purposes.
                   6405:                Be sure you eventually clean up the source tree
1.128     wiz      6406:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.88      wiz      6407:                or you may run into troubles with old source code
                   6408:                still lying around on your next
1.110     hubertf  6409:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      6410:                update</strong></span>.</p></dd>
1.75      rillig   6411: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      6412: <dd><p>Deinstall each package before installing
                   6413:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   6414:                may be necessary if the
1.128     wiz      6415:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.110     hubertf  6416:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      6417:                update</strong></span>.</p></dd>
1.75      rillig   6418: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      6419: <dd><p>Allows you to disable recursion and hardcode
                   6420:                the target for packages.  The default is
1.128     wiz      6421:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.88      wiz      6422:                facilitating a recursive update of prerequisite
                   6423:                packages.  Only set
                   6424:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   6425:                disable recursive updates. Use
                   6426:                <code class="varname">UPDATE_TARGET</code> instead to just
                   6427:                set a specific target for each package to be
1.110     hubertf  6428:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      6429:                (see above).</p></dd>
1.75      rillig   6430: </dl></div>
                   6431: </dd>
                   6432: <dt><span class="term">clean-update</span></dt>
                   6433: <dd>
1.88      wiz      6434: <p>Clean the source tree for all packages that would
1.110     hubertf  6435:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      6436:          from the current directory.  This target should not be
                   6437:          used if the current package (or any of its depending
                   6438:          packages) have already been de-installed (e.g., after
1.110     hubertf  6439:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      6440:          some packages you intended to update. As a rule of
                   6441:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  6442:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      6443:          and only if you have a dirty package tree (e.g., if you
                   6444:          used <code class="varname">NOCLEAN</code>).</p>
                   6445: <p>If you are unsure about whether your tree is
1.110     hubertf  6446:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      6447:          clean</strong></span> at the top of the tree, or use the
                   6448:          following sequence of commands from the directory of the
                   6449:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  6450:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      6451:          time, otherwise you lose all the packages you wanted to
                   6452:          update!):</p>
1.87      wiz      6453: <pre class="screen">
                   6454: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   6455: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      6456: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   6457:          </pre>
1.88      wiz      6458: <p>The following variables can be used either on the
1.110     hubertf  6459:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   6460:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.148     asau     6461: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6462: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  6463: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      6464:                reconstruct the list of directories to update for
1.110     hubertf  6465:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      6466:                update</strong></span> successfully installed all
                   6467:                packages you wanted to update.  Normally, this is
1.110     hubertf  6468:                done automatically on <span class="command"><strong>make
1.88      wiz      6469:                update</strong></span>, but may have been suppressed by
                   6470:                the <code class="varname">NOCLEAN</code> variable (see
                   6471:                above).</p></dd>
1.75      rillig   6472: </dl></div>
                   6473: </dd>
1.88      wiz      6474: <dt><span class="term">replace</span></dt>
                   6475: <dd>
                   6476: <p>Update the installation of the current package.  This
                   6477:          differs from update in that it does not replace dependent
1.189     snj      6478:          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      6479:          target to work.</p>
                   6480: <p><span class="emphasis"><em>Be careful when using this
                   6481:          target!</em></span> There are no guarantees that dependent
                   6482:          packages will still work, in particular they will most
1.110     hubertf  6483:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      6484:          library package whose shared library major version changed
                   6485:          between your installed version and the new one.  For this
                   6486:          reason, this target is not officially supported and only
                   6487:          recommended for advanced users.</p>
                   6488: </dd>
1.75      rillig   6489: <dt><span class="term">info</span></dt>
1.189     snj      6490: <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      6491:          package. You can use this to check which version of a
                   6492:          package is installed.</p></dd>
                   6493: <dt><span class="term">index</span></dt>
                   6494: <dd>
                   6495: <p>This is a top-level command, i.e. it should be used in
                   6496:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   6497:          database of all packages in the local pkgsrc tree, including
                   6498:          dependencies, comment, maintainer, and some other useful
                   6499:          information.  Individual entries are created by running
1.110     hubertf  6500:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      6501:          directories.  This index file is saved as
                   6502:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  6503:          verbose format by running <span class="command"><strong>make
1.88      wiz      6504:          print-index</strong></span>.  You can search in it with
1.110     hubertf  6505:          <span class="command"><strong>make search
1.88      wiz      6506:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   6507:          extract a list of all packages that depend on a particular
1.110     hubertf  6508:          one by running <span class="command"><strong>make show-deps
1.88      wiz      6509:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   6510: <p>Running this command takes a very long time, some
                   6511:          hours even on fast machines!</p>
                   6512: </dd>
1.75      rillig   6513: <dt><span class="term">readme</span></dt>
1.88      wiz      6514: <dd>
                   6515: <p>This target generates a
                   6516:          <code class="filename">README.html</code> file, which can be
1.189     snj      6517:          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      6518:          contain references to any packages which are in the
                   6519:          <code class="varname">PACKAGES</code> directory on the local
                   6520:          host. The generated files can be made to refer to URLs
                   6521:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   6522:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   6523:          wanted to generate <code class="filename">README.html</code>
                   6524:          files which pointed to binary packages on the local
                   6525:          machine, in the directory
                   6526:          <code class="filename">/usr/packages</code>, set
                   6527:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   6528:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   6529:          <code class="varname">${PACKAGES}</code> directory and its
                   6530:          subdirectories will be searched for all the binary
                   6531:          packages.</p>
                   6532: <p>The target can be run at the toplevel or in category
                   6533:          directories, in which case it descends recursively.</p>
                   6534: </dd>
1.75      rillig   6535: <dt><span class="term">readme-all</span></dt>
1.88      wiz      6536: <dd><p>This is a top-level command, run it in
                   6537:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   6538:          file <code class="filename">README-all.html</code> which contains a
                   6539:          list of all packages currently available in the NetBSD
                   6540:          Packages Collection, together with the category they belong
                   6541:          to and a short description. This file is compiled from the
                   6542:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  6543:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      6544:          readme</strong></span>.</p></dd>
1.75      rillig   6545: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      6546: <dd><p>This is very much the same as the
1.128     wiz      6547:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.88      wiz      6548:          used when generating a pkgsrc tree to be written to a
                   6549:          CD-ROM.  This target also produces
                   6550:          <code class="filename">README.html</code> files, and can be made
                   6551:          to refer to URLs based on
                   6552:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      6553:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   6554: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      6555: <dd><p>This target shows which distfiles and patchfiles
                   6556:          are needed to build the package
                   6557:          (<code class="varname">ALLFILES</code>, which contains all
                   6558:          <code class="varname">DISTFILES</code> and
1.87      wiz      6559:          <code class="varname">PATCHFILES</code>, but not
                   6560:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   6561: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      6562: <dd><p>This target shows nothing if the package is not
                   6563:          installed. If a version of this package is installed,
                   6564:          but is not the version provided in this version of
                   6565:          pkgsrc, then a warning message is displayed. This target
                   6566:          can be used to show which of your installed packages are
                   6567:          downlevel, and so the old versions can be deleted, and
                   6568:          the current ones added.</p></dd>
1.75      rillig   6569: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      6570: <dd><p>This target shows the directory in the pkgsrc
                   6571:          hierarchy from which the package can be built and
                   6572:          installed. This may not be the same directory as the one
                   6573:          from which the package was installed. This target is
                   6574:          intended to be used by people who may wish to upgrade
                   6575:          many packages on a single host, and can be invoked from
                   6576:          the top-level pkgsrc Makefile by using the
1.128     wiz      6577:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.75      rillig   6578: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      6579: <dd><p>This target shows which installed packages match
                   6580:          the current package's <code class="varname">DEPENDS</code>. Useful
                   6581:          if out of date dependencies are causing build
                   6582:          problems.</p></dd>
1.205     wiz      6583: <dt><span class="term">print-build-depends-list</span></dt>
                   6584: <dd><p>This target shows the list of packages that the current package
                   6585:            depends on for building.</p></dd>
                   6586: <dt><span class="term">print-run-depends-list</span></dt>
                   6587: <dd><p>This target shows the list of packages that the current package
                   6588:            depends on for running.</p></dd>
1.75      rillig   6589: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      6590: <dd><p>After a package is installed, check all its
                   6591:          binaries and (on ELF platforms) shared libraries to see
                   6592:          if they find the shared libs they need.  Run by default
1.110     hubertf  6593:          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   6594: <dt><span class="term">print-PLIST</span></dt>
                   6595: <dd>
1.128     wiz      6596: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.88      wiz      6597:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  6598:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      6599:          -newer work/.extract_done</strong></span>.  An attempt is made
                   6600:          to care for shared libs etc., but it is
1.87      wiz      6601:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   6602:          result before putting it into
                   6603:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   6604:          diff the output of this command against an already
                   6605:          existing <code class="filename">PLIST</code> file.</p>
1.189     snj      6606: <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      6607:          other methods that don't update file access times, be
                   6608:          sure to add these files manually to your
1.128     wiz      6609:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   6610:          -newer</span>&#8221;</span> command used by this target won't catch
1.87      wiz      6611:          them!</p>
1.128     wiz      6612: <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      6613:          information on this target.</p>
1.75      rillig   6614: </dd>
                   6615: <dt><span class="term">bulk-package</span></dt>
                   6616: <dd>
1.88      wiz      6617: <p>Used to do bulk builds. If an appropriate binary
                   6618:          package already exists, no action is taken. If not, this
                   6619:          target will compile, install and package it (and its
                   6620:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174     asau     6621:          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
                   6622: builds)</i></a>).
1.88      wiz      6623:          After creating the binary package, the sources, the
                   6624:          just-installed package and its required packages are
                   6625:          removed, preserving free disk space.</p>
                   6626: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6627:          all packages installed on a system!</em></span></p>
1.75      rillig   6628: </dd>
                   6629: <dt><span class="term">bulk-install</span></dt>
                   6630: <dd>
1.88      wiz      6631: <p>Used during bulk-installs to install required
                   6632:          packages. If an up-to-date binary package is available,
1.189     snj      6633:          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  6634:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      6635:          but the installed binary won't be removed.</p>
1.88      wiz      6636: <p>A binary package is considered
1.128     wiz      6637:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.189     snj      6638:          <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     6639: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6640: <li class="listitem"><p>None of the package's files
1.88      wiz      6641:              (<code class="filename">Makefile</code>, ...) were modified
                   6642:              since it was built.</p></li>
1.128     wiz      6643: <li class="listitem"><p>None of the package's required (binary)
1.88      wiz      6644:              packages were modified since it was built.</p></li>
1.75      rillig   6645: </ul></div>
1.88      wiz      6646: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6647:          all packages installed on a system!</em></span></p>
1.75      rillig   6648: </dd>
                   6649: </dl></div>
                   6650: </div>
                   6651: </div>
1.148     asau     6652: <div class="chapter">
1.75      rillig   6653: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6654: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   6655: <div class="toc">
                   6656: <p><b>Table of Contents</b></p>
1.210     leot     6657: <dl class="toc">
1.106     rillig   6658: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   6659: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   6660: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.75      rillig   6661: </dl>
                   6662: </div>
1.87      wiz      6663: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   6664: by pkgsrc and also for individual packages to define what commands
                   6665: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   6666: or for later run-time of an installed packaged (such as
                   6667: <code class="varname">DEPENDS</code>).
                   6668: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      6669: package will not be used.</p>
                   6670: <p>When building a package, the replacement tools are
1.75      rillig   6671: made available in a directory (as symlinks or wrapper scripts)
                   6672: that is early in the executable search path. Just like the buildlink
1.87      wiz      6673: system, this helps with consistent builds.</p>
                   6674: <p>A tool may be needed to help build a specific package. For example,
                   6675: perl, GNU make (gmake) or yacc may be needed.</p>
                   6676: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   6677: tool may be inefficient for building a package with pkgsrc.
                   6678: For example, a package may need GNU awk, bison (instead of
1.87      wiz      6679: yacc) or a better sed.</p>
                   6680: <p>The tools used by a package can be listed by running
1.110     hubertf  6681: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6682: <div class="sect1">
1.75      rillig   6683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6684: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      6685: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   6686: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  6687: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6688: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   6689: These can be seen by running:
1.110     hubertf  6690: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      6691: <p>If a package needs a specific program to build
1.75      rillig   6692: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      6693: to define the tools needed.</p>
1.75      rillig   6694: </div>
1.148     asau     6695: <div class="sect1">
1.75      rillig   6696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6697: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135     wiz      6698: <p>In the following examples, the :run means that it is needed at
                   6699: run-time (and becomes a DEPENDS).
1.75      rillig   6700: The default is a build dependency which can be set with
                   6701: :build. (So in this example, it is the same as gmake:build
1.87      wiz      6702: and pkg-config:build.)</p>
1.75      rillig   6703: <pre class="programlisting">
                   6704: USE_TOOLS+=     gmake perl:run pkg-config
                   6705: </pre>
1.87      wiz      6706: <p>When using the tools framework, a
1.75      rillig   6707: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6708: which contains the full path to the appropriate tool. For example,
1.128     wiz      6709: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.87      wiz      6710: on Linux systems.</p>
                   6711: <p>If you always need a pkgsrc version of the
1.75      rillig   6712: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6713: </p>
                   6714: </div>
1.148     asau     6715: <div class="sect1">
1.75      rillig   6716: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6717: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      6718: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   6719: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   6720: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   6721: the name of the common tools. For example:</p>
                   6722: <pre class="programlisting">
                   6723: .if exists(/usr/bin/bzcat)
                   6724: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6725: .elif exists(/usr/bin/bzip2)
                   6726: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6727: .endif
1.69      rillig   6728: 
1.75      rillig   6729: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   6730: </pre>
                   6731: </div>
                   6732: </div>
1.148     asau     6733: <div class="chapter">
1.75      rillig   6734: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6735: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   6736: <div class="toc">
                   6737: <p><b>Table of Contents</b></p>
1.210     leot     6738: <dl class="toc">
1.106     rillig   6739: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   6740: <dd><dl>
1.218     rillig   6741: <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>
                   6742: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                   6743: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                   6744: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                   6745: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                   6746: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                   6747: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                   6748: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   6749: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                   6750: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   6751: <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   6752: </dl></dd>
1.218     rillig   6753: <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   6754: <dd><dl>
                   6755: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   6756: <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      6757: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig   6758: </dl></dd>
1.218     rillig   6759: <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   6760: <dd><dl>
                   6761: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   6762: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   6763: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   6764: </dl></dd>
                   6765: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   6766: <dd><dl>
                   6767: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   6768: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   6769: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      6770: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   6771: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   6772: </dl></dd>
1.218     rillig   6773: <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   6774: <dd><dl>
                   6775: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   6776: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      6777: <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   6778: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   6779: </dl></dd>
1.218     rillig   6780: <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   6781: <dd><dl>
                   6782: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   6783: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   6784: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   6785: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   6786: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   6787: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   6788: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   6789: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   6790: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   6791: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   6792: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   6793: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   6794: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   6795: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   6796: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   6797: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   6798: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   6799: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      6800:     emulation</a></span></dt>
1.106     rillig   6801: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   6802: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   6803: </dl></dd>
1.106     rillig   6804: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   6805: </dl>
                   6806: </div>
1.148     asau     6807: <div class="sect1">
1.75      rillig   6808: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6809: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.78      rillig   6810: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   6811:   different platforms. As a result, it is important to ensure,
                   6812:   where possible, that packages in pkgsrc are portable. This
                   6813:   chapter mentions some particular details you should pay
                   6814:   attention to while working on pkgsrc.</p>
1.148     asau     6815: <div class="sect2">
1.78      rillig   6816: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6817: <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   6818: </h3></div></div></div>
1.78      rillig   6819: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      6820:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  6821:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      6822:     want to use those variables in the preprocessor directives of
1.189     snj      6823:     <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      6824:     <code class="literal">.for</code>), you need to include the file
                   6825:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   6826:     loads the user preferences.</p>
1.78      rillig   6827: <p>But note that some variables may not be completely defined
1.219     rillig   6828:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   6829:     included, as they may contain references to variables that are
                   6830:     not yet defined. In shell commands (the lines in
                   6831:     <code class="filename">Makefile</code> that are indented with a tab) this
                   6832:     is no problem, since variables are only expanded when they are
                   6833:     used. But in the preprocessor directives mentioned above and in
                   6834:     dependency lines (of the form <code class="literal">target:
                   6835:     dependencies</code>) the variables are expanded at load
                   6836:     time.</p>
1.148     asau     6837: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   6838: <h3 class="title">Note</h3>
1.218     rillig   6839: <p>To check whether a variable can be used at load time,
                   6840:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   6841: </div>
                   6842: </div>
1.148     asau     6843: <div class="sect2">
1.78      rillig   6844: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6845: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.88      wiz      6846: <p>Occasionally, packages require interaction from the user,
                   6847:     and this can be in a number of ways:</p>
1.148     asau     6848: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6849: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      6850:        interaction such as entering username/password or accepting a
                   6851:        license on a web page.</p></li>
1.128     wiz      6852: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      6853:        passwords.</p></li>
1.128     wiz      6854: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   6855: <li class="listitem"><p>help during the build process</p></li>
                   6856: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   6857: </ul></div>
1.218     rillig   6858: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   6859:     variable to define which stages need interaction. This should be
                   6860:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   6861: <pre class="programlisting">
1.100     rillig   6862: INTERACTIVE_STAGE=      configure install
1.222     sevan    6863: </pre>
1.88      wiz      6864: <p>The user can then decide to skip this package by setting the
1.218     rillig   6865:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   6866:     are also excluded from bulk builds.</p>
1.75      rillig   6867: </div>
1.148     asau     6868: <div class="sect2">
1.75      rillig   6869: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6870: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    6871: <p>Authors of software can choose the licence under which software
                   6872:     can be copied.  The Free Software Foundation has declared some
                   6873:     licenses "Free", and the Open Source Initiative has a definition of
                   6874:     "Open Source".</p>
                   6875: <p>By default, pkgsrc allows packages with Free or Open Source
                   6876:     licenses to be built.  To allow packages with other licenses to be
                   6877:     built as well, the pkgsrc user needs to add these licenses to the
                   6878:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   6879:     that this variable only affects which packages may be
                   6880:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   6881:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      6882: <p>One might want to only install packages with a BSD license,
1.218     rillig   6883:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    6884:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  6885:     user can override the default by setting the
                   6886:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    6887:     of "+=".  The licenses accepted by default are defined in the
                   6888:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   6889:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   6890: <p>The license tag mechanism is intended to address
1.87      wiz      6891:     copyright-related issues surrounding building, installing and
                   6892:     using a package, and not to address redistribution issues (see
                   6893:     <code class="varname">RESTRICTED</code> and
1.222     sevan    6894:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  6895:     Packages with redistribution restrictions should set these
                   6896:     tags.</p>
1.98      wiz      6897: <p>Denoting that a package may be copied according to a
                   6898:     particular license is done by placing the license in
1.87      wiz      6899:     <code class="filename">pkgsrc/licenses</code> and setting the
                   6900:     <code class="varname">LICENSE</code> variable to a string identifying the
1.189     snj      6901:     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      6902: <pre class="programlisting">
1.100     rillig   6903: LICENSE=        xv-license
1.222     sevan    6904: </pre>
1.87      wiz      6905: <p>When trying to build, the user will get a notice that the
1.98      wiz      6906:     package is covered by a license which has not been placed in the
                   6907:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      6908: <pre class="programlisting">
1.100     rillig   6909: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   6910: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   6911: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   6912: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   6913: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   6914: *** Error code 1
1.222     sevan    6915: </pre>
1.110     hubertf  6916: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      6917:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  6918:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      6919:     convey to pkgsrc that it should not in the future fail because of
                   6920:     that license:</p>
1.78      rillig   6921: <pre class="programlisting">
1.100     rillig   6922: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    6923: </pre>
                   6924: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   6925:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   6926:     is deprecated because it does not crisply refer to a particular
                   6927:     license text.  Another problem with such usage is that it does not
                   6928:     enable a user to tell pkgsrc to proceed for a single package
                   6929:     without also telling pkgsrc to proceed for all packages with that
                   6930:     tag.</p>
                   6931: <div class="sect3">
                   6932: <div class="titlepage"><div><div><h4 class="title">
                   6933: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   6934: <p>When adding a package with a new license, the following steps
                   6935:     are required:</p>
                   6936: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6937: <li class="listitem">
1.222     sevan    6938: <p>Check whether the license qualifies as Free or Open
                   6939:     Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
                   6940:     and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
                   6941:     Open Source Initiative</a>.  If this is the case, the filename in
                   6942:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   6943:     <code class="filename">-license</code> suffix, and the license name should be
                   6944:     added to:</p>
1.154     rodent   6945: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6946: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   6947: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
                   6948: </ul></div>
                   6949: </li>
                   6950: <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>
                   6951: </ol></div>
1.222     sevan    6952: </div>
                   6953: <div class="sect3">
                   6954: <div class="titlepage"><div><div><h4 class="title">
                   6955: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      6956: <p>When the license changes (in a way other than formatting),
1.222     sevan    6957:     make sure that the new license has a different name (e.g.,
1.98      wiz      6958:     append the version number if it exists, or the date).  Just
                   6959:     because a user told pkgsrc to build programs under a previous
                   6960:     version of a license does not mean that pkgsrc should build
1.99      rillig   6961:     programs under the new licenses.  The higher-level point is that
1.98      wiz      6962:     pkgsrc does not evaluate licenses for reasonableness; the only
                   6963:     test is a mechanistic test of whether a particular text has been
1.222     sevan    6964:     approved by either of two bodies (FSF or OSI).</p>
                   6965: </div>
1.75      rillig   6966: </div>
1.148     asau     6967: <div class="sect2">
1.75      rillig   6968: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6969: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   6970: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    6971:     By declaring the restrictions, package tools can
1.98      wiz      6972:     automatically refrain from e.g. placing binary packages on FTP
                   6973:     sites.</p>
1.222     sevan    6974: <p>There are four possible restrictions, which are
1.98      wiz      6975:     the cross product of sources (distfiles) and binaries not being
                   6976:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   6977:     language in any license, and because non-Free licenses tend to be
                   6978:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    6979:     CD-ROM.
                   6980: 
                   6981:     "FTP" means making the source or binary file available over the
                   6982:     Internet at no charge.
                   6983: 
                   6984:     "CD-ROM" means making the source or binary available on some kind of
                   6985:     media, together with other source and binary packages, which is sold
                   6986:     for a distribution charge.
1.98      wiz      6987:     </p>
                   6988: <p>In order to encode these restrictions, the package system
1.87      wiz      6989:     defines five make variables that can be set to note these
                   6990:     restrictions:</p>
1.148     asau     6991: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6992: <li class="listitem">
1.75      rillig   6993: <p><code class="varname">RESTRICTED</code></p>
                   6994: <p>This variable should be set whenever a restriction
1.87      wiz      6995:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      6996:        string containing the reason for the restriction.  It should
                   6997:        be understood that those wanting to understand the restriction
                   6998:        will have to read the license, and perhaps seek advice of
                   6999:        counsel.</p>
1.75      rillig   7000: </li>
1.128     wiz      7001: <li class="listitem">
1.75      rillig   7002: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7003: <p>Binaries may not be placed on CD-ROM containing other
                   7004:        binary packages, for which a distribution charge may be made.
                   7005:        In this case, set this variable to
                   7006:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7007: </li>
1.128     wiz      7008: <li class="listitem">
1.75      rillig   7009: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7010: <p>Binaries may not made available on the Internet without
                   7011:        charge.  In this case, set this variable to
                   7012:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7013:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7014: </li>
1.128     wiz      7015: <li class="listitem">
1.75      rillig   7016: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7017: <p>Distfiles may not be placed on CD-ROM, together with
                   7018:        other distfiles, for which a fee may be charged.  In this
                   7019:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7020:        </p>
1.75      rillig   7021: </li>
1.128     wiz      7022: <li class="listitem">
1.75      rillig   7023: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7024: <p>Distfiles may not made available via FTP at no charge.
                   7025:        In this case, set this variable to
                   7026:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7027:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7028: </li>
                   7029: </ul></div>
1.222     sevan    7030: <p>Please note that packages will be removed from pkgsrc when the
                   7031:     distfiles are not distributable and cannot be obtained for a period
                   7032:     of one full quarter branch. Packages with manual/interactive fetch
                   7033:     must have a maintainer and it is his/her responsibility to ensure
                   7034:     this.</p>
1.75      rillig   7035: </div>
1.148     asau     7036: <div class="sect2">
1.75      rillig   7037: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7038: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.75      rillig   7039: <p>Your package may depend on some other package being present
1.88      wiz      7040:     - and there are various ways of expressing this dependency.
                   7041:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7042:     <code class="varname">DEPENDS</code> definitions, the
                   7043:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7044:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7045:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  7046:     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   7047: <p>The basic difference between the two variables is as
1.87      wiz      7048:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7049:     that pre-requisite in the binary package so it will be pulled in
                   7050:     when the binary package is later installed, whilst the
                   7051:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7052:     dependency that is only needed for building the package.</p>
1.75      rillig   7053: <p>This means that if you only need a package present whilst
1.87      wiz      7054:     you are building, it should be noted as a
                   7055:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7056: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7057:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7058: <pre class="programlisting">
1.100     rillig   7059: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7060: </pre>
1.128     wiz      7061: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7062:     may include any of the wildcard version numbers recognized by
1.189     snj      7063:     <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      7064: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7065: <li class="listitem">
1.75      rillig   7066: <p>If your package needs another package's binaries or
1.160     wiz      7067:        libraries to build and run, and if that package has a
1.87      wiz      7068:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7069: <pre class="programlisting">
1.100     rillig   7070: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7071: </pre>
1.75      rillig   7072: </li>
1.128     wiz      7073: <li class="listitem">
1.160     wiz      7074: <p>If your package needs another package's binaries or
                   7075:        libraries only for building, and if that package has a
                   7076:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7077: <pre class="programlisting">
                   7078: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7079: </pre>
1.160     wiz      7080: <p>but set
                   7081:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7082:        to make it a build dependency only. This case is rather
                   7083:        rare.</p>
                   7084: </li>
                   7085: <li class="listitem">
1.132     spz      7086: <p>If your package needs binaries from another package to build,
                   7087:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75      rillig   7088: <pre class="programlisting">
1.132     spz      7089: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.222     sevan    7090: </pre>
1.75      rillig   7091: </li>
1.132     spz      7092: <li class="listitem"><p>If your package needs a library with which to link and
                   7093:        there is no <code class="filename">buildlink3.mk</code> file
                   7094:        available, create one. Using
                   7095:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7096:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7097: <li class="listitem">
1.132     spz      7098: <p>If your package needs some executable to be able to run
                   7099:        correctly and if there's no
                   7100:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7101:        using the <code class="varname">DEPENDS</code> variable. The
1.189     snj      7102:        <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      7103:        be able to execute the latex binary from the teTeX package
                   7104:        when it runs, and that is specified:</p>
1.75      rillig   7105: <pre class="programlisting">
1.132     spz      7106: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.222     sevan    7107: </pre>
1.132     spz      7108: </li>
                   7109: <li class="listitem">
                   7110: <p>You can use wildcards in package dependencies. Note that
                   7111:        such wildcard dependencies are retained when creating binary
                   7112:        packages. The dependency is checked when installing the binary
                   7113:        package and any package which matches the pattern will be
                   7114:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7115: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7116:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7117:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7118:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7119: <p>Wildcards can also be used to specify that a package
1.87      wiz      7120:        will only build against a certain minimum version of a
                   7121:        pre-requisite:</p>
1.75      rillig   7122: <pre class="programlisting">
1.132     spz      7123: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7124: </pre>
1.132     spz      7125: <p>This means that the package will build using version 6.0
                   7126:        of ImageMagick or newer. Such a dependency may be warranted
                   7127:        if, for example, the command line options of an executable
                   7128:        have changed.</p>
                   7129: <p>If you need to depend on minimum versions of libraries,
                   7130:        see the buildlink section of the pkgsrc guide.</p>
1.75      rillig   7131: <p>For security fixes, please update the package
1.218     rillig   7132:        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      7133:        information.</p>
1.75      rillig   7134: </li>
                   7135: </ol></div>
                   7136: <p>If your package needs files from another package to build,
1.87      wiz      7137:     add the relevant distribution files to
                   7138:     <code class="varname">DISTFILES</code>, so they will be extracted
1.189     snj      7139:     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      7140:     (It relies on the jpeg sources being present in source form
                   7141:     during the build.)</p>
1.75      rillig   7142: </div>
1.148     asau     7143: <div class="sect2">
1.75      rillig   7144: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7145: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7146: <p>Your package may conflict with other packages a user might
1.87      wiz      7147:     already have installed on his system, e.g. if your package
1.88      wiz      7148:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7149:     tree or has the same <code class="varname">PKGNAME</code>.</p>
                   7150: <p>These cases are handled automatically by the packaging tools
                   7151:     at package installation time and do not need to be handled
                   7152:     manually.</p>
                   7153: <p>In case the conflicts can not be recognized automatically
                   7154:     (e.g., packages using the same config file location but no other
                   7155:     shared files), you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      7156:     space-separated list of packages (including version string) your
                   7157:     package conflicts with.</p>
1.190     wiz      7158: <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>
                   7159:     and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
                   7160:     use the same config file, you would set in
                   7161:     <code class="filename">foo/bar/Makefile</code>:</p>
1.87      wiz      7162: <pre class="programlisting">
1.190     wiz      7163: CONFLICTS=      baz-[0-9]*
1.222     sevan    7164: </pre>
1.190     wiz      7165: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.75      rillig   7166: <pre class="programlisting">
1.190     wiz      7167: CONFLICTS=      bar-[0-9]*
1.222     sevan    7168: </pre>
1.75      rillig   7169: </div>
1.148     asau     7170: <div class="sect2">
1.75      rillig   7171: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7172: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7173: <p>There are several reasons why a package might be
1.88      wiz      7174:     instructed to not build under certain circumstances.  If the
1.87      wiz      7175:     package builds and runs on most platforms, the exceptions
1.193     dholland 7176:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7177:     the package builds and runs on a small handful of platforms,
                   7178:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7179:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7180:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7181:     (OS-version-platform) that can use glob-style
                   7182:     wildcards.</p>
                   7183: <p>If a package is not appropriate for some platforms (as
1.225     maya     7184:     opposed to merely broken), a different set of variables should be
1.193     dholland 7185:     used as this affects failure reporting and statistics.
                   7186:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7187:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7188:     the package is appropriate for only a small handful of platforms
                   7189:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7190:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7191:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7192:     (OS-version-platform) that can use glob-style
                   7193:     wildcards.</p>
1.88      wiz      7194: <p>Some packages are tightly bound to a specific version of an
1.189     snj      7195:     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      7196:     backwards compatible with other versions of the OS, and should be
                   7197:     uploaded to a version specific directory on the FTP server.  Mark
                   7198:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7199:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7200:     the package system internals, but may be used in the
                   7201:     future.</p>
1.75      rillig   7202: <p>If the package should be skipped (for example, because it
1.87      wiz      7203:     provides functionality already provided by the system), set
1.88      wiz      7204:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7205:     the package should fail because some preconditions are not met,
                   7206:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7207:     message.</p>
1.75      rillig   7208: </div>
1.148     asau     7209: <div class="sect2">
1.75      rillig   7210: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7211: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7212: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7213:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7214:     be set in the package Makefile. This will be carried into any
                   7215:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7216:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.189     snj      7217:     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      7218:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7219: </div>
1.148     asau     7220: <div class="sect2">
1.75      rillig   7221: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7222: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7223: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7224:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      7225:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7226:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7227: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7228:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7229:     course not necessary if the problem is fixed by using a newer
                   7230:     release of the software), and the pattern in the
                   7231:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7232: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7233:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7234: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7235:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7236: </div>
1.148     asau     7237: <div class="sect2">
1.75      rillig   7238: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7239: <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   7240: <p>When making fixes to an existing package it can be useful
1.87      wiz      7241:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7242:     avoid conflicting with future versions by the original author, a
1.128     wiz      7243:     <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      7244:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7245:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7246:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7247: <pre class="programlisting">
1.100     rillig   7248: DISTNAME=       foo-17.42
                   7249: PKGREVISION=    9
1.222     sevan    7250: </pre>
1.75      rillig   7251: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7252:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7253:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7254:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7255:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7256: <p>When a new release of the package is released, the
1.87      wiz      7257:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7258:     minor release of the above package, things should be like:</p>
1.75      rillig   7259: <pre class="programlisting">
1.100     rillig   7260: DISTNAME=       foo-17.43
1.222     sevan    7261: </pre>
1.87      wiz      7262: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7263:     non-trivial change in the resulting binary package.  Without a
                   7264:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7265:     version installed has no way of knowing that their package is out
                   7266:     of date.  Thus, changes without increasing
                   7267:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7268:     trivial that no reasonable person would want to upgrade", and this
                   7269:     is the rough test for when increasing
                   7270:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7271:     changes that do not merit increasing
                   7272:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7273: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7274: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114     jmcneill 7275:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   7276:       or comments in Makefile.</p></li>
1.128     wiz      7277: <li class="listitem"><p>
1.100     rillig   7278:       Changing build variables if the resulting binary package is the same.</p></li>
1.128     wiz      7279: <li class="listitem"><p>
1.100     rillig   7280:       Changing <code class="filename">DESCR</code>.</p></li>
1.128     wiz      7281: <li class="listitem"><p>
1.100     rillig   7282:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   7283: </ul></div>
1.87      wiz      7284: <p>Examples of changes that do merit an increase to
                   7285:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7286: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7287: <li class="listitem"><p>
1.100     rillig   7288:       Security fixes</p></li>
1.128     wiz      7289: <li class="listitem"><p>
1.100     rillig   7290:       Changes or additions to a patch file</p></li>
1.128     wiz      7291: <li class="listitem"><p>
1.100     rillig   7292:       Changes to the <code class="filename">PLIST</code></p></li>
1.128     wiz      7293: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100     rillig   7294: </ul></div>
1.78      rillig   7295: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7296:     changes.</p>
1.75      rillig   7297: </div>
1.148     asau     7298: <div class="sect2">
1.79      rillig   7299: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7300: <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   7301: <p>When you want to replace the same text in multiple files
1.87      wiz      7302:     or when the replacement text varies, patches alone cannot help.
                   7303:     This is where the SUBST framework comes in. It provides an
                   7304:     easy-to-use interface for replacing text in files.
                   7305:     Example:</p>
                   7306: <pre class="programlisting">
1.100     rillig   7307: SUBST_CLASSES+=                 fix-paths
                   7308: SUBST_STAGE.fix-paths=          pre-configure
                   7309: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   7310: SUBST_FILES.fix-paths=          src/*.c
                   7311: SUBST_FILES.fix-paths+=         scripts/*.sh
                   7312: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   7313: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.222     sevan    7314: </pre>
1.79      rillig   7315: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      7316:     that are used to identify the different SUBST blocks that are
                   7317:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   7318:     important to always use the <code class="literal">+=</code> operator with
                   7319:     this variable. Otherwise some substitutions may be
                   7320:     skipped.</p>
1.79      rillig   7321: <p>The remaining variables of each SUBST block are
1.87      wiz      7322:     parameterized with the identifier from the first line
                   7323:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   7324:     parameters to a function call.</p>
1.79      rillig   7325: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      7326:     which the replacement will take place. All combinations of
                   7327:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   7328:     <code class="literal">post-</code> together with a phase name are
                   7329:     possible, though only few are actually used. Most commonly used
                   7330:     are <code class="literal">post-patch</code> and
                   7331:     <code class="literal">pre-configure</code>. Of these two,
                   7332:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  7333:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      7334:     have the state after applying the patches but before making any
                   7335:     other changes. This is especially useful when you are debugging
                   7336:     a package in order to create new patches for it. Similarly,
                   7337:     <code class="literal">post-build</code> is preferred over
                   7338:     <code class="literal">pre-install</code>, because the install phase should
                   7339:     generally be kept as simple as possible. When you use
                   7340:     <code class="literal">post-build</code>, you have the same files in the
                   7341:     working directory that will be installed later, so you can check
                   7342:     if the substitution has succeeded.</p>
1.79      rillig   7343: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      7344:     that is printed just before the substitution is done.</p>
1.79      rillig   7345: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      7346:     globbing patterns that specifies the files in which the
                   7347:     substitution will take place. The patterns are interpreted
                   7348:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   7349: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.189     snj      7350:     <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      7351:     command should be prefixed with <code class="literal">-e</code>, so that
                   7352:     all SUBST blocks look uniform.</p>
1.79      rillig   7353: <p>There are some more variables, but they are so seldomly
1.87      wiz      7354:     used that they are only documented in the
                   7355:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   7356: </div>
1.75      rillig   7357: </div>
1.148     asau     7358: <div class="sect1">
1.75      rillig   7359: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7360: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     7361: <div class="sect2">
1.75      rillig   7362: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7363: <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   7364: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  7365:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      7366:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   7367:     with the name of each file to download as an argument, expecting
                   7368:     it to output the URL of the directory from which to download
1.189     snj      7369:     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      7370:     example of this usage.</p>
1.75      rillig   7371: <p>If the download can't be automated, because the user must
1.87      wiz      7372:     submit personal information to apply for a password, or must pay
                   7373:     for the source, or whatever, you can set
                   7374:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   7375:     displayed to the user before aborting the build. Example:</p>
                   7376: <pre class="programlisting">
1.100     rillig   7377: FETCH_MESSAGE=  "Please download the files"
                   7378: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   7379: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    7380: </pre>
1.75      rillig   7381: </div>
1.148     asau     7382: <div class="sect2">
1.75      rillig   7383: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7384: <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   7385: <p>Sometimes authors of a software package make some
1.87      wiz      7386:     modifications after the software was released, and they put up a
                   7387:     new distfile without changing the package's version number. If a
                   7388:     package is already in pkgsrc at that time, the checksum will
                   7389:     no longer match. The contents of the new distfile should be
                   7390:     compared against the old one before changing anything, to make
                   7391:     sure the distfile was really updated on purpose, and that
                   7392:     no trojan horse or so crept in.
1.97      rillig   7393:     Please mention that the distfiles were compared and what was found
1.159     rodent   7394:     in your commit message.</p>
1.220     wiz      7395: <p>Then, the correct way to work around this is to set
                   7396:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   7397:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   7398:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   7399:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   7400:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.220     wiz      7401:     subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="19.1.10. How to handle incrementing versions when fixing an existing package">Section 19.1.10, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.) In case this
1.87      wiz      7402:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      7403:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   7404:     be appended, like
                   7405:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.159     rodent   7406: <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>
                   7407: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      7408:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   7409:     path in the filenames.
1.159     rodent   7410:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      7411:     Furthermore, a mail to the package's authors seems appropriate
                   7412:     telling them that changing distfiles after releases without
                   7413:     changing the file names is not good practice.</p>
1.75      rillig   7414: </div>
1.199     tnn      7415: <div class="sect2">
                   7416: <div class="titlepage"><div><div><h3 class="title">
                   7417: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.200     tnn      7418: <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:
                   7419:     </p>
1.199     tnn      7420: <div class="sect3">
                   7421: <div class="titlepage"><div><div><h4 class="title">
                   7422: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
                   7423: <p>
                   7424:         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.
                   7425:       </p>
                   7426: <pre class="programlisting">
                   7427: DISTNAME=       exampleproject-1.0
1.200     tnn      7428: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7429: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7430: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      7431: EXTRACT_SUFX=   .zip
                   7432: </pre>
                   7433: </div>
                   7434: <div class="sect3">
                   7435: <div class="titlepage"><div><div><h4 class="title">
                   7436: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
                   7437: <p>
                   7438:         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.
                   7439:       </p>
                   7440: <pre class="programlisting">
                   7441: DISTNAME=       example-1.0
1.217     jnemeth  7442: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.200     tnn      7443: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7444: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    7445: </pre>
1.199     tnn      7446: </div>
                   7447: <div class="sect3">
                   7448: <div class="titlepage"><div><div><h4 class="title">
                   7449: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
                   7450: <p>
                   7451:         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.
                   7452:       </p>
                   7453: <pre class="programlisting">
                   7454: DISTNAME=       offensive-1.6
1.200     tnn      7455: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   7456: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7457: GITHUB_PROJECT= exampleproject
                   7458: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   7459: EXTRACT_SUFX=   .zip
1.222     sevan    7460: </pre>
1.199     tnn      7461: </div>
                   7462: </div>
1.75      rillig   7463: </div>
1.148     asau     7464: <div class="sect1">
1.75      rillig   7465: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7466: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     7467: <div class="sect2">
1.75      rillig   7468: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7469: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   7470: <p>pkgsrc supports many different machines, with different
1.87      wiz      7471:     object formats like a.out and ELF, and varying abilities to do
                   7472:     shared library and dynamic loading at all. To accompany this,
                   7473:     varying commands and options have to be passed to the
                   7474:     compiler, linker, etc. to get the Right Thing, which can be
                   7475:     pretty annoying especially if you don't have all the machines
                   7476:     at your hand to test things.  The
1.189     snj      7477:     <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      7478:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      7479:     both static and dynamic libraries from a set of source files,
                   7480:     thus being platform-independent.</p>
                   7481: <p>Here's how to use libtool in a package in seven simple
                   7482:     steps:</p>
1.128     wiz      7483: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7484: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      7485:        Makefile.</p></li>
1.128     wiz      7486: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   7487:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      7488:        add it to the definition of <code class="varname">CC</code>, if only
                   7489:        libraries are being built in a given Makefile. This one command
                   7490:        will build both PIC and non-PIC library objects, so you need not
                   7491:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      7492: <li class="listitem">
1.75      rillig   7493: <p>For the linking of the library, remove any
1.128     wiz      7494:        <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
                   7495:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   7496: <pre class="programlisting">
1.100     rillig   7497: ${LIBTOOL} --mode=link \
                   7498:     ${CC} -o ${.TARGET:.a=.la} \
                   7499:         ${OBJS:.o=.lo} \
                   7500:         -rpath ${PREFIX}/lib \
                   7501:         -version-info major:minor
1.222     sevan    7502: </pre>
1.75      rillig   7503: <p>Note that the library is changed to have a
1.87      wiz      7504:        <code class="filename">.la</code> extension, and the objects are
                   7505:        changed to have a <code class="filename">.lo</code>
                   7506:        extension. Change <code class="varname">OBJS</code> as
                   7507:        necessary. This automatically creates all of the
                   7508:        <code class="filename">.a</code>,
                   7509:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   7510:        necessary) in the build directory. Be sure to include
1.128     wiz      7511:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      7512:        minor are zero, as libtool will otherwise strip off the
                   7513:        shared library version.</p>
1.75      rillig   7514: <p>From the libtool manual:</p>
                   7515: <pre class="programlisting">
1.100     rillig   7516: So, libtool library versions are described by three integers:
1.69      rillig   7517: 
1.100     rillig   7518: CURRENT
                   7519: The most recent interface number that this library implements.
1.69      rillig   7520: 
1.100     rillig   7521: REVISION
                   7522: The implementation number of the CURRENT interface.
1.69      rillig   7523: 
1.100     rillig   7524: AGE
                   7525: The difference between the newest and oldest interfaces that
                   7526: this library implements.  In other words, the library implements
                   7527: all the interface numbers in the range from number `CURRENT -
                   7528: AGE' to `CURRENT'.
1.1       grant    7529: 
1.100     rillig   7530: If two libraries have identical CURRENT and AGE numbers, then the
                   7531: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    7532: </pre>
1.128     wiz      7533: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      7534:        different results for a.out and ELF (excluding symlinks)
                   7535:        in only one case. An ELF library of the form
1.128     wiz      7536:        <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      7537:        will have a symlink of
1.128     wiz      7538:        <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      7539:        on an a.out platform. This is handled
                   7540:        automatically.</p>
1.128     wiz      7541: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      7542:        directory of the library being built.</p>
1.76      rillig   7543: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      7544:        <code class="filename">.la</code> file, the other files will be
                   7545:        added automatically.</p>
1.75      rillig   7546: </li>
1.128     wiz      7547: <li class="listitem">
1.76      rillig   7548: <p>When linking shared object (<code class="filename">.so</code>)
1.189     snj      7549:        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      7550:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   7551:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      7552:        tacked on.</p>
1.76      rillig   7553: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      7554:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   7555: </li>
1.128     wiz      7556: <li class="listitem">
1.75      rillig   7557: <p>When linking programs that depend on these libraries
1.87      wiz      7558:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.189     snj      7559:        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      7560:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      7561:        libraries (static or shared), but please be aware that
                   7562:        libtool will not allow you to specify a relative path in
1.128     wiz      7563:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      7564:        expects you to change that argument to be the
                   7565:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   7566: <pre class="programlisting">
1.100     rillig   7567: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    7568: </pre>
1.75      rillig   7569: <p>should be changed to:</p>
                   7570: <pre class="programlisting">
1.100     rillig   7571: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    7572: </pre>
1.75      rillig   7573: <p>and it will do the right thing with the libraries.</p>
                   7574: </li>
1.128     wiz      7575: <li class="listitem">
1.189     snj      7576: <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>
                   7577:        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      7578:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      7579:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   7580: <pre class="programlisting">
1.126     jakllsch 7581: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    7582: </pre>
1.76      rillig   7583: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      7584:        shared library, any needed symlinks, and run
1.189     snj      7585:        <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   7586: </li>
1.128     wiz      7587: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      7588:        the <code class="filename">.la</code>
                   7589:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   7590: </ol></div>
                   7591: </div>
1.148     asau     7592: <div class="sect2">
1.75      rillig   7593: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7594: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   7595: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      7596:     package Makefile. This will override the package's own libtool
                   7597:     in most cases.  For older libtool using packages,  libtool is
                   7598:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  7599:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      7600:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   7601: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      7602:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      7603:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   7604:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      7605:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   7606: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      7607:     libraries built and installed, then use
                   7608:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   7609: <p>If your package makes use of the platform-independent library
1.87      wiz      7610:     for loading dynamic shared objects, that comes with libtool
                   7611:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   7612: <p>Some packages use libtool incorrectly so that the package
                   7613:     may not work or build in some circumstances. Some of the more
                   7614:     common errors are:</p>
1.148     asau     7615: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7616: <li class="listitem">
1.75      rillig   7617: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      7618:        executable or library. This in itself isn't a problem if one of two things
                   7619:        has been done:</p>
1.128     wiz      7620: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7621: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      7622:            <code class="filename">libfoo.la</code>, not
                   7623:            <code class="filename">foo.la</code></p></li>
1.128     wiz      7624: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   7625: </ol></div>
                   7626: </li>
1.128     wiz      7627: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      7628:        The function lt_dlinit() should be called and the macro
                   7629:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   7630:        executables.</p></li>
1.75      rillig   7631: </ul></div>
                   7632: </div>
1.148     asau     7633: <div class="sect2">
1.75      rillig   7634: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7635: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   7636: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      7637:     to regenerate the configure script and Makefile.in makefile
                   7638:     templates, then they should be executed in a pre-configure
                   7639:     target.</p>
1.75      rillig   7640: <p>For packages that need only autoconf:</p>
                   7641: <pre class="programlisting">
1.100     rillig   7642: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   7643: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   7644: ...
1.1       grant    7645: 
1.100     rillig   7646: pre-configure:
                   7647:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    7648: 
1.100     rillig   7649: ...
1.222     sevan    7650: </pre>
1.75      rillig   7651: <p>and for packages that need automake and autoconf:</p>
                   7652: <pre class="programlisting">
1.100     rillig   7653: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   7654: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   7655: ...
                   7656: 
                   7657: pre-configure:
                   7658:         set -e; cd ${WRKSRC}; \
                   7659:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    7660: 
1.100     rillig   7661: ...
1.222     sevan    7662: </pre>
1.75      rillig   7663: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      7664:     require GNU Make.</p>
1.75      rillig   7665: <p>There are times when the configure process makes
1.87      wiz      7666:     additional changes to the generated files, which then causes
                   7667:     the build process to try to re-execute the automake sequence.
                   7668:     This is prevented by touching various files in the configure
                   7669:     stage. If this causes problems with your package you can set
                   7670:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   7671:     Makefile.</p>
1.75      rillig   7672: </div>
                   7673: </div>
1.148     asau     7674: <div class="sect1">
1.75      rillig   7675: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7676: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148     asau     7677: <div class="sect2">
1.87      wiz      7678: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7679: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      7680: <p>Compilers for the C, C++, and Fortran languages comes with
                   7681:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   7682:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  7683:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      7684: <p>To declare which language's compiler a package needs, set
                   7685:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      7686:     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
                   7687:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   7688:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      7689:     written in C++, usually need a C compiler for the configure
                   7690:     phase.</p>
                   7691: </div>
1.148     asau     7692: <div class="sect2">
1.87      wiz      7693: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7694: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      7695: <p>If a program is written in Java, use the Java framework in
                   7696:     pkgsrc.  The package must include
                   7697:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   7698:     provides the following variables:</p>
1.148     asau     7699: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7700: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      7701:       dependency on the JDK is added.  If
1.128     wiz      7702:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      7703:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      7704:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      7705:       JDK.</p></li>
1.128     wiz      7706: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      7707:       a package needs a Java2 implementation.  The supported values
1.128     wiz      7708:       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
                   7709:       <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
                   7710:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   7711:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      7712:       above. This variable is not set by default.</p></li>
1.130     wiz      7713: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   7714:       automatically set to the runtime location of the used Java
                   7715:       implementation dependency. It may be used to set
                   7716:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   7717:       needs this variable to be defined.
                   7718:       </p></li>
1.87      wiz      7719: </ul></div>
                   7720: </div>
1.148     asau     7721: <div class="sect2">
1.87      wiz      7722: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7723: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      7724: <p>If your package contains interpreted perl scripts, add
1.128     wiz      7725:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      7726:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   7727:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   7728:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      7729:     that you want adjusted. Every occurrence of
                   7730:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   7731:     replaced with the full path to the perl executable.</p>
1.87      wiz      7732: <p>If a particular version of perl is needed, set the
                   7733:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      7734:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.110     hubertf  7735: <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      7736:     about handling perl modules.</p>
                   7737: </div>
1.148     asau     7738: <div class="sect2">
1.87      wiz      7739: <div class="titlepage"><div><div><h3 class="title">
1.147     wiz      7740: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
                   7741: <p><code class="varname">REPLACE_SH</code>,
                   7742:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   7743:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   7744:     hash bangs in files. Please use the appropriate one, prefering
                   7745:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      7746:     Each should contain a list of scripts, relative to
                   7747:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   7748:     occurrence of the matching shell in a she-bang line will be
                   7749:     replaced with the full path to the shell executable.
1.147     wiz      7750:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   7751:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   7752: </div>
1.148     asau     7753: <div class="sect2">
1.147     wiz      7754: <div class="titlepage"><div><div><h3 class="title">
                   7755: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      7756: <p>Currently, there is no special handling for other languages
                   7757:     in pkgsrc.  If a compiler package provides a
                   7758:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   7759:     just add a (build) dependency on the appropriate compiler
                   7760:     package.</p>
                   7761: </div>
                   7762: </div>
1.148     asau     7763: <div class="sect1">
1.87      wiz      7764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7765: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   7766: <p>The most common failures when building a package are that
                   7767:        some platforms do not provide certain header files, functions or
                   7768:        libraries, or they provide the functions in a library that the
                   7769:        original package author didn't know. To work around this, you
                   7770:        can rewrite the source code in most cases so that it does not
                   7771:        use the missing functions or provides a replacement function.</p>
1.148     asau     7772: <div class="sect2">
1.77      rillig   7773: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7774: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   7775: <p>If a package already comes with a GNU configure script, the
                   7776:        preferred way to fix the build failure is to change the
                   7777:        configure script, not the code. In the other cases, you can
                   7778:        utilize the C preprocessor, which defines certain macros
                   7779:        depending on the operating system and hardware architecture it
                   7780:        compiles for. These macros can be queried using for example
                   7781:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   7782:        system, hardware architecture and compiler has its own macro.
                   7783:        For example, if the macros <code class="varname">__GNUC__</code>,
                   7784:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   7785:        are all defined, you know that you are using NetBSD on an i386
                   7786:        compatible CPU, and your compiler is GCC.</p>
                   7787: <p>The list of the following macros for hardware and
                   7788:        operating system depends on the compiler that is used. For
                   7789:        example, if you want to conditionally compile code on Solaris,
                   7790:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   7791:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     7792: <div class="sect3">
1.75      rillig   7793: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7794: <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   7795: <p>To distinguish between 4.4 BSD-derived systems and the
                   7796:         rest of the world, you should use the following code.</p>
                   7797: <pre class="programlisting">
1.100     rillig   7798: #include &lt;sys/param.h&gt;
                   7799: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   7800: /* BSD-specific code goes here */
                   7801: #else
                   7802: /* non-BSD-specific code goes here */
                   7803: #endif
1.75      rillig   7804: </pre>
1.77      rillig   7805: <p>If this distinction is not fine enough, you can also test
                   7806:        for the following macros.</p>
1.75      rillig   7807: <pre class="programlisting">
1.151     obache   7808: Cygwin      __CYGWIN__
                   7809: DragonFly   __DragonFly__
1.100     rillig   7810: FreeBSD     __FreeBSD__
1.151     obache   7811: Haiku       __HAIKU__
1.100     rillig   7812: Interix     __INTERIX
                   7813: IRIX        __sgi (TODO: get a definite source for this)
                   7814: Linux       linux, __linux, __linux__
1.193     dholland 7815: Mac OS X    __APPLE__
1.151     obache   7816: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   7817: Minix3      __minix
1.100     rillig   7818: NetBSD      __NetBSD__
                   7819: OpenBSD     __OpenBSD__
                   7820: Solaris     sun, __sun
1.75      rillig   7821: </pre>
                   7822: </div>
1.148     asau     7823: <div class="sect3">
1.75      rillig   7824: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7825: <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   7826: <pre class="programlisting">
1.100     rillig   7827: i386        i386, __i386, __i386__
                   7828: MIPS        __mips
                   7829: SPARC       sparc, __sparc
1.75      rillig   7830: </pre>
                   7831: </div>
1.148     asau     7832: <div class="sect3">
1.75      rillig   7833: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7834: <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   7835: <pre class="programlisting">
1.100     rillig   7836: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   7837: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   7838: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   7839: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   7840: </pre>
                   7841: </div>
                   7842: </div>
1.148     asau     7843: <div class="sect2">
1.78      rillig   7844: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7845: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   7846: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      7847:         combinations of compiler version and architecture and almost
                   7848:         always relation to optimisation being enabled.  Common symptoms
                   7849:         are gcc internal errors or never finishing compiling a
1.78      rillig   7850:        file.</p>
                   7851: <p>Typically, a workaround involves testing the
                   7852:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   7853:         optimisation for that combination of file,
1.198     tnn      7854:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   7855: <p>This used to be a big problem in the past, but is rarely
                   7856:        needed now as compiler technology has matured. If you still need
                   7857:        to add a compiler specific workaround, please do so in the file
                   7858:        <code class="filename">hacks.mk</code> and describe the symptom and
                   7859:        compiler version as detailed as possible.</p>
1.78      rillig   7860: </div>
1.148     asau     7861: <div class="sect2">
1.78      rillig   7862: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz      7863: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   7864: </h3></div></div></div>
1.92      rillig   7865: <p>This error message often means that a package did not
1.78      rillig   7866:        link to a shared library it needs. The following functions are
                   7867:        known to cause this error message over and over.</p>
                   7868: <div class="informaltable">
1.216     tnn      7869: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   7870: <colgroup>
                   7871: <col>
                   7872: <col>
                   7873: <col>
                   7874: </colgroup>
                   7875: <thead><tr>
                   7876: <th>Function</th>
                   7877: <th>Library</th>
                   7878: <th>Affected platforms</th>
                   7879: </tr></thead>
                   7880: <tbody>
                   7881: <tr>
                   7882: <td>accept, bind, connect</td>
                   7883: <td>-lsocket</td>
                   7884: <td>Solaris</td>
                   7885: </tr>
                   7886: <tr>
                   7887: <td>crypt</td>
                   7888: <td>-lcrypt</td>
                   7889: <td>DragonFly, NetBSD</td>
                   7890: </tr>
                   7891: <tr>
                   7892: <td>dlopen, dlsym</td>
                   7893: <td>-ldl</td>
                   7894: <td>Linux</td>
                   7895: </tr>
                   7896: <tr>
                   7897: <td>gethost*</td>
                   7898: <td>-lnsl</td>
                   7899: <td>Solaris</td>
                   7900: </tr>
                   7901: <tr>
                   7902: <td>inet_aton</td>
                   7903: <td>-lresolv</td>
                   7904: <td>Solaris</td>
                   7905: </tr>
                   7906: <tr>
                   7907: <td>nanosleep, sem_*, timer_*</td>
                   7908: <td>-lrt</td>
                   7909: <td>Solaris</td>
                   7910: </tr>
                   7911: <tr>
                   7912: <td>openpty</td>
                   7913: <td>-lutil</td>
                   7914: <td>Linux</td>
                   7915: </tr>
                   7916: </tbody>
                   7917: </table>
                   7918: </div>
                   7919: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      7920:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   7921:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  7922:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      7923:     bmake</strong></span>.</p>
1.148     asau     7924: <div class="sect3">
1.92      rillig   7925: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7926: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   7927: <p>When you are using the SunPro compiler, there is another
                   7928: possibility. That compiler cannot handle the following code:</p>
                   7929: <pre class="programlisting">
1.100     rillig   7930: extern int extern_func(int);
1.93      rillig   7931: 
1.100     rillig   7932: static inline int
                   7933: inline_func(int x)
                   7934: {
1.92      rillig   7935:         return extern_func(x);
1.100     rillig   7936: }
1.93      rillig   7937: 
1.100     rillig   7938: int main(void)
                   7939: {
1.92      rillig   7940:         return 0;
1.100     rillig   7941: }
1.92      rillig   7942: </pre>
                   7943: <p>It generates the code for <code class="function">inline_func</code> even if
                   7944: that function is never used. This code then refers to
                   7945: <code class="function">extern_func</code>, which can usually not be resolved. To
                   7946: solve this problem you can try to tell the package to disable inlining
                   7947: of functions.</p>
                   7948: </div>
1.87      wiz      7949: </div>
1.148     asau     7950: <div class="sect2">
1.87      wiz      7951: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7952: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      7953: <p>Sometimes packages fail to build because the compiler runs
                   7954:     into an operating system specific soft limit.  With the
                   7955:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      7956:     to unlimit the resources.  Currently, the allowed values are any combination of
                   7957:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   7958:     <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      7959:     Setting this variable is similar to running the shell builtin
1.110     hubertf  7960:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      7961:     segment size or maximum stack size of a process, respectively, to
                   7962:     their hard limits.</p>
1.78      rillig   7963: </div>
1.75      rillig   7964: </div>
1.148     asau     7965: <div class="sect1">
1.75      rillig   7966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7967: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     7968: <div class="sect2">
1.75      rillig   7969: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7970: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  7971: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      7972:     with some operating systems cannot create more than one
                   7973:     directory at a time. As such, you should call
                   7974:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   7975: <pre class="programlisting">
1.100     rillig   7976: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   7977: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    7978: </pre>
1.128     wiz      7979: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   7980:     dir2</code></span>&#8221;</span> to the
1.87      wiz      7981:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   7982:     automatically do the right thing.</p>
1.75      rillig   7983: </div>
1.148     asau     7984: <div class="sect2">
1.75      rillig   7985: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7986: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      7987: <p>In general, documentation should be installed into
1.87      wiz      7988:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   7989:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   7990:     includes the version number of the package).</p>
1.84      wiz      7991: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      7992:     directory where HTML documentation is installed with the
1.128     wiz      7993:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      7994:     is needed because otherwise the documentation ends up in
                   7995:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   7996:     places.</p>
                   7997: <p>An exception to the above is that library API documentation
1.189     snj      7998:     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      7999:     browsers (devhelp) should be left at their default location, which
                   8000:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8001:     documentation can be recognized from files ending in
                   8002:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8003:     (It is also acceptable to install such files in
                   8004:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8005:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8006:     <code class="filename">.devhelp*</code> file must be directly in that
                   8007:     directory then, no additional subdirectory level is allowed in
                   8008:     this case. This is usually achieved by using
1.128     wiz      8009:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      8010:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8011:     though.)</p>
1.75      rillig   8012: </div>
1.148     asau     8013: <div class="sect2">
1.75      rillig   8014: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8015: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8016: <p>Certain packages, most of them in the games category, install
1.87      wiz      8017:     a score file that allows all users on the system to record their
                   8018:     highscores.  In order for this to work, the binaries need to be
                   8019:     installed setgid and the score files owned by the appropriate
1.142     wiz      8020:     group and/or owner (traditionally the "games" user/group).  Set
                   8021:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      8022:     following variables, documented in more detail in
                   8023:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      8024:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8025:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     8026:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8027:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8028:     <code class="varname">GAMEDATA_PERMS</code> and
                   8029:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8030: <p>An example that illustrates some of the variables described above is
                   8031:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8032:     used to properly set directory permissions of the directory where the
                   8033:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8034:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8035:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8036:     binary:</p>
                   8037: <pre class="programlisting">
1.223     rillig   8038: USE_GAMESGROUP=         yes
1.210     leot     8039: 
1.223     rillig   8040: BUILD_DEFS+=            VARBASE
1.210     leot     8041: 
1.223     rillig   8042: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8043: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8044: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    8045: </pre>
1.210     leot     8046: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8047:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8048:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8049:     needed to be accessed by setgid games and
                   8050:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 8051: <p>A package should therefore never hard code file ownership or
1.210     leot     8052:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8053:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8054:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8055:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   8056: </div>
1.148     asau     8057: <div class="sect2">
1.75      rillig   8058: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8059: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8060: <p><code class="varname">DESTDIR</code> support means that a package
                   8061:     installs into a staging directory, not the final location of the
                   8062:     files. Then a binary package is created which can be used for
                   8063:     installation as usual. There are two ways: Either the package must
1.128     wiz      8064:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8065:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     8066: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8067: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     8068:       set to <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>.
                   8069:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      8070:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8071:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 8072:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8073:       the inclusion.</p></li>
1.128     wiz      8074: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      8075:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      8076: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      8077:       automatically. Many manual rules and pre/post-install often are
                   8078:       incorrect; fix them.</p></li>
1.128     wiz      8079: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     8080:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      8081: <li class="listitem"><p>In general, packages should support
1.103     wiz      8082:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8083:       DESTDIR.</p></li>
                   8084: </ul></div>
                   8085: </div>
1.148     asau     8086: <div class="sect2">
1.103     wiz      8087: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8088: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8089: <p>Your package may also contain scripts with hardcoded paths to
                   8090:       other interpreters besides (or as well as) perl.  To correct the
                   8091:       full pathname to the script interpreter, you need to set the
                   8092:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8093:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8094: <pre class="programlisting">
1.100     rillig   8095: REPLACE_INTERPRETER+=   tcl
                   8096: REPLACE.tcl.old=        .*/bin/tclsh
                   8097: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8098: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8099: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    8100: </pre>
1.148     asau     8101: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8102: <h3 class="title">Note</h3>
                   8103: <p>Before March 2006, these variables were called
1.87      wiz      8104:     <code class="varname">_REPLACE.*</code> and
                   8105:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8106: </div>
                   8107: </div>
1.148     asau     8108: <div class="sect2">
1.75      rillig   8109: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8110: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8111: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8112:     the Makefile fragment
                   8113:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8114:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8115:     configuration for such modules as well as various hooks to tune
                   8116:     this configuration.  See comments in this file for
                   8117:     details.</p>
1.75      rillig   8118: <p>Perl5 modules will install into different places depending
1.87      wiz      8119:     on the version of perl used during the build process.  To
                   8120:     address this, pkgsrc will append lines to the
                   8121:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8122:     the installed <code class="filename">.packlist</code> file generated by
                   8123:     most perl5 modules.  This is invoked by defining
                   8124:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      8125:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8126:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8127:     e.g.:</p>
1.75      rillig   8128: <pre class="programlisting">
1.153     wiz      8129: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    8130: </pre>
1.153     wiz      8131: <p>The perl5 config variables
                   8132:     <code class="varname">installarchlib</code>,
                   8133:     <code class="varname">installscript</code>,
                   8134:     <code class="varname">installvendorbin</code>,
                   8135:     <code class="varname">installvendorscript</code>,
                   8136:     <code class="varname">installvendorarch</code>,
                   8137:     <code class="varname">installvendorlib</code>,
                   8138:     <code class="varname">installvendorman1dir</code>, and
                   8139:     <code class="varname">installvendorman3dir</code> represent those
                   8140:     locations in which components of perl5 modules may be installed,
                   8141:     provided as variable with uppercase and prefixed with
                   8142:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8143:     and may be used by perl5 packages that don't have a packlist.
                   8144:     These variables are also substituted for in the
                   8145:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8146:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   8147: </div>
1.148     asau     8148: <div class="sect2">
1.75      rillig   8149: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8150: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8151: <p>Some packages install info files or use the
1.128     wiz      8152:     <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      8153:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8154:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8155:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8156:     handle registration of the info files in the Info directory
1.128     wiz      8157:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      8158:     files registration is either provided by the system, or by a
                   8159:     special purpose package automatically added as dependency if
                   8160:     needed.</p>
1.75      rillig   8161: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8162:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8163:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      8164:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   8165: <p>The info files for the package should be listed in the
1.87      wiz      8166:     package <code class="filename">PLIST</code>; however any split info files
                   8167:     need not be listed.</p>
1.128     wiz      8168: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8169:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      8170:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      8171:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      8172:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8173:     variable in the package <code class="filename">Makefile</code>. By
                   8174:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  8175:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      8176:     does not match the required minimum, a build dependency on the
1.189     snj      8177:     <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      8178:     be added automatically.</p>
1.75      rillig   8179: <p>The build and installation process of the software provided
1.87      wiz      8180:     by the package should not use the
1.110     hubertf  8181:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      8182:     info files is the task of the package
                   8183:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  8184:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   8185: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  8186:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8187:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      8188:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  8189: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      8190:     no effect except the logging of a message. The script overriding
1.110     hubertf  8191:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      8192:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  8193:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8194: </div>
1.148     asau     8195: <div class="sect2">
1.75      rillig   8196: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8197: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8198: <p>All packages that install manual pages should install them
1.87      wiz      8199:     into the same directory, so that there is one common place to look
                   8200:     for them. In pkgsrc, this place is
                   8201:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8202:     should be used in packages. The default for
                   8203:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      8204:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8205:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     8206: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8207: <h3 class="title">Note</h3>
1.87      wiz      8208: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8209:     is far from complete.</p>
1.75      rillig   8210: </div>
1.81      rillig   8211: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8212:     <code class="filename">man/</code> as the top level directory for the man
                   8213:     page file entries, and the pkgsrc framework will convert as
                   8214:     needed. In all other places, the correct
                   8215:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8216: <p>Packages that are
                   8217:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      8218:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      8219:     <code class="filename">./configure</code>
                   8220:     --mandir switch to set where the man pages should be installed.
                   8221:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8222:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8223: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8224:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      8225:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      8226:     Or if the <code class="filename">./configure</code> script uses
                   8227:     a non-standard use of --mandir, you can set
                   8228:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  8229: <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      8230:     information on installation of compressed manual pages.</p>
1.75      rillig   8231: </div>
1.148     asau     8232: <div class="sect2">
1.75      rillig   8233: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   8234: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      8235: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   8236:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      8237:     you need to take some extra steps to make sure they get registered
                   8238:     in the database:</p>
1.128     wiz      8239: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8240: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      8241:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   8242:        takes care of rebuilding the GConf database at installation and
1.87      wiz      8243:        deinstallation time, and tells the package where to install
1.107     rillig   8244:        GConf data files using some standard configure arguments.  It
1.87      wiz      8245:        also disallows any access to the database directly from the
                   8246:        package.</p></li>
1.128     wiz      8247: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      8248:        <code class="filename">.schemas</code> files under
                   8249:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8250:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8251:        need to manually patch the package.</p></li>
1.128     wiz      8252: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8253:        directory, as they will be handled automatically.  See
1.194     bsiegert 8254:        <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      8255: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      8256:        your <code class="filename">Makefile</code> with a list of all
                   8257:        <code class="filename">.schemas</code> files installed by the package, if
                   8258:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      8259: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      8260:        your <code class="filename">Makefile</code> with a
                   8261:        list of all <code class="filename">.entries</code> files installed by the
                   8262:        package, if any. Names must not contain any directories in
                   8263:        them.</p></li>
1.75      rillig   8264: </ol></div>
                   8265: </div>
1.148     asau     8266: <div class="sect2">
1.75      rillig   8267: <div class="titlepage"><div><div><h3 class="title">
1.119     mishka   8268: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      8269: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   8270:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      8271:     get registered in the database:</p>
1.128     wiz      8272: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8273: <li class="listitem"><p>Include
1.119     mishka   8274:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   8275:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      8276:        takes care of rebuilding the scrollkeeper database at
                   8277:        installation and deinstallation time, and disallows any access
                   8278:        to it directly from the package.</p></li>
1.128     wiz      8279: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8280:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8281:        will be handled automatically.</p></li>
1.128     wiz      8282: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   8283:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   8284:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   8285: </ol></div>
                   8286: </div>
1.148     asau     8287: <div class="sect2">
1.75      rillig   8288: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8289: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   8290: <p>If a package installs font files, you will need to rebuild
1.87      wiz      8291:     the fonts database in the directory where they get installed at
                   8292:     installation and deinstallation time.  This can be automatically
                   8293:     done by using the pkginstall framework.</p>
1.75      rillig   8294: <p>You can list the directories where fonts are installed in the
1.87      wiz      8295:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8296:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      8297:     <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      8298:     Also make sure that the database file
                   8299:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   8300: <p>Note that you should not create new directories for fonts;
1.87      wiz      8301:     instead use the standard ones to avoid that the user needs to
                   8302:     manually configure his X server to find them.</p>
1.75      rillig   8303: </div>
1.148     asau     8304: <div class="sect2">
1.75      rillig   8305: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8306: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   8307: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      8308:     take some extra steps to get them registered in the GTK2 database
                   8309:     properly:</p>
1.128     wiz      8310: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8311: <li class="listitem"><p>Include
1.87      wiz      8312:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8313:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8314:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      8315: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      8316:       your package installs GTK2 immodules.</p></li>
1.128     wiz      8317: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      8318:       GTK2 loaders.</p></li>
1.128     wiz      8319: <li class="listitem">
1.87      wiz      8320: <p>Patch the package to not touch any of the GTK2
                   8321:       databases directly.  These are:</p>
1.148     asau     8322: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8323: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8324: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   8325: </ul></div>
                   8326: </li>
1.128     wiz      8327: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      8328:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8329:       directory, as they will be handled automatically.</p></li>
1.75      rillig   8330: </ol></div>
                   8331: </div>
1.148     asau     8332: <div class="sect2">
1.75      rillig   8333: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8334: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   8335: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      8336:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8337:     etc.), you need to take some extra steps:</p>
1.128     wiz      8338: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8339: <li class="listitem"><p>Include
1.87      wiz      8340:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8341:        your <code class="filename">Makefile</code>, which takes care of
                   8342:        registering those files in system-wide catalogs at
                   8343:        installation and deinstallation time.</p></li>
1.128     wiz      8344: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      8345:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      8346: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      8347:        any XML catalogs installed by the package.</p></li>
1.128     wiz      8348: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      8349:        to be added to the SGML catalog.  These come in groups of
                   8350:        three strings; see xmlcatmgr(1) for more information
                   8351:        (specifically, arguments recognized by the 'add' action).
                   8352:        Note that you will normally not use this variable.</p></li>
1.128     wiz      8353: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      8354:        to be added to the XML catalog.  These come in groups of three
                   8355:        strings; see xmlcatmgr(1) for more information (specifically,
                   8356:        arguments recognized by the 'add' action).  Note that you will
                   8357:        normally not use this variable.</p></li>
1.75      rillig   8358: </ol></div>
                   8359: </div>
1.148     asau     8360: <div class="sect2">
1.75      rillig   8361: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8362: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   8363: <p>If a package provides extensions to the MIME database by
1.87      wiz      8364:     installing <code class="filename">.xml</code> files inside
                   8365:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8366:     need to take some extra steps to ensure that the database is kept
                   8367:     consistent with respect to these new files:</p>
1.128     wiz      8368: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8369: <li class="listitem"><p>Include
1.87      wiz      8370:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   8371:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   8372:        this same directory, which is reserved for inclusion from
                   8373:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   8374:        care of rebuilding the MIME database at installation and
                   8375:        deinstallation time, and disallows any access to it directly
                   8376:        from the package.</p></li>
1.128     wiz      8377: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8378:        <code class="filename">share/mime</code> directory,
                   8379:        <span class="emphasis"><em>except</em></span> for files saved under
                   8380:        <code class="filename">share/mime/packages</code>.  The former are
                   8381:        handled automatically by
                   8382:        the update-mime-database program, but the latter are
                   8383:        package-dependent and must be removed by the package that
                   8384:        installed them in the first place.</p></li>
1.128     wiz      8385: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      8386:        from the PLIST.  They will be handled by the shared-mime-info
                   8387:        package.</p></li>
1.75      rillig   8388: </ol></div>
                   8389: </div>
1.148     asau     8390: <div class="sect2">
1.75      rillig   8391: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8392: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   8393: <p>If a package uses intltool during its build, add
                   8394:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      8395:     which forces it to use the intltool package provided by pkgsrc,
                   8396:     instead of the one bundled with the distribution file.</p>
1.75      rillig   8397: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      8398:     latest available version; this way, the package benefits of any
                   8399:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   8400: </div>
1.148     asau     8401: <div class="sect2">
1.75      rillig   8402: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8403: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   8404: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      8405:     the startup directory by default, but you can enable it, by adding
                   8406:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  8407:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      8408:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   8409:     it will automatically remove the scripts when the package is
                   8410:     deinstalled.</p>
1.75      rillig   8411: </div>
1.148     asau     8412: <div class="sect2">
1.75      rillig   8413: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8414: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   8415: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      8416:     the <code class="filename">ls-R</code> database of the tree needs to be
                   8417:     updated.</p>
1.148     asau     8418: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8419: <h3 class="title">Note</h3>
1.125     wiz      8420: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      8421:     packages should install files
1.125     wiz      8422:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8423:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   8424: </div>
1.128     wiz      8425: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8426: <li class="listitem"><p>Include
1.125     wiz      8427:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      8428:       takes care of rebuilding the <code class="filename">ls-R</code>
                   8429:       database at installation and deinstallation time.</p></li>
1.128     wiz      8430: <li class="listitem">
1.75      rillig   8431: <p>If your package installs files into a texmf
1.87      wiz      8432:       tree other than the one
1.125     wiz      8433:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8434:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      8435:       trees that need database update.</p>
1.75      rillig   8436: <p>If your package also installs font map files that need
1.110     hubertf  8437:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 8438:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      8439:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   8440:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  8441:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      8442:       be run automatically at installation/deinstallation to
                   8443:       enable/disable font map files for TeX output
                   8444:       drivers.</p>
1.75      rillig   8445: </li>
1.128     wiz      8446: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      8447:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 8448:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   8449: </ol></div>
                   8450: </div>
1.148     asau     8451: <div class="sect2">
1.85      jmmv     8452: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8453: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      8454:     emulation</h3></div></div></div>
                   8455: <p>There are some packages that provide libraries and
                   8456:     executables for running binaries from a one operating system
                   8457:     on a different one (if the latter supports it).  One example
                   8458:     is running Linux binaries on NetBSD.</p>
1.189     snj      8459: <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      8460:     helps in extracting and packaging Linux rpm packages.</p>
                   8461: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  8462:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      8463:     if all libraries for each installed executable can be found by
                   8464:     the dynamic linker.  Since the standard dynamic linker is run,
                   8465:     this fails for emulation packages, because the libraries used
                   8466:     by the emulation are not in the standard directories.</p>
                   8467: </div>
1.148     asau     8468: <div class="sect2">
1.87      wiz      8469: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8470: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     8471: <p>If a package installs images under the
1.87      wiz      8472:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   8473:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   8474:     database, you need to take some extra steps to make sure that the
                   8475:     shared theme directory is handled appropriately and that the cache
                   8476:     database is rebuilt:</p>
1.128     wiz      8477: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8478: <li class="listitem"><p>Include
1.87      wiz      8479:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128     wiz      8480: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87      wiz      8481:        entry that refers to the theme cache.</p></li>
1.128     wiz      8482: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85      jmmv     8483:          directories from the <code class="filename">share/icons/hicolor</code>
                   8484:          hierarchy because they will be handled automatically.</p></li>
                   8485: </ol></div>
                   8486: <p>The best way to verify that the PLIST is correct with
                   8487:       respect to the last two points is to regenerate it using
1.110     hubertf  8488:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     8489: </div>
1.148     asau     8490: <div class="sect2">
1.85      jmmv     8491: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8492: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     8493: <p>If a package installs <code class="filename">.desktop</code> files
                   8494:       under <code class="filename">share/applications</code> and these include
1.159     rodent   8495:       MIME information (MimeType key), you need to take extra steps to
                   8496:       ensure that they are registered into the MIME database:</p>
1.128     wiz      8497: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8498: <li class="listitem"><p>Include
1.85      jmmv     8499:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128     wiz      8500: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85      jmmv     8501:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   8502:          It will be handled automatically.</p></li>
                   8503: </ol></div>
                   8504: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  8505:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     8506:       print-PLIST</strong></span>.</p>
1.75      rillig   8507: </div>
                   8508: </div>
1.148     asau     8509: <div class="sect1">
1.87      wiz      8510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8511: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      8512: <p>In some cases one does not have the time to solve a problem
1.125     wiz      8513:   immediately. In this case, one can plainly mark a package as broken.  For
                   8514:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   8515:   reason why the package is broken (similar to the
                   8516:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   8517:   the package will immediately be shown this message, and the build
                   8518:   will not be even tried.</p>
                   8519: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87      wiz      8520:   intervals.</p>
                   8521: </div>
1.75      rillig   8522: </div>
1.148     asau     8523: <div class="chapter">
1.75      rillig   8524: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   8525: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      8526: <p>To check out all the gotchas when building a package, here are
                   8527:   the steps that I do in order to get a package working.  Please note
                   8528:   this is basically the same as what was explained in the previous
                   8529:   sections, only with some debugging aids.</p>
1.148     asau     8530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8531: <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>
                   8532: <li class="listitem">
1.189     snj      8533: <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      8534:       create a directory for a new package, change into it, then run
1.110     hubertf  8535:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   8536: <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>
                   8537: <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>
                   8538: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   8539: </li>
1.128     wiz      8540: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   8541: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   8542: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   8543: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      8544:       configure step to the package's
                   8545:       <code class="filename">Makefile</code>.</p></li>
1.128     wiz      8546: <li class="listitem">
1.75      rillig   8547: <p>Make the package compile, doing multiple rounds of</p>
                   8548: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   8549: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   8550: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   8551: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   8552: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   8553: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   8554: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      8555: <p>Doing this step as non-root user will ensure that no files
                   8556:       are modified that shouldn't be, especially during the build
1.110     hubertf  8557:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   8558:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.189     snj      8559:       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      8560:       package.</p>
1.75      rillig   8561: </li>
1.128     wiz      8562: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   8563:       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>
                   8564: <li class="listitem">
1.76      rillig   8565: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   8566: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8567: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   8568: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   8569: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8570: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      8571: <p>You usually need to be <code class="username">root</code> to do
                   8572:       this.  Look if there are any files left:</p>
1.75      rillig   8573: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8574: <p>If this reveals any files that are missing in
1.88      wiz      8575:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   8576: </li>
1.128     wiz      8577: <li class="listitem">
1.88      wiz      8578: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   8579:       package again and make a binary package:</p>
1.75      rillig   8580: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   8581: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   8582: </li>
1.128     wiz      8583: <li class="listitem">
1.75      rillig   8584: <p>Delete the installed package:</p>
1.88      wiz      8585: <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   8586: </li>
1.128     wiz      8587: <li class="listitem">
1.110     hubertf  8588: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      8589:       command, which shouldn't find anything now:</p>
1.75      rillig   8590: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8591: </li>
1.128     wiz      8592: <li class="listitem">
1.75      rillig   8593: <p>Reinstall the binary package:</p>
1.93      rillig   8594: <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   8595: </li>
1.128     wiz      8596: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   8597: <li class="listitem">
1.189     snj      8598: <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      8599:       reports:</p>
1.75      rillig   8600: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   8601: </li>
1.128     wiz      8602: <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   8603: </ul></div>
                   8604: </div>
1.148     asau     8605: <div class="chapter">
1.75      rillig   8606: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   8607: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   8608: <div class="toc">
                   8609: <p><b>Table of Contents</b></p>
1.210     leot     8610: <dl class="toc">
1.106     rillig   8611: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   8612: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   8613: <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      8614: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig   8615: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     8616: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   8617: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   8618: </dl>
                   8619: </div>
1.148     asau     8620: <div class="sect1">
1.75      rillig   8621: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8622: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   8623: <p>Our policy is that we accept binaries only from pkgsrc
                   8624:        developers to guarantee that the packages don't contain any
                   8625:        trojan horses etc. This is not to annoy anyone but rather to
                   8626:        protect our users! You're still free to put up your home-made
                   8627:        binary packages and tell the world where to get them. NetBSD
                   8628:        developers doing bulk builds and wanting to upload them please
1.174     asau     8629:        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
                   8630: builds)</i></a>.</p>
1.75      rillig   8631: </div>
1.148     asau     8632: <div class="sect1">
1.75      rillig   8633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8634: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   8635: <p>First, check that your package is complete, compiles and
1.110     hubertf  8636:        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      8637:        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   8638:        archive that contains all files that make up the package.
1.87      wiz      8639:        Finally, send this package to the pkgsrc bug tracking system,
1.189     snj      8640:        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      8641:        that, go to the web page
1.110     hubertf  8642:        <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      8643:        which contains some instructions and a link to a form where you
                   8644:        can submit packages.  The
1.189     snj      8645:        <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      8646:        also available as a substitute for either of the above two tools.
                   8647:        </p>
1.87      wiz      8648: <p>In the form of the problem report, the category should be
1.128     wiz      8649:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      8650:        and version number, and the description field should contain a
                   8651:        short description of your package (contents of the COMMENT
                   8652:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      8653:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   8654: <p>If you want to submit several packages, please send a
                   8655:        separate PR for each one, it's easier for us to track things
                   8656:        that way.</p>
                   8657: <p>Alternatively, you can also import new packages into
1.128     wiz      8658:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.215     wiz      8659:        homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.75      rillig   8660:        for details.</p>
                   8661: </div>
1.148     asau     8662: <div class="sect1">
1.75      rillig   8663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8664: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   8665: <p>Please note all package additions, updates, moves, and
1.93      rillig   8666:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   8667:        important to keep this file up to date and conforming to the
                   8668:        existing format, because it will be used by scripts to
1.110     hubertf  8669:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   8670:        sites. Additionally, check the
1.76      rillig   8671:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   8672:        for the package you updated or removed, in case it was mentioned
                   8673:        there.</p>
                   8674: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   8675:        bumped, the change should appear in
1.93      rillig   8676:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   8677:        related or otherwise relevant. Mass bumps that result from a
                   8678:        dependency being updated should not be mentioned. In all other
                   8679:        cases it's the developer's decision.</p>
                   8680: <p>There is a make target that helps in creating proper
1.110     hubertf  8681:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   8682:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   8683:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   8684:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   8685:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  8686:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   8687:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   8688:   For new packages, or package moves or removals, set the
                   8689:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   8690:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  8691:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      8692:   not the same as your NetBSD login name. The target also automatically
                   8693:   removes possibly existing entries for the package in the
                   8694:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     8695:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 8696:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      8697:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   8698:   makes the cvs commands use the main repository.
                   8699:   </p>
1.75      rillig   8700: </div>
1.148     asau     8701: <div class="sect1">
1.75      rillig   8702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140     wiz      8703: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      8704: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      8705:   access to the pkgsrc repository.</p>
                   8706: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   8707: Start by adding the directory and then files in the directory. Don't
                   8708: forget to add the new package to the category's
                   8709: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   8710: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   8711: <pre class="programlisting">
                   8712: <code class="prompt">$</code> cd .../pkgsrc/category
                   8713: <code class="prompt">$</code> cvs add pkgname
                   8714: <code class="prompt">$</code> cd pkgname
                   8715: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   8716: <code class="prompt">$</code> cvs add patches/p*
                   8717: <code class="prompt">$</code> cvs status | less
1.141     wiz      8718: <code class="prompt">$</code> cvs commit
1.140     wiz      8719: <code class="prompt">$</code> cd ..
                   8720: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      8721: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     8722: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  8723: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      8724: </pre>
1.87      wiz      8725: <p>The commit message of the initial import should include part of the
1.76      rillig   8726:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      8727:   what the package is/does.</p>
1.140     wiz      8728: <p>Also mention the new package in
                   8729: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   8730: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   8731: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   8732: </div>
1.148     asau     8733: <div class="sect1">
1.75      rillig   8734: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8735: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      8736: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   8737:   changes between old and new versions into the commit log when updating
1.87      wiz      8738:   a package. There are various reasons for this:</p>
1.148     asau     8739: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8740: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      8741:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      8742: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      8743:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      8744: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   8745:   repository is very useful for people who read the pkgsrc-changes mailing
                   8746:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      8747:   the package.</p></li>
1.75      rillig   8748: </ul></div>
1.87      wiz      8749: <p>Please also recognize that, just because a new version of a package
1.75      rillig   8750:   has been released, it should not automatically be upgraded in the CVS
                   8751:   repository.  We prefer to be conservative in the packages that are
                   8752:   included in pkgsrc - development or beta packages are not really the
                   8753:   best thing for most places in which pkgsrc is used. Please use your
                   8754:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      8755:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   8756: </div>
1.148     asau     8757: <div class="sect1">
1.75      rillig   8758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122     reed     8759: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
                   8760: <p>Renaming packages is not recommended.</p>
                   8761: <p>When renaming packages, be sure to fix any references to old name
                   8762:   in other Makefiles, options, buildlink files, etc.</p>
                   8763: <p>Also When renaming a package, please define
                   8764:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   8765:   pattern(s) of the previous package name.
                   8766:   This may be repeated for multiple renames.
                   8767:   The new package would be an exact replacement.
                   8768: </p>
1.128     wiz      8769: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     8770:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   8771:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   8772:   not be an exact replacement but is a suggestion for the replaced
                   8773:   functionality.</p>
                   8774: </div>
1.148     asau     8775: <div class="sect1">
1.122     reed     8776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   8777: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
                   8778: <p>It is preferred that packages are not renamed or moved, but if needed
                   8779:   please follow these steps.
                   8780: </p>
1.128     wiz      8781: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8782: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   8783: <li class="listitem">
1.75      rillig   8784: <p>Remove all CVS dirs.</p>
1.87      wiz      8785: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   8786: <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      8787: <p>and use that for further work.</p>
1.75      rillig   8788: </li>
1.128     wiz      8789: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   8790: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   8791: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   8792: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     8793: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   8794: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   8795: for doing an update using pkgsrc building; for example, it can
1.189     snj      8796: 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     8797: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   8798: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   8799: it may have multiple matches, so the tool should also check on the
                   8800: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   8801: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   8802: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      8803: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   8804: place.</p></li>
1.128     wiz      8805: <li class="listitem">
1.75      rillig   8806: <p>Check if any package depends on it:
                   8807: </p>
                   8808: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   8809: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   8810: </li>
1.128     wiz      8811: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   8812: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   8813: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   8814: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   8815: <li class="listitem">
1.75      rillig   8816: <p>Commit the changed and removed files:</p>
                   8817: <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      8818: <p>(and any packages from step 5, of course).</p>
1.75      rillig   8819: </li>
                   8820: </ol></div>
                   8821: </div>
                   8822: </div>
1.148     asau     8823: <div class="chapter">
1.75      rillig   8824: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   8825: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   8826: <p>This section contains the answers to questions that may
                   8827:        arise when you are writing a package. If you don't find your
                   8828:        question answered here, first have a look in the other chapters,
                   8829:        and if you still don't have the answer, ask on the
                   8830:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     8831: <div class="qandaset">
1.231   ! sevan    8832: <a name="idp140472187444112"></a><dl>
1.106     rillig   8833: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   8834:        MAKEFLAGS, .MAKEFLAGS and
                   8835:        MAKE_FLAGS?</a>
                   8836: </dt>
1.106     rillig   8837: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   8838:        MAKE, GMAKE and
                   8839:        MAKE_PROGRAM?</a>
                   8840: </dt>
1.106     rillig   8841: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   8842:        CC, PKG_CC and
                   8843:        PKGSRC_COMPILER?</a>
                   8844: </dt>
1.106     rillig   8845: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   8846:        BUILDLINK_LDFLAGS,
                   8847:        BUILDLINK_LDADD and
                   8848:        BUILDLINK_LIBS?</a>
                   8849: </dt>
1.106     rillig   8850: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   8851:        VARNAME=BUILDLINK_PREFIX.foo
                   8852:        say it's empty?</a>
                   8853: </dt>
1.106     rillig   8854: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   8855:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   8856:        don't understand the := inside
                   8857:        it.</a>
                   8858: </dt>
1.106     rillig   8859: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   8860:        developers?</a>
                   8861: </dt>
1.106     rillig   8862: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   8863:        documentation?</a>
                   8864: </dt>
1.106     rillig   8865: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   8866: do?</a>
                   8867: </dt>
1.75      rillig   8868: </dl>
1.148     asau     8869: <table border="0" style="width: 100%;">
                   8870: <colgroup>
1.75      rillig   8871: <col align="left" width="1%">
1.128     wiz      8872: <col>
1.148     asau     8873: </colgroup>
1.75      rillig   8874: <tbody>
1.148     asau     8875: <tr class="question">
1.75      rillig   8876: <td align="left" valign="top">
1.231   ! sevan    8877: <a name="devfaq.makeflags"></a><a name="idp140472187444784"></a><p><b>22.1.</b></p>
1.75      rillig   8878: </td>
                   8879: <td align="left" valign="top"><p>What is the difference between
                   8880:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   8881:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   8882: </tr>
                   8883: <tr class="answer">
1.91      rillig   8884: <td align="left" valign="top"></td>
1.75      rillig   8885: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.189     snj      8886:        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   8887:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   8888:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   8889:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   8890: </tr>
1.148     asau     8891: <tr class="question">
1.75      rillig   8892: <td align="left" valign="top">
1.231   ! sevan    8893: <a name="devfaq.make"></a><a name="idp140472187449200"></a><p><b>22.2.</b></p>
1.75      rillig   8894: </td>
                   8895: <td align="left" valign="top"><p>What is the difference between
                   8896:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   8897:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   8898: </tr>
                   8899: <tr class="answer">
1.91      rillig   8900: <td align="left" valign="top"></td>
1.75      rillig   8901: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.189     snj      8902:        <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   8903:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   8904:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   8905:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   8906:        Make program that is used for building the
                   8907:        package.</p></td>
                   8908: </tr>
1.148     asau     8909: <tr class="question">
1.75      rillig   8910: <td align="left" valign="top">
1.231   ! sevan    8911: <a name="devfaq.cc"></a><a name="idp140472187454208"></a><p><b>22.3.</b></p>
1.75      rillig   8912: </td>
                   8913: <td align="left" valign="top"><p>What is the difference between
                   8914:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   8915:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   8916: </tr>
                   8917: <tr class="answer">
1.91      rillig   8918: <td align="left" valign="top"></td>
1.75      rillig   8919: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   8920:        compiler, which can be configured by the pkgsrc user.
                   8921:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   8922:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   8923:        path to a compiler, but the type of compiler that should be
1.76      rillig   8924:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   8925:        information about the latter variable.</p></td>
                   8926: </tr>
1.148     asau     8927: <tr class="question">
1.75      rillig   8928: <td align="left" valign="top">
1.231   ! sevan    8929: <a name="devfaq.bl3flags"></a><a name="idp140472187459120"></a><p><b>22.4.</b></p>
1.75      rillig   8930: </td>
                   8931: <td align="left" valign="top"><p>What is the difference between
                   8932:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   8933:        <code class="varname">BUILDLINK_LDADD</code> and
                   8934:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   8935: </tr>
                   8936: <tr class="answer">
1.91      rillig   8937: <td align="left" valign="top"></td>
1.75      rillig   8938: <td align="left" valign="top"><p>[FIXME]</p></td>
                   8939: </tr>
1.148     asau     8940: <tr class="question">
1.75      rillig   8941: <td align="left" valign="top">
1.231   ! sevan    8942: <a name="devfaq.bl3prefix"></a><a name="idp140472187461712"></a><p><b>22.5.</b></p>
1.75      rillig   8943: </td>
1.110     hubertf  8944: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   8945:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   8946:        say it's empty?</p></td>
                   8947: </tr>
                   8948: <tr class="answer">
1.91      rillig   8949: <td align="left" valign="top"></td>
1.75      rillig   8950: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      8951:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   8952:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  8953:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   8954:        command.</p></td>
                   8955: </tr>
1.148     asau     8956: <tr class="question">
1.78      rillig   8957: <td align="left" valign="top">
1.231   ! sevan    8958: <a name="devfaq.master_sites"></a><a name="idp140472187465600"></a><p><b>22.6.</b></p>
1.78      rillig   8959: </td>
                   8960: <td align="left" valign="top"><p>What does
1.220     wiz      8961:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   8962:        don't understand the <code class="code">:=</code> inside
1.78      rillig   8963:        it.</p></td>
                   8964: </tr>
                   8965: <tr class="answer">
1.91      rillig   8966: <td align="left" valign="top"></td>
1.220     wiz      8967: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   8968:        assignment operator, although it looks like it.
1.78      rillig   8969:        Instead, it is a degenerate form of
1.220     wiz      8970:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
                   8971:        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 is
                   8972:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   8973:        case of <code class="varname">MASTER_SITE_*</code>,
                   8974:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   8975:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      8976:        <code class="code">package/</code>. That's where the
                   8977:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   8978:        together.</p></td>
                   8979: </tr>
1.148     asau     8980: <tr class="question">
1.78      rillig   8981: <td align="left" valign="top">
1.231   ! sevan    8982: <a name="devfaq.mailinglists"></a><a name="idp140472187473312"></a><p><b>22.7.</b></p>
1.78      rillig   8983: </td>
                   8984: <td align="left" valign="top"><p>Which mailing lists are there for package
                   8985:        developers?</p></td>
                   8986: </tr>
                   8987: <tr class="answer">
1.91      rillig   8988: <td align="left" valign="top"></td>
1.148     asau     8989: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110     hubertf  8990: <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   8991: <dd><p>This is a list for technical discussions related
                   8992:        to pkgsrc development, e.g. soliciting feedback for changes to
                   8993:        pkgsrc infrastructure, proposed new features, questions related
                   8994:        to porting pkgsrc to a new platform, advice for maintaining a
                   8995:        package, patches that affect many packages, help requests moved
                   8996:        from pkgsrc-users when an infrastructure bug is found,
                   8997:        etc.</p></dd>
1.110     hubertf  8998: <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   8999: <dd><p>All bug reports in category "pkg" sent with
1.189     snj      9000:        <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   9001:        directly; use one of the other mailing
                   9002:        lists.</p></dd>
                   9003: </dl></div></td>
                   9004: </tr>
1.148     asau     9005: <tr class="question">
1.80      rillig   9006: <td align="left" valign="top">
1.231   ! sevan    9007: <a name="devfaq.documentation"></a><a name="idp140472187478272"></a><p><b>22.8.</b></p>
1.80      rillig   9008: </td>
                   9009: <td align="left" valign="top"><p>Where is the pkgsrc
                   9010:        documentation?</p></td>
                   9011: </tr>
                   9012: <tr class="answer">
1.91      rillig   9013: <td align="left" valign="top"></td>
1.80      rillig   9014: <td align="left" valign="top">
                   9015: <p>There are many places where you can find
                   9016:        documentation about pkgsrc:</p>
1.148     asau     9017: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9018: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   9019:        of chapters that explain large parts of pkgsrc, but some
                   9020:        chapters tend to be outdated. Which ones they are is hard to
                   9021:        say.</p></li>
1.128     wiz      9022: <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   9023:        about certain features, announcements of new parts of the pkgsrc
                   9024:        infrastructure and sometimes even announcements that a certain
                   9025:        feature has been marked as obsolete. The benefit here is that
                   9026:        each message has a date appended to it.</p></li>
1.128     wiz      9027: <li class="listitem"><p>Many of the files in the
1.80      rillig   9028:        <code class="filename">mk/</code> directory start with a comment that
                   9029:        describes the purpose of the file and how it can be used by the
1.92      rillig   9030:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9031:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9032:        help</strong></span>.</p></li>
1.128     wiz      9033: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   9034:        information, but they tend to be highly abbreviated, especially
                   9035:        for actions that occur often. Some contain a detailed
                   9036:        description of what has changed, but they are geared towards the
                   9037:        other pkgsrc developers, not towards an average pkgsrc user.
                   9038:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9039:        don't know what has been before, these messages may not be worth
                   9040:        too much to you.</p></li>
1.128     wiz      9041: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9042:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   9043:        mind of the developer who wrote the code. To get this
1.110     hubertf  9044:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9045:        to see who has written it and ask on the
                   9046:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9047:        find your questions later (see above). To be sure that the
                   9048:        developer in charge reads the mail, you may CC him or
                   9049:        her.</p></li>
                   9050: </ul></div>
                   9051: </td>
                   9052: </tr>
1.148     asau     9053: <tr class="question">
1.92      rillig   9054: <td align="left" valign="top">
1.231   ! sevan    9055: <a name="devfaq.too-much-time"></a><a name="idp140472187487104"></a><p><b>22.9.</b></p>
1.92      rillig   9056: </td>
                   9057: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9058: do?</p></td>
                   9059: </tr>
                   9060: <tr class="answer">
                   9061: <td align="left" valign="top"></td>
                   9062: <td align="left" valign="top">
1.93      rillig   9063: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9064: anyway.</p>
1.148     asau     9065: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9066: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.189     snj      9067:     <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   9068:     will tell you about newer versions of installed packages that are
                   9069:     available, but not yet updated in pkgsrc.</p></li>
1.128     wiz      9070: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126     jakllsch 9071:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   9072:     cleanups and enhancements for pkgsrc that would be nice to
                   9073:     have.</p></li>
1.128     wiz      9074: <li class="listitem"><p>Review packages for which review was requested on
1.180     wiz      9075:     the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92      rillig   9076:     mailing list.</p></li>
                   9077: </ul></div>
                   9078: </td>
                   9079: </tr>
1.75      rillig   9080: </tbody>
                   9081: </table>
                   9082: </div>
                   9083: </div>
1.148     asau     9084: <div class="chapter">
1.85      jmmv     9085: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9086: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9087: <div class="toc">
                   9088: <p><b>Table of Contents</b></p>
1.210     leot     9089: <dl class="toc">
1.106     rillig   9090: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9091: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9092: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9093: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     9094: </dl>
                   9095: </div>
1.110     hubertf  9096: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9097: site</a>:</p>
                   9098: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9099:   environment, an intuitive and attractive desktop for users, and the
                   9100:   GNOME development platform, an extensive framework for building
                   9101:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9102: <p>pkgsrc provides a seamless way to automatically build and install
                   9103: a complete GNOME environment <span class="emphasis"><em>under many different
                   9104: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9105: the most advanced build and packaging systems for GNOME due to its
                   9106: included technologies buildlink3, the wrappers and tools framework and
                   9107: automatic configuration file management.  Lots of efforts are put into
                   9108: achieving a completely clean deinstallation of installed software
                   9109: components.</p>
1.110     hubertf  9110: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9111: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9112: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9113: pkgsrc as its preferred packaging system, contributing lots of
                   9114: portability fixes to make GNOME build and install under it.</p>
                   9115: <p>This chapter is aimed at pkgsrc developers and other people
                   9116: interested in helping our GNOME porting and packaging efforts.  It
                   9117: provides instructions on how to manage the existing packages and some
                   9118: important information regarding their internals.</p>
1.148     asau     9119: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85      jmmv     9120: <h3 class="title">We need your help!</h3>
                   9121: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9122:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9123:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9124:   work</a> list!  There is still a long way to go to get a
                   9125:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9126:   achieve it!</p>
                   9127: </div>
1.148     asau     9128: <div class="sect1">
1.85      jmmv     9129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9130: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     9131: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148     asau     9132: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      9133: <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     9134:     the core GNOME desktop environment.  It only includes the necessary
                   9135:     bits to get it to boot correctly, although it may lack important
                   9136:     functionality for daily operation.  The idea behind this package is
                   9137:     to let end users build their own configurations on top of this one,
                   9138:     first installing this meta package to achieve a functional setup and
                   9139:     then adding individual applications.</p></li>
1.189     snj      9140: <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     9141:     complete installation of the GNOME platform and desktop as defined
                   9142:     by the GNOME project; this is based on the components distributed in
                   9143:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9144:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9145:     official FTP server.  Developer-only tools found in those
                   9146:     directories are not installed unless required by some other
                   9147:     component to work properly.  Similarly, packages from the bindings
                   9148:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9149:     in unless required as a dependency for an end-user component.  This
1.189     snj      9150:     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>
                   9151: <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     9152:     Installs all the tools required to build a GNOME component when
                   9153:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9154:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9155: </ul></div>
                   9156: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9157: sorted in a way that eases updates: a package may depend on other
                   9158: packages listed before it but not on any listed after it.  It is very
                   9159: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9160: change it to alphabetical sorting!</em></span></p>
                   9161: </div>
1.148     asau     9162: <div class="sect1">
1.85      jmmv     9163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9164: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9165: <p>Almost all GNOME applications are written in C and use a common
                   9166: set of tools as their build system.  Things get different with the new
                   9167: bindings to other languages (such as Python), but the following will
                   9168: give you a general idea on the minimum required tools:</p>
1.148     asau     9169: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9170: <li class="listitem">
1.85      jmmv     9171: <p>Almost all GNOME applications use the GNU Autotools as their
                   9172:     build system.  As a general rule you will need to tell this to your
                   9173:     package:</p>
1.100     rillig   9174: <pre class="programlisting">
                   9175: GNU_CONFIGURE=yes
1.85      jmmv     9176: USE_LIBTOOL=yes
1.100     rillig   9177: USE_TOOLS+=gmake
                   9178: </pre>
1.85      jmmv     9179: </li>
1.128     wiz      9180: <li class="listitem">
1.85      jmmv     9181: <p>If the package uses pkg-config to detect dependencies, add this
                   9182:     tool to the list of required utilities:</p>
1.222     sevan    9183: <pre class="programlisting">
                   9184: USE_TOOLS+=pkg-config
                   9185: </pre>
1.189     snj      9186: <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     9187:     the end of the build process to ensure that you did not miss to
                   9188:     specify any dependency in your package and that the version
                   9189:     requirements are all correct.</p>
                   9190: </li>
1.128     wiz      9191: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93      rillig   9192:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9193:     to handle dependencies and to force the package to use the latest
                   9194:     available version.</p></li>
1.128     wiz      9195: <li class="listitem">
1.85      jmmv     9196: <p>If the package uses gtk-doc (a documentation generation
                   9197:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9198:     tool is rather big and the distfile should come with pregenerated
                   9199:     documentation anyway; if it does not, it is a bug that you ought to
                   9200:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9201:     the default):</p>
1.222     sevan    9202: <pre class="programlisting">
                   9203: CONFIGURE_ARGS+=--disable-gtk-doc
                   9204: </pre>
1.89      rillig   9205: <p>The default location of installed HTML files
                   9206:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9207:     and should not be changed unless the package insists on installing
                   9208:     them somewhere else.  Otherwise programs as
1.110     hubertf  9209:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   9210:     do that with an entry similar to:</p>
1.222     sevan    9211: <pre class="programlisting">
                   9212: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9213: </pre>
1.85      jmmv     9214: </li>
                   9215: </ul></div>
                   9216: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9217: files under the installation prefix to maintain databases.  In this
                   9218: context, shared means that those exact same directories and files are
                   9219: used among several different packages, leading to conflicts in the
                   9220: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9221: handle the most common cases, so you have to forget about using
                   9222: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9223: omitting shared files from them.  If you find yourself doing those,
                   9224: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9225: <p>The following table lists the common situations that result in
                   9226: using shared directories or files.  For each of them, the appropriate
                   9227: solution is given.  After applying the solution be sure to
                   9228: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  9229: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     9230: <div class="table">
1.106     rillig   9231: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.216     tnn      9232: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9233: <colgroup>
                   9234: <col>
                   9235: <col>
                   9236: </colgroup>
                   9237: <thead><tr>
                   9238: <th>If the package...</th>
                   9239: <th>Then...</th>
                   9240: </tr></thead>
                   9241: <tbody>
                   9242: <tr>
                   9243: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119     mishka   9244: <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     9245: </tr>
                   9246: <tr>
                   9247: <td>Installs icons under the
                   9248:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9249:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  9250: <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     9251: </tr>
                   9252: <tr>
                   9253: <td>Installs files under
                   9254:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  9255: <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     9256: </tr>
                   9257: <tr>
                   9258: <td>Installs <code class="filename">.desktop</code> files under
                   9259:         <code class="filename">share/applications</code> and these include MIME
                   9260:         information.</td>
1.110     hubertf  9261: <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     9262: </tr>
                   9263: </tbody>
1.91      rillig   9264: </table></div>
1.85      jmmv     9265: </div>
1.91      rillig   9266: <br class="table-break">
1.85      jmmv     9267: </div>
1.148     asau     9268: <div class="sect1">
1.85      jmmv     9269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9270: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9271: <p>When seeing GNOME as a whole, there are two kinds of
                   9272: updates:</p>
1.148     asau     9273: <div class="variablelist"><dl class="variablelist">
1.85      jmmv     9274: <dt><span class="term">Major update</span></dt>
                   9275: <dd>
                   9276: <p>Given that there is still a very long way for GNOME 3 (if it
                   9277:       ever appears), we consider a major update one that goes from a
                   9278:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9279:       where <code class="literal">Y</code> is even and greater than
                   9280:       <code class="literal">X</code>.  These are hard to achieve because they
                   9281:       introduce lots of changes in the components' code and almost all
                   9282:       GNOME distfiles are updated to newer versions.  Some of them can
                   9283:       even break API and ABI compatibility with the previous major
                   9284:       version series.  As a result, the update needs to be done all at
                   9285:       once to minimize breakage.</p>
                   9286: <p>A major update typically consists of around 80 package
                   9287:       updates and the addition of some new ones.</p>
                   9288: </dd>
                   9289: <dt><span class="term">Minor update</span></dt>
                   9290: <dd>
                   9291: <p>We consider a minor update one that goes from a
                   9292:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9293:       one where <code class="literal">Y</code> is greater than
                   9294:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9295:       not update all GNOME components, can be done in an incremental way
                   9296:       and do not break API nor ABI compatibility.</p>
                   9297: <p>A minor update typically consists of around 50 package
                   9298:       updates, although the numbers here may vary a lot.</p>
                   9299: </dd>
                   9300: </dl></div>
                   9301: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9302: release (either major or minor), the following steps should be
                   9303: followed:</p>
1.128     wiz      9304: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9305: <li class="listitem">
1.85      jmmv     9306: <p>Get a list of all the tarballs that form the new release by
                   9307:     using the following commands.  These will leave the full list of the
1.120     snj      9308:     components' distfiles into the <code class="filename">list.txt</code>
1.85      jmmv     9309:     file:</p>
1.88      wiz      9310: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9311:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9312:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9313: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9314:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9315:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9316: </li>
1.128     wiz      9317: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85      jmmv     9318:     bump their version to the release you are updating them to.  The
                   9319:     three meta packages should be always consistent with versioning.
                   9320:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9321:     in them.</p></li>
1.128     wiz      9322: <li class="listitem">
1.85      jmmv     9323: <p>For each meta package, update all its
                   9324:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9325:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9326:     newer version (even if found in the FTP) because the meta packages
                   9327:     are supposed to list the exact versions that form a specific GNOME
                   9328:     release.  Exceptions are permitted here if a newer version solves a
                   9329:     serious issue in the overall desktop experience; these typically
                   9330:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9331:     from the developers.</p>
                   9332: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9333:     should be updated to the latest version available (if found in
                   9334:     pkgsrc).  This is the case, for example, of the dependencies on the
1.189     snj      9335:     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     9336: </li>
1.128     wiz      9337: <li class="listitem">
1.85      jmmv     9338: <p>Generate a patch from the modified meta packages and extract the
                   9339:     list of "new" lines.  This will provide you an outline on what
                   9340:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   9341: <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     9342: </li>
1.128     wiz      9343: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85      jmmv     9344:     installed packages and start over from scratch at this point.</p></li>
1.128     wiz      9345: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85      jmmv     9346:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9347:     it in order.  For major desktop updates none of these should be
1.93      rillig   9348:     committed until the entire set is completed because there are chances
1.85      jmmv     9349:     of breaking not-yet-updated packages.</p></li>
1.128     wiz      9350: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85      jmmv     9351:     the tree one by one with appropriate log messages.  At the end,
                   9352:     commit the three meta package updates and all the corresponding
                   9353:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9354:     <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>
                   9355: </ol></div>
                   9356: </div>
1.148     asau     9357: <div class="sect1">
1.85      jmmv     9358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9359: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     9360: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9361: packages.  Please, it is very important that you always, always,
                   9362: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  9363: 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     9364: their attention on portability issues and to ensure that future versions
                   9365: can be built out-of-the box on NetBSD.  The less custom patches in
                   9366: pkgsrc, the easier further updates are.  Those developers in charge of
                   9367: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  9368: <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     9369: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9370: of them do.  Do not be short on your reports: always provide detailed
                   9371: explanations of the current failure, how it can be improved to achieve
                   9372: maximum portability and, if at all possible, provide a patch against CVS
                   9373: head.  The more verbose you are, the higher chances of your patch being
                   9374: accepted.</p>
                   9375: <p>Also, please avoid using preprocessor magic to fix portability
                   9376: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9377: GNOME to their operating system, the official GNOME sources are now
                   9378: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9379: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  9380: 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     9381: details.</p>
                   9382: </div>
                   9383: </div>
1.75      rillig   9384: </div>
1.148     asau     9385: <div class="part">
1.75      rillig   9386: <div class="titlepage"><div><div><h1 class="title">
                   9387: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     9388: <div class="partintro">
1.75      rillig   9389: <div></div>
                   9390: <p>This part of the guide deals with everything
                   9391:        from the infrastructure that is behind the interfaces described
                   9392:        in the developer's guide. A casual package maintainer should not
                   9393:        need anything from this part.</p>
                   9394: <div class="toc">
                   9395: <p><b>Table of Contents</b></p>
1.210     leot     9396: <dl class="toc">
1.106     rillig   9397: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   9398: <dd><dl>
1.106     rillig   9399: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   9400: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   9401: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   9402: <dd><dl>
1.106     rillig   9403: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   9404: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   9405: </dl></dd>
1.106     rillig   9406: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   9407: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9408: <dd><dl>
1.106     rillig   9409: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   9410: <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   9411: </dl></dd>
1.106     rillig   9412: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   9413: <dd><dl>
1.128     wiz      9414: <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>
                   9415: <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   9416: </dl></dd>
                   9417: </dl></dd>
1.106     rillig   9418: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   9419: <dd><dl>
1.219     rillig   9420: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
                   9421: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75      rillig   9422: <dd><dl>
1.219     rillig   9423: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
                   9424: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75      rillig   9425: </dl></dd>
                   9426: </dl></dd>
1.106     rillig   9427: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.219     rillig   9428: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig   9429: </dl>
                   9430: </div>
                   9431: </div>
1.148     asau     9432: <div class="chapter">
1.75      rillig   9433: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9434: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   9435: <div class="toc">
                   9436: <p><b>Table of Contents</b></p>
1.210     leot     9437: <dl class="toc">
1.106     rillig   9438: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   9439: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   9440: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   9441: <dd><dl>
1.106     rillig   9442: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   9443: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   9444: </dl></dd>
1.106     rillig   9445: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   9446: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9447: <dd><dl>
1.106     rillig   9448: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   9449: <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   9450: </dl></dd>
1.106     rillig   9451: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   9452: <dd><dl>
1.128     wiz      9453: <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>
                   9454: <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   9455: </dl></dd>
                   9456: </dl>
                   9457: </div>
                   9458: <p>The pkgsrc infrastructure consists of many small Makefile
                   9459:        fragments. Each such fragment needs a properly specified
                   9460:        interface. This chapter explains how such an interface looks
                   9461:        like.</p>
1.148     asau     9462: <div class="sect1">
1.75      rillig   9463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9464: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   9465: <p>Whenever a variable is defined in the pkgsrc
                   9466:        infrastructure, the location and the way of definition provide
                   9467:        much information about the intended use of that variable.
                   9468:        Additionally, more documentation may be found in a header
                   9469:        comment or in this pkgsrc guide.</p>
                   9470: <p>A special file is
                   9471:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   9472:        variables that are intended to be user-defined. They are either
                   9473:        defined using the <code class="literal">?=</code> operator or they are
                   9474:        left undefined because defining them to anything would
1.128     wiz      9475:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   9476:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   9477:        file.</p>
                   9478: <p>Outside this file, the following conventions apply:
                   9479:        Variables that are defined using the <code class="literal">?=</code>
                   9480:        operator may be overridden by a package.</p>
                   9481: <p>Variables that are defined using the <code class="literal">=</code>
                   9482:        operator may be used read-only at run-time.</p>
                   9483: <p>Variables whose name starts with an underscore must not be
                   9484:        accessed outside the pkgsrc infrastructure at all. They may
                   9485:        change without further notice.</p>
1.148     asau     9486: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   9487: <h3 class="title">Note</h3>
                   9488: <p>These conventions are currently not applied
                   9489:        consistently to the complete pkgsrc
                   9490:        infrastructure.</p>
                   9491: </div>
                   9492: </div>
1.148     asau     9493: <div class="sect1">
1.81      rillig   9494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9495: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   9496: <p>All variables that contain lists of things should default
                   9497:        to being empty. Two examples that do not follow this rule are
                   9498:        <code class="varname">USE_LANGUAGES</code> and
                   9499:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   9500:        modified using the <code class="literal">+=</code> operator in package
                   9501:        <code class="filename">Makefile</code>s (or other files included by
                   9502:        them), since there is no guarantee whether the variable is
                   9503:        already set or not, and what its value is. In the case of
1.128     wiz      9504:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   9505:        the default value and just define it as in the following
                   9506:        example.</p>
                   9507: <pre class="programlisting">
1.100     rillig   9508: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   9509: </pre>
                   9510: <p>Because of the selection of this default value, the same
                   9511:        value appears in many package Makefiles. Similarly for
                   9512:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      9513:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   9514:        doesn't stand out. Nevertheless it is mentioned in many
                   9515:        files.</p>
                   9516: </div>
1.148     asau     9517: <div class="sect1">
1.81      rillig   9518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9519: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148     asau     9520: <div class="sect2">
1.75      rillig   9521: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9522: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   9523: <p>Variable evaluation takes place either at load time or at
                   9524:        runtime, depending on the context in which they occur. The
                   9525:        contexts where variables are evaluated at load time are:</p>
1.148     asau     9526: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9527: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   9528:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      9529: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   9530:        <code class="literal">.for</code>,</p></li>
1.128     wiz      9531: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   9532: </ul></div>
                   9533: <p>A special exception are references to the iteration
                   9534:        variables of <code class="literal">.for</code> loops, which are expanded
                   9535:        inline, no matter in which context they appear.</p>
                   9536: <p>As the values of variables may change during load time,
                   9537:        care must be taken not to evaluate them by accident. Typical
                   9538:        examples for variables that should not be evaluated at load time
                   9539:        are <code class="varname">DEPENDS</code> and
                   9540:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   9541:        clear, here is an example:</p>
                   9542: <pre class="programlisting">
1.100     rillig   9543: CONFIGURE_ARGS=         # none
                   9544: CFLAGS=                 -O
                   9545: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    9546: 
1.100     rillig   9547: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    9548: 
1.100     rillig   9549: CFLAGS+=                -Wall
1.222     sevan    9550: </pre>
1.75      rillig   9551: <p>This code shows how the use of the <code class="literal">:=</code>
                   9552:        operator can quickly lead to unexpected results. The first
                   9553:        paragraph is fairly common code. The second paragraph evaluates
                   9554:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   9555:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   9556:        <code class="literal">-Wall</code> is appended to the
                   9557:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   9558:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   9559:        paragraphs from above typically occur in completely unrelated
                   9560:        files.</p>
                   9561: </div>
1.148     asau     9562: <div class="sect2">
1.75      rillig   9563: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9564: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   9565: <p>After all the files have been loaded, the values of the
                   9566:        variables cannot be changed anymore. Variables that are used in
                   9567:        the shell commands are expanded at this point.</p>
                   9568: </div>
                   9569: </div>
1.148     asau     9570: <div class="sect1">
1.75      rillig   9571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9572: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   9573: <p>There are many ways in which the definition and use of a
1.218     rillig   9574:        variable can be restricted in order to detect bugs and violations
                   9575:        of the (mostly unwritten) policies. A package can be checked with
                   9576:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   9577:        rules.</p>
1.78      rillig   9578: </div>
1.148     asau     9579: <div class="sect1">
1.78      rillig   9580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9581: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   9582: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   9583:        of the following classes. Cases where a file falls into more
                   9584:        than one class should be avoided as it often leads to subtle
                   9585:        bugs.</p>
1.148     asau     9586: <div class="sect2">
1.75      rillig   9587: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9588: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   9589: <p>In a traditional imperative programming language some of
1.76      rillig   9590:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 9591:        procedures. They take some input parameters and&mdash;after
                   9592:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   9593:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   9594:        care must be taken not to use parameter names that have already
                   9595:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   9596:        bad choice for a parameter name.</p>
                   9597: <p>Procedures are completely evaluated at preprocessing time.
                   9598:        That is, when calling a procedure all input parameters must be
                   9599:        completely resolvable. For example,
                   9600:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   9601:        parameter since it is very likely that further text will be
                   9602:        added after calling the procedure, which would effectively apply
                   9603:        the procedure to only a part of the variable. Also, references
1.218     rillig   9604:        to other variables will be modified after calling the
1.75      rillig   9605:        procedure.</p>
                   9606: <p>A procedure can declare its output parameters either as
                   9607:        suitable for use in preprocessing directives or as only
                   9608:        available at runtime. The latter alternative is for variables
                   9609:        that contain references to other runtime variables.</p>
                   9610: <p>Procedures shall be written such that it is possible to
                   9611:        call the procedure more than once. That is, the file must not
                   9612:        contain multiple-inclusion guards.</p>
                   9613: <p>Examples for procedures are
1.76      rillig   9614:        <code class="filename">mk/bsd.options.mk</code> and
                   9615:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   9616:        that the parameters are evaluated at load time, they should be
                   9617:        assigned using the <code class="literal">:=</code> operator, which should
                   9618:        be used only for this purpose.</p>
                   9619: </div>
1.148     asau     9620: <div class="sect2">
1.75      rillig   9621: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9622: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   9623: <p>Action files take some input parameters and may define
                   9624:        runtime variables. They shall not define loadtime variables.
                   9625:        There are action files that are included implicitly by the
                   9626:        pkgsrc infrastructure, while other must be included
                   9627:        explicitly.</p>
                   9628: <p>An example for action files is
1.76      rillig   9629:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   9630: </div>
                   9631: </div>
1.148     asau     9632: <div class="sect1">
1.81      rillig   9633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9634: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   9635: <p>Package <code class="filename">Makefile</code>s usually consist of
                   9636:        a set of variable definitions, and include the file
                   9637:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   9638:        Before that, they may also include various other
                   9639:        <code class="filename">*.mk</code> files if they need to query the
                   9640:        availability of certain features like the type of compiler or
                   9641:        the X11 implementation. Due to the heavy use of preprocessor
                   9642:        directives like <code class="literal">.if</code> and
                   9643:        <code class="literal">.for</code>, the order in which the files are loaded
                   9644:        matters.</p>
                   9645: <p>This section describes at which point the various files
                   9646:        are loaded and gives reasons for that order.</p>
1.148     asau     9647: <div class="sect2">
1.81      rillig   9648: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9649: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   9650: </h3></div></div></div>
                   9651: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   9652:        is to define some essential variables like
                   9653:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   9654:        <code class="varname">MACHINE_ARCH</code>.</p>
                   9655: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  9656:        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   9657:        After that, those variables
1.81      rillig   9658:        that have not been overridden by the user are loaded from
                   9659:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   9660: <p>After the user settings, the system settings and platform
                   9661:        settings are loaded, which may override the user
                   9662:        settings.</p>
                   9663: <p>Then, the tool definitions are loaded. The tool wrappers
                   9664:        are not yet in effect. This only happens when building a
                   9665:        package, so the proper variables must be used instead of the
                   9666:        direct tool names.</p>
                   9667: <p>As the last steps, some essential variables from the
                   9668:        wrapper and the package system flavor are loaded, as well as the
                   9669:        variables that have been cached in earlier phases of a package
                   9670:        build.</p>
                   9671: </div>
1.148     asau     9672: <div class="sect2">
1.81      rillig   9673: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9674: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   9675: </h3></div></div></div>
1.81      rillig   9676: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   9677: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   9678:        loaded, which fill default values for those variables that have
1.93      rillig   9679:        not been defined by the package. These variables may later
1.81      rillig   9680:        be used even in unrelated files.</p>
                   9681: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   9682:        provides the target <code class="literal">error-check</code> that is added
                   9683:        as a special dependency to all other targets that use
                   9684:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   9685:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   9686: <p>Then, the package-specific hacks from
                   9687:        <code class="filename">hacks.mk</code> are included.</p>
                   9688: <p>Then, various other files follow. Most of them don't have
                   9689:        any dependencies on what they need to have included before or
                   9690:        after them, though some do.</p>
                   9691: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   9692:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   9693:        restricts the use of these variables to all the files that have
                   9694:        been included before. Appearances in later files will be
                   9695:        silently ignored.</p>
                   9696: <p>Then, the files for the main targets are included, in the
                   9697:        order of later execution, though the actual order should not
                   9698:        matter.</p>
                   9699: <p>At last, some more files are included that don't set any
                   9700:        interesting variables but rather just define make targets to be
                   9701:        executed.</p>
                   9702: </div>
                   9703: </div>
1.75      rillig   9704: </div>
1.148     asau     9705: <div class="chapter">
1.75      rillig   9706: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9707: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   9708: <div class="toc">
                   9709: <p><b>Table of Contents</b></p>
1.210     leot     9710: <dl class="toc">
1.219     rillig   9711: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
                   9712: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75      rillig   9713: <dd><dl>
1.219     rillig   9714: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
                   9715: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75      rillig   9716: </dl></dd>
                   9717: </dl>
                   9718: </div>
                   9719: <p>The pkgsrc infrastructure consists of a large codebase,
                   9720:        and there are many corners where every little bit of a file is
                   9721:        well thought out, making pkgsrc likely to fail as soon as
                   9722:        anything is changed near those parts. To prevent most changes
                   9723:        from breaking anything, a suite of regression tests should go
                   9724:        along with every important part of the pkgsrc infrastructure.
                   9725:        This chapter describes how regression tests work in pkgsrc and
                   9726:        how you can add new tests.</p>
1.148     asau     9727: <div class="sect1">
1.75      rillig   9728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219     rillig   9729: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.189     snj      9730: <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  9731:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   9732:        can simply run that command, which will run all tests in the
1.76      rillig   9733:        <code class="filename">regress</code> category.</p>
1.75      rillig   9734: </div>
1.148     asau     9735: <div class="sect1">
1.75      rillig   9736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219     rillig   9737: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.76      rillig   9738: <p>Every directory in the <code class="filename">regress</code>
                   9739:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   9740:        is considered a regression test. This file is a shell program
1.110     hubertf  9741:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   9742:        The following functions can be overridden to suit your
                   9743:        needs.</p>
1.148     asau     9744: <div class="sect2">
1.75      rillig   9745: <div class="titlepage"><div><div><h3 class="title">
1.219     rillig   9746: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   9747: <p>These functions do not take any parameters. Although they
                   9748:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
                   9749:        first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
                   9750:        question</a> for details.</p>
1.148     asau     9751: <div class="variablelist"><dl class="variablelist">
1.218     rillig   9752: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   9753: <dd><p>This function prepares the environment for the
                   9754:        test. By default it does nothing.</p></dd>
1.218     rillig   9755: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   9756: <dd>
                   9757: <p>This function runs the actual test. By default,
1.75      rillig   9758:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   9759:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   9760:        error messages into the file
1.218     rillig   9761:        <code class="varname">TEST_OUTFILE</code>.</p>
                   9762: <p>When defining this function, make sure that all output that
                   9763:        needs to be checked is written to the correct output file.
                   9764:        Example:</p>
                   9765: <pre class="programlisting">
                   9766: do_test() {
1.223     rillig   9767:         echo "Example output"
1.218     rillig   9768: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   9769: </pre>
                   9770: </dd>
                   9771: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   9772: <dd>
                   9773: <p>This function is run after the test and is
1.75      rillig   9774:        typically used to compare the actual output from the one that is
                   9775:        expected. It can make use of the various helper functions from
1.218     rillig   9776:        the next section. Example:</p>
                   9777: <pre class="programlisting">
                   9778: check_result() {
1.223     rillig   9779:         exit_status 0
                   9780:         output_require "Example"
                   9781:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   9782:         output_prohibit "no such file or directory"
1.218     rillig   9783: }
                   9784: </pre>
                   9785: </dd>
                   9786: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   9787: <dd><p>This function cleans everything up after the
                   9788:        test has been run. By default it does nothing.</p></dd>
                   9789: </dl></div>
                   9790: </div>
1.148     asau     9791: <div class="sect2">
1.75      rillig   9792: <div class="titlepage"><div><div><h3 class="title">
1.219     rillig   9793: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.148     asau     9794: <div class="variablelist"><dl class="variablelist">
1.218     rillig   9795: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   9796: <dd><p>This function compares the exitcode of the
1.218     rillig   9797:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   9798:        If they differ, the test will fail.</p></dd>
1.218     rillig   9799: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   9800: <dd>
                   9801: <p>This function checks for each of its parameters
                   9802:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   9803:        extended regular expression. If it does not, the test will
1.218     rillig   9804:        fail. Example:</p>
                   9805: <pre class="programlisting">
1.219     rillig   9806: output_require "looks fine"
                   9807: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   9808: </pre>
                   9809: </dd>
1.75      rillig   9810: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   9811: <dd><p>This function checks for each of its parameters
1.110     hubertf  9812:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   9813:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   9814:        If any of the regular expressions matches, the test will
                   9815:        fail.</p></dd>
                   9816: </dl></div>
                   9817: </div>
                   9818: </div>
                   9819: </div>
1.148     asau     9820: <div class="chapter">
1.75      rillig   9821: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9822: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   9823: <div class="toc">
                   9824: <p><b>Table of Contents</b></p>
1.219     rillig   9825: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.75      rillig   9826: </div>
                   9827: <p>The pkgsrc system has already been ported to many
                   9828:        operating systems, hardware architectures and compilers. This
                   9829:        chapter explains the necessary steps to make pkgsrc even more
                   9830:        portable.</p>
1.148     asau     9831: <div class="sect1">
1.75      rillig   9832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9833: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   9834: <p>To port pkgsrc to a new operating system (called
                   9835:        <code class="literal">MyOS</code> in this example), you need to touch the
                   9836:        following files:</p>
1.148     asau     9837: <div class="variablelist"><dl class="variablelist">
1.93      rillig   9838: <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   9839: <dd><p>This file contains some basic definitions, for
                   9840:        example the name of the C
                   9841:        compiler.</p></dd>
1.76      rillig   9842: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   9843: <dd><p>Insert code that defines the variables
                   9844:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   9845:        <code class="varname">LOWER_OS_VERSION</code>,
                   9846:        <code class="varname">LOWER_VENDOR</code>,
                   9847:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   9848:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   9849:        appear in this file.</p></dd>
1.93      rillig   9850: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   9851: <dd><p>This file contains the platform-specific
                   9852:        definitions that are used by pkgsrc. Start by copying one of the
                   9853:        other files and edit it to your
                   9854:        needs.</p></dd>
1.93      rillig   9855: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   9856: <dd><p>This file defines the paths to all the tools
                   9857:        that are needed by one or the other package in pkgsrc, as well
                   9858:        as by pkgsrc itself. Find out where these tools are on your
                   9859:        platform and add them.</p></dd>
                   9860: </dl></div>
                   9861: <p>Now, you should be able to build some basic packages, like
1.189     snj      9862:        <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   9863: </div>
                   9864: </div>
                   9865: </div>
1.148     asau     9866: <div class="appendix">
                   9867: <div class="titlepage"><div><div><h1 class="title">
                   9868: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   9869: <div class="toc">
                   9870: <p><b>Table of Contents</b></p>
1.210     leot     9871: <dl class="toc">
1.75      rillig   9872: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   9873: <dd><dl>
                   9874: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   9875: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   9876: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz      9877: <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   9878: </dl></dd>
                   9879: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   9880: </dl>
                   9881: </div>
                   9882: <p>We checked to find a piece of software that wasn't in the packages
                   9883:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  9884:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   9885:     present in the tree is beyond us, but it's useful for the purposes of
                   9886:     this exercise.</p>
1.148     asau     9887: <div class="sect1">
1.75      rillig   9888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9889: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     9890: <div class="sect2">
1.75      rillig   9891: <div class="titlepage"><div><div><h3 class="title">
                   9892: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   9893: <pre class="programlisting">
1.100     rillig   9894: # $NetBSD$
                   9895: #
1.1       grant    9896: 
1.100     rillig   9897: DISTNAME=       bison-1.25
                   9898: CATEGORIES=     devel
                   9899: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    9900: 
1.136     dholland 9901: MAINTAINER=     pkgsrc-users@NetBSD.org
1.100     rillig   9902: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   9903: COMMENT=        GNU yacc clone
1.1       grant    9904: 
1.100     rillig   9905: GNU_CONFIGURE=  yes
1.152     wiz      9906: INFO_FILES=     yes
1.1       grant    9907: 
1.100     rillig   9908: .include "../../mk/bsd.pkg.mk"
1.1       grant    9909: </pre>
1.75      rillig   9910: </div>
1.148     asau     9911: <div class="sect2">
1.75      rillig   9912: <div class="titlepage"><div><div><h3 class="title">
                   9913: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   9914: <pre class="programlisting">
1.100     rillig   9915: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.189     snj      9916: 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   9917: of the NetBSD source tree is beyond me.
1.1       grant    9918: </pre>
1.75      rillig   9919: </div>
1.148     asau     9920: <div class="sect2">
1.75      rillig   9921: <div class="titlepage"><div><div><h3 class="title">
                   9922: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   9923: <pre class="programlisting">
1.100     rillig   9924: @comment $NetBSD$
                   9925: bin/bison
                   9926: man/man1/bison.1.gz
                   9927: share/bison.simple
                   9928: share/bison.hairy
1.1       grant    9929: </pre>
1.75      rillig   9930: </div>
1.148     asau     9931: <div class="sect2">
1.75      rillig   9932: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  9933: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   9934: </h3></div></div></div>
1.75      rillig   9935: <p>The NetBSD package system comes with
1.189     snj      9936:         <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   9937:        which helps to check the contents of these
                   9938:        files. After installation it is quite easy to use, just change to the
                   9939:        directory of the package you wish to examine and execute
1.110     hubertf  9940:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   9941: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   9942: looks fine.</pre>
                   9943: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  9944:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   9945:        -Wall</strong></span> for a very thorough check.</p>
                   9946: </div>
                   9947: </div>
1.148     asau     9948: <div class="sect1">
1.75      rillig   9949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9950: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   9951: <p>Create the directory where the package lives,
                   9952:       plus any auxiliary directories:</p>
                   9953: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   9954: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   9955: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   9956: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   9957: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  9958:       <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   9959:       then continue with fetching the distfile:</p>
                   9960: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    9961: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   9962: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   9963: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   9964: ftp: Error retrieving file: 500 Internal error
                   9965: 
                   9966: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   9967: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   9968: ftp: Error retrieving file: 500 Internal error
                   9969: 
                   9970: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   9971: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   9972: Successfully retrieved file.</pre>
                   9973: <p>Generate the checksum of the distfile into
1.76      rillig   9974:       <code class="filename">distinfo</code>:</p>
1.88      wiz      9975: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   9976: <p>Now compile:</p>
                   9977: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    9978: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   9979: ===&gt;  Extracting for bison-1.25
                   9980: ===&gt;  Patching for bison-1.25
                   9981: ===&gt;   Ignoring empty patch directory
                   9982: ===&gt;  Configuring for bison-1.25
                   9983: creating cache ./config.cache
                   9984: checking for gcc... cc
                   9985: checking whether we are using GNU C... yes
                   9986: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   9987: checking how to run the C preprocessor... cc -E
                   9988: checking for minix/config.h... no
                   9989: checking for POSIXized ISC... no
                   9990: checking whether cross-compiling... no
                   9991: checking for ANSI C header files... yes
                   9992: checking for string.h... yes
                   9993: checking for stdlib.h... yes
                   9994: checking for memory.h... yes
                   9995: checking for working const... yes
                   9996: checking for working alloca.h... no
                   9997: checking for alloca... yes
                   9998: checking for strerror... yes
                   9999: updating cache ./config.cache
                   10000: creating ./config.status
                   10001: creating Makefile
                   10002: ===&gt;  Building for bison-1.25
                   10003: 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
                   10004: 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
                   10005: 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
                   10006: 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
                   10007: 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   10008: 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    10009: 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
                   10010: 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
                   10011: 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
                   10012: 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
                   10013: 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
                   10014: 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
                   10015: 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
                   10016: 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
                   10017: 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
                   10018: 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
                   10019: 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
                   10020: 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
                   10021: 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
                   10022: 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
                   10023: 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
                   10024: 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
                   10025: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10026: rm -f bison.s1
1.75      rillig   10027: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10028: <p>Everything seems OK, so install the files:</p>
                   10029: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10030: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10031: ===&gt;  Installing for bison-1.25
                   10032: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10033: rm -f /usr/pkg/bin/bison
                   10034: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10035: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10036: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10037: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10038: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10039: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10040: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10041: ===&gt;  Registering installation for bison-1.25</pre>
                   10042: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10043:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10044:       binary package, do this now:</p>
                   10045: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10046: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10047: ===&gt;  Building package for bison-1.25
                   10048: Creating package bison-1.25.tgz
                   10049: Registering depends:.
1.75      rillig   10050: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10051: <p>Now that you don't need the source and object files
                   10052:       any more, clean up:</p>
                   10053: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10054: ===&gt;  Cleaning for bison-1.25</pre>
                   10055: </div>
                   10056: </div>
1.148     asau     10057: <div class="appendix">
                   10058: <div class="titlepage"><div><div><h1 class="title">
                   10059: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   10060: <div class="toc">
                   10061: <p><b>Table of Contents</b></p>
1.210     leot     10062: <dl class="toc">
1.75      rillig   10063: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10064: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10065: </dl>
                   10066: </div>
1.148     asau     10067: <div class="sect1">
1.75      rillig   10068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10069: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10070: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10071: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10072: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10073: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10074: =&gt; [172219 bytes]
                   10075: Connected to ftp.plig.net.
                   10076: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10077: 331 Guest login ok, send your complete e-mail address as password.
                   10078: 230-You are user #5 of 500 simultaneous users allowed.
                   10079: 230-
1.68      rillig   10080: 230-  ___ _             _ _
                   10081: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10082: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10083: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10084: 230-         |_|   |_|     |___|         |___|
                   10085: 230-
                   10086: 230-** Welcome to ftp.plig.org **
                   10087: 230-
                   10088: 230-Please note that all transfers from this FTP site are logged. If you
                   10089: 230-do not like this, please disconnect now.
                   10090: 230-
1.120     snj      10091: 230-This archive is available via
1.1       grant    10092: 230-
                   10093: 230-HTTP:  http://ftp.plig.org/
                   10094: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10095: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10096: 230-
                   10097: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10098: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10099: 230-
                   10100: 230-
                   10101: 230 Logged in anonymously.
                   10102: Remote system type is UNIX.
                   10103: Using binary mode to transfer files.
                   10104: 200 Type okay.
                   10105: 250 "/pub" is new cwd.
                   10106: 250-"/pub/figlet" is new cwd.
                   10107: 250-
                   10108: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10109: 250-
1.75      rillig   10110: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10111: 250-
                   10112: 250-The official FIGlet web page is:
1.75      rillig   10113: 250-   http://www.figlet.org/
1.1       grant    10114: 250-
                   10115: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10116: 250-contribute a font or something else, you can email us.
1.68      rillig   10117: 250
1.1       grant    10118: 250 "/pub/figlet/program" is new cwd.
                   10119: 250 "/pub/figlet/program/unix" is new cwd.
                   10120: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10121: 502 Unimplemented command.
                   10122: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10123: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10124: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10125: 226 Transfer completed.
                   10126: 172219 bytes received in 00:02 (75.99 KB/s)
                   10127: 221 Goodbye.
                   10128: =&gt; Checksum OK for figlet221.tar.gz.
                   10129: ===&gt; Extracting for figlet-2.2.1nb2
                   10130: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10131: ===&gt; Patching for figlet-2.2.1nb2
                   10132: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10133: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10134: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10135: ===&gt; Configuring for figlet-2.2.1nb2
                   10136: ===&gt; Building for figlet-2.2.1nb2
                   10137: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10138: chmod a+x figlet
                   10139: gcc -O2 -o chkfont chkfont.c
                   10140: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10141: <code class="prompt">#</code>
1.75      rillig   10142: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10143: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10144: ===&gt; Installing for figlet-2.2.1nb2
                   10145: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10146: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10147: mkdir -p /usr/pkg/share/figlet
                   10148: cp figlet /usr/pkg/bin
                   10149: cp chkfont /usr/pkg/bin
                   10150: chmod 555 figlist showfigfonts
                   10151: cp figlist /usr/pkg/bin
                   10152: cp showfigfonts /usr/pkg/bin
                   10153: cp fonts/*.flf /usr/pkg/share/figlet
                   10154: cp fonts/*.flc /usr/pkg/share/figlet
                   10155: cp figlet.6 /usr/pkg/man/man6
                   10156: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10157: <code class="prompt">#</code></pre>
                   10158: </div>
1.148     asau     10159: <div class="sect1">
1.75      rillig   10160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10161: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10162: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10163: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10164: ===&gt; Packaging figlet-2.2.1nb2
                   10165: ===&gt; Building binary package for figlet-2.2.1nb2
                   10166: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10167: Using SrcDir value of /usr/pkg
1.68      rillig   10168: Registering depends:.
1.75      rillig   10169: <code class="prompt">#</code></pre>
                   10170: </div>
                   10171: </div>
1.148     asau     10172: <div class="appendix">
                   10173: <div class="titlepage"><div><div><h1 class="title">
                   10174: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   10175: <div class="toc">
                   10176: <p><b>Table of Contents</b></p>
1.210     leot     10177: <dl class="toc">
1.128     wiz      10178: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10179: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10180: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10181: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10182: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                   10183: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10184: source packages</a></span></dt>
                   10185: </dl>
                   10186: </div>
                   10187: <p>As in other big projects, the directory layout of pkgsrc
                   10188:        is quite complex for newbies. This chapter explains where you
                   10189:        find things on the FTP server. The base directory on
1.110     hubertf  10190:        <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   10191:        On other servers it may be different, but inside this directory,
                   10192:        everything should look the same, no matter on which server you
                   10193:        are. This directory contains some subdirectories, which are
                   10194:        explained below.</p>
1.148     asau     10195: <div class="sect1">
1.76      rillig   10196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10197: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   10198: <p>The directory <code class="filename">distfiles</code> contains lots
                   10199:        of archive files from all pkgsrc packages, which are mirrored
                   10200:        here. The subdirectories are called after their package names
                   10201:        and are used when the distributed files have names that don't
                   10202:        explicitly contain a version number or are otherwise too generic
                   10203:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10204: </div>
1.148     asau     10205: <div class="sect1">
1.76      rillig   10206: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10207: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   10208: <p>This directory contains things that individual pkgsrc
                   10209:        developers find worth publishing.</p>
                   10210: </div>
1.148     asau     10211: <div class="sect1">
1.76      rillig   10212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10213: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   10214: <p>This directory contains binary packages for the various
                   10215:        platforms that are supported by pkgsrc.
                   10216:        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     10217: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10218: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   10219:        operating system for which the packages have been built. The
1.110     hubertf  10220:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   10221:        command, so it may differ from the one you are used to
                   10222:        hear.</p></li>
1.128     wiz      10223: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   10224:        architecture of the platform for which the packages have been
1.110     hubertf  10225:        built. It also includes the <code class="varname">ABI</code> (Application
                   10226:        Binary Interface) for platforms that have several of
                   10227:        them.</p></li>
1.128     wiz      10228: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   10229:        the operating system. For version numbers that change often (for
                   10230:        example NetBSD-current), the often-changing part should be
                   10231:        replaced with an <code class="literal">x</code>, for example
                   10232:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      10233: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 10234:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   10235:        for a stable branch, or <code class="literal">head</code> for packages
                   10236:        built from the HEAD branch. The latter should only be used when
                   10237:        the packages are updated on a regular basis. Otherwise the date
                   10238:        from checking out pkgsrc should be appended, for example
                   10239:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   10240: </ul></div>
                   10241: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10242:        can quickly click through the directories on the
                   10243:        server and find the best binary packages for their machines. Since they
                   10244:        usually know the operating system and the hardware architecture, OPSYS
                   10245:        and ARCH are placed first. After these choices, they can select the
                   10246:        best combination of OSVERSION and TAG together, since it is usually the
                   10247:        case that packages stay compatible between different version of the
                   10248:        operating system.</p>
                   10249: <p>In each of these directories, there is a
                   10250:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   10251:        <code class="filename">All</code> which contains all binary packages.
                   10252:        Besides that, there are various category directories that
                   10253:        contain symbolic links to the real binary packages.</p>
                   10254: </div>
1.148     asau     10255: <div class="sect1">
1.76      rillig   10256: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10257: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   10258: <p>Here are the reports from bulk builds, for those who want
                   10259:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      10260:        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   10261: </div>
1.148     asau     10262: <div class="sect1">
1.108     rillig   10263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10264: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
                   10265: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10266: source packages</h2></div></div></div>
1.128     wiz      10267: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   10268:        that is the files that define how to create binary packages from
                   10269:        source archives.</p>
                   10270: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10271:        snapshot of the CVS repository, which is updated regularly. The
                   10272:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10273:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   10274: <p>In the directories for the quarterly branches, there is an
                   10275:        additional file called
1.126     jakllsch 10276:        <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   10277:        which contains the state of pkgsrc when it was branched.</p>
                   10278: </div>
1.75      rillig   10279: </div>
1.148     asau     10280: <div class="appendix">
                   10281: <div class="titlepage"><div><div><h1 class="title">
                   10282: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   10283: <div class="toc">
                   10284: <p><b>Table of Contents</b></p>
1.210     leot     10285: <dl class="toc">
1.79      rillig   10286: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   10287: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10288: </dl>
                   10289: </div>
1.79      rillig   10290: <p>This section contains information on editing the pkgsrc
                   10291:        guide itself.</p>
1.148     asau     10292: <div class="sect1">
1.75      rillig   10293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   10294: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10295: <p>The pkgsrc guide's source code is stored in
                   10296:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10297:        are created from it:</p>
1.148     asau     10298: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10299: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   10300: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   10301: <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>
                   10302: <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   10303:        The PDF version of the pkgsrc guide.</p></li>
1.128     wiz      10304: <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   10305:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   10306: </ul></div>
                   10307: </div>
1.148     asau     10308: <div class="sect1">
1.75      rillig   10309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10310: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   10311: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      10312: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     10313: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      10314:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   10315:        documentation) installed. These are automatically installed when
1.189     snj      10316:        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     10317: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   10318:        right directory. All further steps will take place
                   10319:        here.</p></li>
1.148     asau     10320: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   10321:        <code class="filename">files/</code>.</p></li>
1.148     asau     10322: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   10323:        guide for valid XML and to build the final output files. If you
                   10324:        get any errors at this stage, you can just edit the files, as
                   10325:        there are only symbolic links in the working directory, pointing
                   10326:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     10327: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   10328:        commit)</strong></span></p></li>
1.148     asau     10329: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   10330:        regenerate the output files with the proper RCS
                   10331:        Ids.</p></li>
1.148     asau     10332: <li class="step">
1.110     hubertf  10333: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   10334:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   10335:        <code class="filename">htdocs</code>.</p>
1.148     asau     10336: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   10337: <h3 class="title">Note</h3>
                   10338: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  10339:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   10340:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   10341:        directory.</p>
                   10342: </div>
                   10343: </li>
1.79      rillig   10344: </ol></div>
1.75      rillig   10345: </div>
                   10346: </div>
                   10347: </div></body>
1.1       grant    10348: </html>

CVSweb <webmaster@jp.NetBSD.org>