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

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.233     sevan     163: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 &amp; KDE4 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.232     sevan     491: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75      rillig    492:          web server</p></li>
1.232     sevan     493: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    494:          web browser</p></li>
1.232     sevan     495: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    496:          Desktop Environment</p></li>
1.232     sevan     497: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.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.232     sevan     545: find such bugs: Static analysis tools (<a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.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.236   ! wiz       716:            <code class="filename">/usr/pkgsrc</code>,
        !           717:            but may be stored in any location,
        !           718:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75      rillig    719: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       720: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       721:          is part of the NetBSD operating system and can be bootstrapped
                    722:          to run on non-NetBSD operating systems as well.  It handles
                    723:          building (compiling), installing, and removing of
                    724:          packages.</p></dd>
1.75      rillig    725: <dt><span class="term">Distfile</span></dt>
                    726: <dd><p>This term describes the file or files that are
                    727:            provided by the author of the piece of software to
                    728:            distribute his work. All the changes necessary to build on
                    729:            NetBSD are reflected in the corresponding package. Usually
                    730:            the distfile is in the form of a compressed tar-archive,
                    731:            but other types are possible, too. Distfiles are usually
                    732:            stored below
1.76      rillig    733:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    734: <dt><span class="term">Port</span></dt>
                    735: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    736:            for what we call a package.
1.128     wiz       737:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    738:            architecture.</p></dd>
                    739: <dt><span class="term">Precompiled/binary package</span></dt>
                    740: <dd>
                    741: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    742:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    743:            file so it can be installed on machines of the same
                    744:            machine architecture without the need to
                    745:            recompile. Packages are usually generated in
1.76      rillig    746:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       747:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       748: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    749:            especially in the context of precompiled packages.</p>
                    750: </dd>
                    751: <dt><span class="term">Program</span></dt>
1.88      wiz       752: <dd><p>The piece of software to be installed which will be
                    753:          constructed from all the files in the distfile by the
                    754:          actions defined in the corresponding package.</p></dd>
1.75      rillig    755: </dl></div>
1.148     asau      756: <div class="sect2">
1.75      rillig    757: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       758: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      759: <div class="variablelist"><dl class="variablelist">
1.75      rillig    760: <dt><span class="term">pkgsrc users</span></dt>
                    761: <dd>
                    762: <p>The
                    763:        pkgsrc users are people who use the packages provided by pkgsrc.
                    764:        Typically they are system administrators. The people using the
1.128     wiz       765:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    766:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    767: <p>There are two kinds of pkgsrc users: Some only want to
                    768:        install pre-built binary packages. Others build the pkgsrc
                    769:        packages from source, either for installing them directly or for
1.110     hubertf   770:        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    771:        documentation.</p>
                    772: </dd>
                    773: <dt><span class="term">package maintainers</span></dt>
                    774: <dd><p>A
1.110     hubertf   775:        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    776: <dt><span class="term">infrastructure developers</span></dt>
                    777: <dd><p>These people are involved in all those files
1.76      rillig    778:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   779:        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    780:        too.</p></dd>
                    781: </dl></div>
                    782: </div>
                    783: </div>
1.148     asau      784: <div class="sect1">
1.75      rillig    785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    786: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    787: <p>When giving examples for commands, shell prompts are used to
                    788:       show if the command should/can be issued as root, or if
1.128     wiz       789:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.226     sevan     790:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    791:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    792:       bourne shell and derivatives.</p>
1.75      rillig    793: </div>
                    794: </div>
1.148     asau      795: <div class="part">
1.75      rillig    796: <div class="titlepage"><div><div><h1 class="title">
                    797: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    798: <div class="toc">
                    799: <p><b>Table of Contents</b></p>
1.210     leot      800: <dl class="toc">
1.75      rillig    801: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    802: <dd><dl>
                    803: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    804: <dd><dl>
1.157     asau      805: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       806: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    807: </dl></dd>
                    808: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    809: <dd><dl>
                    810: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    811: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    812: </dl></dd>
                    813: </dl></dd>
                    814: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    815: <dd><dl>
1.82      rillig    816: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    817: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    818: </dl></dd>
                    819: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    820: <dd><dl>
                    821: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    822: <dd><dl>
                    823: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    824: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    825: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    826: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    827: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    828: <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>
                    829: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75      rillig    830: </dl></dd>
                    831: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    832: <dd><dl>
                    833: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    834: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    835: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    836: </dl></dd>
                    837: </dl></dd>
                    838: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    839: <dd><dl>
                    840: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    841: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    842: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       843: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       844: <dd><dl>
1.103     wiz       845: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz       846: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    847: <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       848: </dl></dd>
1.103     wiz       849: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    850: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    851: </dl></dd>
                    852: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    853: <dd><dl>
                    854: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    855: <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    856: </dl></dd>
                    857: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    858: builds)</a></span></dt>
1.75      rillig    859: <dd><dl>
1.180     wiz       860: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                    861: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                    862: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                    863: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau      864: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    865: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig    866: </dl></dd>
                    867: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    868: <dd><dl>
1.128     wiz       869: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    870: <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    871: </dl></dd>
                    872: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    873: <dd><dl>
                    874: <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  875: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                    876: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                    877: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    878: <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>
                    879: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                    880: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                    881: <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>
                    882: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    883: <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       884: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert  885: <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>
                    886: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    887: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    888: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    889: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    890: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    891: <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    892: </dl></dd>
                    893: </dl>
                    894: </div>
1.148     asau      895: <div class="chapter">
1.75      rillig    896: <div class="titlepage"><div><div><h2 class="title">
                    897: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    898: <div class="toc">
                    899: <p><b>Table of Contents</b></p>
1.210     leot      900: <dl class="toc">
1.75      rillig    901: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    902: <dd><dl>
1.157     asau      903: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       904: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    905: </dl></dd>
                    906: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    907: <dd><dl>
                    908: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    909: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    910: </dl></dd>
                    911: </dl>
                    912: </div>
1.91      rillig    913: <p>Before you download and extract the files, you need to decide
                    914: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    915: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    916: free to install the sources and binary packages wherever you want in
                    917: your filesystem, provided that the pathname does not contain white-space
                    918: or other characters that are interpreted specially by the shell and some
                    919: other programs. A safe bet is to use only letters, digits, underscores
                    920: and dashes.</p>
1.148     asau      921: <div class="sect1">
1.75      rillig    922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    923: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    924: <p>Before you download any pkgsrc files, you should decide
                    925:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    926:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    927:        quarterly basis from the current branch and only gets modified
                    928:        for security updates. The names of the stable branches are built
                    929:        from the year and the quarter, for example
1.230     sevan     930:        <code class="literal">2016Q4</code>.</p>
1.75      rillig    931: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz       932:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    933:        Both ways are described here.</p>
1.157     asau      934: <p>Note that tar archive contains CVS working copy.
                    935:        Thus you can switch to using CVS at any later time.</p>
1.148     asau      936: <div class="sect2">
1.75      rillig    937: <div class="titlepage"><div><div><h3 class="title">
1.157     asau      938: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75      rillig    939: <p>The primary download location for all pkgsrc files is
1.157     asau      940:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
                    941:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    942:        (it points to the same location).
                    943:        There are a number of subdirectories for different purposes,
                    944:        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>
                    945: <p>The tar archive for the current branch is in the directory
                    946:        <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     947:        It is autogenerated weekly.</p>
1.157     asau      948: <p>To save download time we provide bzip2- and
                    949:        xz-compressed archives which are published at
                    950:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
                    951:        and
                    952:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
                    953:        respectively.
                    954:        </p>
                    955: <p>You can fetch the same files using FTP.</p>
1.230     sevan     956: <p>The tar file for the stable branch 2016Q4 is in the
                    957:        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    958: <p>To download a pkgsrc stable tarball, run:</p>
                    959: <pre class="screen">
1.166     jnemeth   960: <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  961: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112     weinem    962:        stable branch to be downloaded, for example, 
1.230     sevan     963:        <span class="quote">&#8220;<span class="quote">pkgsrc-2016Q4</span>&#8221;</span>.</p>
1.188     snj       964: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau      965:        or your web browser.</p>
1.112     weinem    966: <p>Then, extract it with:</p>
1.188     snj       967: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem    968: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    969:        in <code class="filename">/usr/</code> and all the package source will be 
                    970:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    971: <p>To download pkgsrc-current, run:</p>
                    972: <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    973: </div>
1.148     asau      974: <div class="sect2">
1.75      rillig    975: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz       976: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                    977: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146     wiz       978: <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       979: </pre>
                    980: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
1.230     sevan     981:        branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2016Q4</span>&#8221;</span></p>
1.128     wiz       982: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                    983:        in your <code class="filename">/usr/</code> directory and all the package source 
                    984:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    985: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz       986: <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     987: </pre>
1.188     snj       988: <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       989: <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       990: <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       991: </pre>
                    992: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                    993:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                    994:        or better globally in <code class="filename">/etc/profile</code>:</p>
                    995: <pre class="programlisting">
                    996: # set CVS remote shell command
                    997: CVS_RSH=ssh
                    998: export CVS_RSH
                    999: </pre>
                   1000: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1001:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1002:        in your home directory and saving the following lines to it.
                   1003:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1004:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1005: <pre class="programlisting">
                   1006: # recommended CVS configuration file from the pkgsrc guide
1.146     wiz      1007: cvs -q -z2
1.101     rillig   1008: checkout -P
1.103     wiz      1009: update -dP
                   1010: diff -upN
1.101     rillig   1011: rdiff -u
1.128     wiz      1012: release -d
1.101     rillig   1013: </pre>
1.75      rillig   1014: </div>
                   1015: </div>
1.148     asau     1016: <div class="sect1">
1.75      rillig   1017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1018: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1019: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1020:        (which also works if you have first installed it via a tar
                   1021:        file). It saves bandwidth and hard disk activity, compared to
                   1022:        downloading the tar file again.</p>
1.148     asau     1023: <div class="sect2">
1.75      rillig   1024: <div class="titlepage"><div><div><h3 class="title">
                   1025: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148     asau     1026: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1027: <h3 class="title">Warning</h3>
1.77      rillig   1028: <p>When updating from a tar file, you first need to
                   1029:        completely remove the old pkgsrc directory. Otherwise those
                   1030:        files that have been removed from pkgsrc in the mean time will
                   1031:        not be removed on your local disk, resulting in inconsistencies.
                   1032:        When removing the old files, any changes that you have done to
                   1033:        the pkgsrc files will be lost after updating. Therefore updating
                   1034:        via CVS is strongly recommended.</p>
1.75      rillig   1035: </div>
1.82      rillig   1036: <p>Note that by default the distfiles and the binary packages
                   1037:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1038:        before updating. You can also configure pkgsrc to store distfiles
                   1039:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1040:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1041:        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   1042: <p>To update pkgsrc from a tar file, download the tar file as
                   1043:        explained above. Then, make sure that you have not made any
                   1044:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1045:        directory and extract the new tar file. Done.</p>
                   1046: </div>
1.148     asau     1047: <div class="sect2">
1.75      rillig   1048: <div class="titlepage"><div><div><h3 class="title">
                   1049: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132     spz      1050: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1051: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1052: </pre>
                   1053: <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>
                   1054: <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>
                   1055: </pre>
1.148     asau     1056: <div class="sect3">
1.75      rillig   1057: <div class="titlepage"><div><div><h4 class="title">
                   1058: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1059: <p>When updating pkgsrc, the CVS program keeps track of the
                   1060:        branch you selected. But if you, for whatever reason, want to
                   1061:        switch from the stable branch to the current one, you can do it
1.128     wiz      1062:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1063:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1064:        back to the stable branch, add the
1.230     sevan    1065:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2016Q4</span>&#8221;</span> option.</p>
1.75      rillig   1066: </div>
1.148     asau     1067: <div class="sect3">
1.75      rillig   1068: <div class="titlepage"><div><div><h4 class="title">
                   1069: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1070: <p>When you update pkgsrc, the CVS program will only touch
                   1071:        those files that are registered in the CVS repository. That
                   1072:        means that any packages that you created on your own will stay
                   1073:        unmodified. If you change files that are managed by CVS, later
                   1074:        updates will try to merge your changes with those that have been
                   1075:        done by others. See the CVS manual, chapter
1.128     wiz      1076:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1077: </div>
                   1078: </div>
                   1079: </div>
                   1080: </div>
1.148     asau     1081: <div class="chapter">
1.75      rillig   1082: <div class="titlepage"><div><div><h2 class="title">
                   1083: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1084: <div class="toc">
                   1085: <p><b>Table of Contents</b></p>
1.210     leot     1086: <dl class="toc">
1.82      rillig   1087: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1088: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1089: </dl>
                   1090: </div>
1.148     asau     1091: <div class="sect1">
1.75      rillig   1092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1093: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1094: <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   1095: </div>
1.148     asau     1096: <div class="sect1">
1.82      rillig   1097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1098: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1099: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1100:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1101:     to privileged one all programs are installed under one particular user
1.149     asau     1102:     and cannot utilise privileged operations (packages don't create
                   1103:     special users and all special file permissions like setuid are ignored).
                   1104:     </p>
1.82      rillig   1105: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1106: <pre class="screen">
1.167     asau     1107: <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   1108: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1109: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1110:     </pre>
1.149     asau     1111: <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>
                   1112: <p>By default, in privileged mode pkgsrc uses
                   1113:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1114:     where programs will be installed in,
1.230     sevan    1115:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1116:     directory where pkgsrc will do its internal bookkeeping,
                   1117:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1118:     where packages install their persistent data.
                   1119:     In unprivileged mode pkgsrc uses
                   1120:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1121:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1122:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1123:     </p>
                   1124: <p>You can change default layout using command-line arguments.
                   1125:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1126:     </p>
1.148     asau     1127: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1128: <h3 class="title">Note</h3>
1.110     hubertf  1129: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1130:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1131:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1132:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1133: </div>
1.149     asau     1134: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1135: <h3 class="title">Note</h3>
                   1136: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1137:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1138:       corresponding to the installation you're working with to build
                   1139:       and install packages.
                   1140:       </p>
                   1141: </div>
1.75      rillig   1142: </div>
                   1143: </div>
1.148     asau     1144: <div class="chapter">
1.75      rillig   1145: <div class="titlepage"><div><div><h2 class="title">
                   1146: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1147: <div class="toc">
                   1148: <p><b>Table of Contents</b></p>
1.210     leot     1149: <dl class="toc">
1.75      rillig   1150: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1151: <dd><dl>
                   1152: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1153: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1154: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1155: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1156: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1157: <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>
                   1158: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75      rillig   1159: </dl></dd>
                   1160: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1161: <dd><dl>
                   1162: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1163: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1164: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1165: </dl></dd>
                   1166: </dl>
                   1167: </div>
                   1168: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1169: is to only install the package tools and to use binary packages
1.128     wiz      1170: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1171: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1172: of pkgsrc, too. Then you are able to build your own packages,
                   1173: and you can still use binary packages from someone else.</p>
1.148     asau     1174: <div class="sect1">
1.75      rillig   1175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1176: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1177: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1178:   server and its mirrors, there are collections of binary packages,
                   1179:   ready to be installed. These binary packages have been built using the
                   1180:   default settings for the directories, that is:</p>
1.148     asau     1181: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1182: <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>
                   1183: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1184: <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   1185: </ul></div>
                   1186: <p>If you cannot use these directories for whatever reasons (maybe
                   1187:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1188:   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     1189: <div class="sect2">
1.75      rillig   1190: <div class="titlepage"><div><div><h3 class="title">
                   1191: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1192: <p>To install binary packages, you first need to know from where
                   1193:     to get them. The first place where you should look is on the main
1.110     hubertf  1194:     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   1195: <p>This directory contains binary packages for multiple
                   1196:     platforms. First, select your operating system. (Ignore the
                   1197:     directories with version numbers attached to it, they just exist for
                   1198:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1199:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1200: <p>In this directory, you often find a file called
                   1201:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1202:     management tools. If the file is missing, it is likely that your
                   1203:     operating system already provides those tools. Download the file and
                   1204:     extract it in the <code class="filename">/</code> directory. It will create
                   1205:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1206:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1207: </div>
1.148     asau     1208: <div class="sect2">
1.75      rillig   1209: <div class="titlepage"><div><div><h3 class="title">
                   1210: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1211: <p>In the directory from the last section, there is a
1.196     wiz      1212:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1213:     binary packages that are available for the platform, excluding those
                   1214:     that may not be distributed via FTP or CDROM (depending on which
1.128     wiz      1215:     medium you are using).</p>
1.109     rillig   1216: <p>To install packages directly from an FTP or HTTP server, run
                   1217:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1218:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1219: <pre class="screen">
                   1220: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.196     wiz      1221: <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   1222: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1223: </pre>
                   1224: <p>Instead of URLs, you can also use local paths, for example if
                   1225:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1226:     repository. If you want to install packages from multiple sources,
                   1227:     you can separate them by a semicolon in
                   1228:     <code class="varname">PKG_PATH</code>.</p>
                   1229: <p>After these preparations, installing a package is very
                   1230:     easy:</p>
                   1231: <pre class="screen">
1.230     sevan    1232: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1.109     rillig   1233: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1.230     sevan    1234: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.109     rillig   1235: </pre>
1.75      rillig   1236: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1237:     package in question will be installed, too, assuming they are
                   1238:     present where you install from.</p>
1.128     wiz      1239: <p>Adding packages might install vulnerable packages.
                   1240:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
                   1241:     regularly, especially after installing new packages, and verify
                   1242:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1243: <p>After you've installed packages, be sure to have
1.88      wiz      1244:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1245:     <code class="varname">PATH</code> so you can actually start the just
                   1246:     installed program.</p>
1.75      rillig   1247: </div>
1.148     asau     1248: <div class="sect2">
1.75      rillig   1249: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1250: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1251: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1252:     installed from source code or from a binary package. The
1.110     hubertf  1253:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1254:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1255:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1256:     name can be given with or without version number. Wildcards can
                   1257:     also be used to deinstall a set of packages, for example
                   1258:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1259:     so that the shell does not expand them before
                   1260:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1261: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1262:     removes all the packages that require the package in question
                   1263:     and then removes the package itself. For example:
1.82      rillig   1264: 
1.88      wiz      1265:     </p>
1.82      rillig   1266: <pre class="screen">
1.88      wiz      1267: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1268:     </pre>
1.82      rillig   1269: <p>
                   1270: 
1.88      wiz      1271:     will remove jpeg and all the packages that used it; this allows
                   1272:     upgrading the jpeg package.</p>
1.82      rillig   1273: </div>
1.148     asau     1274: <div class="sect2">
1.82      rillig   1275: <div class="titlepage"><div><div><h3 class="title">
                   1276: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1277: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1278:     installed packages or binary package files.</p>
1.82      rillig   1279: </div>
1.148     asau     1280: <div class="sect2">
1.82      rillig   1281: <div class="titlepage"><div><div><h3 class="title">
                   1282: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1283: <p>
1.88      wiz      1284:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1285:       known security vulnerabilities to packages which are (or have been)
                   1286:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1287:       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      1288:     </p>
1.82      rillig   1289: <p>
1.125     wiz      1290:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1291:       this list can be downloaded
                   1292:       automatically, and a security audit of all packages installed on a system
                   1293:       can take place.
                   1294:     </p>
1.82      rillig   1295: <p>
1.125     wiz      1296:       There are two components to auditing.  The first
                   1297:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1298:       is for downloading
1.88      wiz      1299:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1300:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1301:       installed packages are vulnerable.  If a package is vulnerable, you
                   1302:       will see output similar to the following:
                   1303:     </p>
1.82      rillig   1304: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1305:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1306: <p>
1.125     wiz      1307:       You may wish to have the
1.110     hubertf  1308:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1309:       file downloaded daily so that
                   1310:       it remains current.  This may be done by adding an appropriate entry
1.232     sevan    1311:       to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1312:       </p>
                   1313: <pre class="screen">
1.233     sevan    1314: # Download vulnerabilities file
1.230     sevan    1315: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1316: # Audit the installed packages and email results to root
                   1317: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1318:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1319:       </pre>
                   1320: <p>
1.230     sevan    1321:       will update the vulnerability list every day at 3AM, followed by an audit
                   1322:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1323: 
1.230     sevan    1324:       On NetBSD this may be accomplished instead by adding the following
                   1325:       line to <code class="filename">/etc/daily.conf</code>:
                   1326:       </p>
                   1327: <pre class="screen">
                   1328: fetch_pkg_vulnerabilities=YES
                   1329:       </pre>
                   1330: <p>
                   1331:       to fetch the vulnerability list from the daily security script. The system
                   1332:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1333:       desired (not required), by adding the following line to
1.230     sevan    1334: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1335:       </p>
                   1336: <pre class="screen">
1.230     sevan    1337: check_pkg_vulnerabilities=YES
1.125     wiz      1338:       </pre>
                   1339: <p>
1.232     sevan    1340:       see <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1341:     </p>
1.82      rillig   1342: </div>
1.148     asau     1343: <div class="sect2">
1.82      rillig   1344: <div class="titlepage"><div><div><h3 class="title">
                   1345: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1346: <p>
1.232     sevan    1347:       Install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128     wiz      1348:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.88      wiz      1349:       argument to check if your packages are up-to-date, e.g.
                   1350:     </p>
                   1351: <pre class="screen">
                   1352: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1353: ...
1.88      wiz      1354: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1355:     </pre>
1.110     hubertf  1356: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1357:     package on your system and rebuild any dependencies.
                   1358:     </p>
1.82      rillig   1359: </div>
1.148     asau     1360: <div class="sect2">
1.82      rillig   1361: <div class="titlepage"><div><div><h3 class="title">
                   1362: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1363: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1364:     administrative functions on the package system.</p>
1.82      rillig   1365: </div>
1.75      rillig   1366: </div>
1.148     asau     1367: <div class="sect1">
1.75      rillig   1368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1369: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1370: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1371:   directory now contains a set of packages, organized into
                   1372:   categories. You can browse the online index of packages, or run
1.110     hubertf  1373:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1374:   directory to build local <code class="filename">README.html</code> files for
1.232     sevan    1375:   all packages, viewable with any web browser such as <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1376: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1377:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1378:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1379:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1380:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1381:   system (inside a chroot is an exception). </p>
                   1382: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1383:   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      1384:   instructions how to create your own packages.</p>
1.148     asau     1385: <div class="sect2">
1.75      rillig   1386: <div class="titlepage"><div><div><h3 class="title">
                   1387: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1388: <p>To build packages from source, you need a working C
1.88      wiz      1389:     compiler. On NetBSD, you need to install the
1.128     wiz      1390:     <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      1391:     sets. If you want to build X11-related packages, the
1.128     wiz      1392:     <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      1393:     sets are required, too.</p>
1.75      rillig   1394: </div>
1.148     asau     1395: <div class="sect2">
1.75      rillig   1396: <div class="titlepage"><div><div><h3 class="title">
                   1397: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1398: <p>The first step for building a package is downloading the
1.88      wiz      1399:     distfiles (i.e. the unmodified source). If they have not yet been
                   1400:     downloaded, pkgsrc will fetch them automatically.</p>
                   1401: <p>If you have all files that you need in the
                   1402:     <code class="filename">distfiles</code> directory,
                   1403:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1404:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1405:     </p>
1.82      rillig   1406: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1407: <p>
1.110     hubertf  1408:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1409: <p>By default a list of distribution sites will be randomly
                   1410:     intermixed to prevent huge load on servers which holding popular
                   1411:     packages (for example, SourceForge.net mirrors). Thus, every
                   1412:     time when you need to fetch yet another distfile all the mirrors
                   1413:     will be tried in new (random) order. You can turn this feature
                   1414:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1415:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1416: <p>You can overwrite some of the major distribution sites to
                   1417:     fit to sites that are close to your own.  By setting one or two
                   1418:     variables you can modify the order in which the master sites are
                   1419:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1420:     delimited list of domain suffixes.
                   1421:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1422:     contains a whitespace delimited list of regular expressions.  It
                   1423:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1424:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1425:     some examples.  This may save some of your bandwidth and
                   1426:     time.</p>
1.75      rillig   1427: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1428:     if you want to keep the settings, by editing the
1.110     hubertf  1429:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1430:     and adding the definitions there.</p>
1.82      rillig   1431: <p>
1.88      wiz      1432:       If a package depends on many other packages (such as
1.232     sevan    1433:       <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.88      wiz      1434:       alternate between periods of
                   1435:       downloading source, and compiling. To ensure you have all the source
                   1436:       downloaded initially you can run the command:
                   1437:       </p>
1.82      rillig   1438: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1439: <p>
1.88      wiz      1440:       which will output and run a set of shell commands to fetch the
                   1441:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1442:       also choose to download the files manually.
                   1443:     </p>
1.75      rillig   1444: </div>
1.148     asau     1445: <div class="sect2">
1.75      rillig   1446: <div class="titlepage"><div><div><h3 class="title">
                   1447: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1448: <p>
1.88      wiz      1449:       Once the software has downloaded, any patches will be applied, then it
                   1450:       will be compiled for you. This may take some time depending on your
                   1451:       computer, and how many other packages the software depends on and their
                   1452:       compile time.
                   1453:     </p>
1.148     asau     1454: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1455: <h3 class="title">Note</h3>
                   1456: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1457:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1458:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1459: </div>
1.87      wiz      1460: <p>For example, type</p>
1.88      wiz      1461: <pre class="screen">
                   1462: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1463: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1464:     </pre>
1.75      rillig   1465: <p>at the shell prompt to build the various components of the
1.88      wiz      1466:     package.</p>
1.82      rillig   1467: <p>The next stage is to actually install the newly compiled
1.88      wiz      1468:     program onto your system. Do this by entering:
1.82      rillig   1469: 
1.88      wiz      1470:     </p>
1.82      rillig   1471: <pre class="screen">
1.88      wiz      1472: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1473:     </pre>
1.82      rillig   1474: <p>
                   1475: 
1.88      wiz      1476:     while you are still in the directory for whatever package you
                   1477:     are installing.</p>
1.82      rillig   1478: <p>Installing the package on your system may require you to
1.88      wiz      1479:     be root.  However, pkgsrc has a
                   1480:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1481:     to only become root for the actual installation step.</p>
1.82      rillig   1482: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1483:     You can now enter:
1.82      rillig   1484: 
1.88      wiz      1485:     </p>
1.82      rillig   1486: <pre class="screen">
1.88      wiz      1487: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1488:     </pre>
1.82      rillig   1489: <p>
                   1490: 
1.88      wiz      1491:     to remove the compiled files in the work directory, as you shouldn't need
                   1492:     them any more. If other packages were also added to your system
                   1493:     (dependencies) to allow your program to compile, you can tidy these up
                   1494:     also with the command:</p>
1.82      rillig   1495: <pre class="screen">
1.88      wiz      1496: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1497:     </pre>
1.75      rillig   1498: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  1499:     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      1500: <p>The program is installed under the default root of the
                   1501:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1502:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1503:     variable in your environment, and it will use that value as the
                   1504:     root of your packages tree. So, to use
                   1505:     <code class="filename">/usr/local</code>, set
                   1506:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1507:     Please note that you should use a directory which is dedicated to
                   1508:     packages and not shared with other programs (i.e., do not try and
                   1509:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1510:     to add any of your own files or directories (such as
                   1511:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1512:     <code class="filename">pkgsrc/</code>) below the
                   1513:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1514:     conflicts between programs and other files installed by the
                   1515:     package system and whatever else may have been installed
                   1516:     there.</p>
1.110     hubertf  1517: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1518:     alter some configuration options at build time.  Have a look at
                   1519:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1520:     of what will be set there by default.  Environment variables such
                   1521:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1522:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1523:     set them each time you want to use pkgsrc.</p>
1.128     wiz      1524: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1525:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      1526:     or being installed. This may be for debugging purposes, or out of
                   1527:     simple curiosity. A number of utility values have been added to
                   1528:     help with this.</p>
1.128     wiz      1529: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1530: <li class="listitem">
1.232     sevan    1531: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      1532:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1533:        information will be displayed. For example,</p>
1.75      rillig   1534: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1535: <p>will show all the commands that are invoked, up to and
1.128     wiz      1536:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   1537: </li>
1.128     wiz      1538: <li class="listitem">
1.232     sevan    1539: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1540:        definition, then the <code class="varname">VARNAME</code> definition
                   1541:        should be used, in conjunction with the show-var
1.232     sevan    1542:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1543:        variable <code class="varname">LOCALBASE</code>:</p>
                   1544: <pre class="screen">
                   1545: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1546: /usr/pkg
                   1547: <code class="prompt">%</code>
1.88      wiz      1548:        </pre>
1.75      rillig   1549: </li>
                   1550: </ol></div>
                   1551: <p>If you want to install a binary package that you've either
1.88      wiz      1552:     created yourself (see next section), that you put into
                   1553:     pkgsrc/packages manually or that is located on a remote FTP
                   1554:     server, you can use the "bin-install" target. This target will
1.232     sevan    1555:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  1556:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1557:     sites searched is kept in the variable
                   1558:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.232     sevan    1559:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      1560:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1561:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1562:     details.</p>
                   1563: <p>A final word of warning: If you set up a system that has a
                   1564:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1565:     set that before any packages are installed, as you cannot use
                   1566:     several directories for the same purpose. Doing so will result in
                   1567:     pkgsrc not being able to properly detect your installed packages,
                   1568:     and fail miserably. Note also that precompiled binary packages are
                   1569:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1570:     <code class="filename">/usr/pkg</code>, and that you should
                   1571:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1572:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1573: </div>
                   1574: </div>
                   1575: </div>
1.148     asau     1576: <div class="chapter">
1.75      rillig   1577: <div class="titlepage"><div><div><h2 class="title">
                   1578: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   1579: <div class="toc">
                   1580: <p><b>Table of Contents</b></p>
1.210     leot     1581: <dl class="toc">
1.75      rillig   1582: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   1583: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   1584: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      1585: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      1586: <dd><dl>
1.103     wiz      1587: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz      1588: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1589: <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      1590: </dl></dd>
1.103     wiz      1591: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   1592: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   1593: </dl>
                   1594: </div>
1.104     rillig   1595: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1596: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1597: that file depends on the installation. On NetBSD, when you use
1.232     sevan    1598: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   1599: <code class="filename">/etc/</code>. In all other cases the default location is
                   1600: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1601: bootstrap program to install the binary packages.</p>
                   1602: <p>The format of the configuration file is that of the usual
                   1603: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1604: is done by setting variables in this file. Note that you can define all
                   1605: kinds of variables, and no special error checking (for example for
1.223     rillig   1606: spelling mistakes) takes place.</p>
1.148     asau     1607: <div class="sect1">
1.75      rillig   1608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1609: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.223     rillig   1610: <p>The following variables apply to all
1.89      rillig   1611:     pkgsrc packages. A complete list of the variables that can be
                   1612:     configured by the user is available in
                   1613:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1614:     comments that describe each variable's intent.</p>
1.148     asau     1615: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1616: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1617:            packages will be installed. The default is
1.76      rillig   1618:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1619:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1620: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1621:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   1622:            installed. The default is
1.76      rillig   1623:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1624: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1625:            X11 is installed on the system. The default is
1.194     bsiegert 1626:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1627: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1628:            downloaded copies of the original source distributions used
                   1629:            for building pkgsrc packages. The default is
1.76      rillig   1630:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1631: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1632:            database about installed packages is stored.  The default is
1.230     sevan    1633:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1634: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1635:            If set, override the packages'
                   1636:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1637: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1638:            Backup location(s) for distribution files and patch files
                   1639:            if not found locally or in
1.76      rillig   1640:            <code class="filename">${MASTER_SITES}</code> or
                   1641:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1642:            The defaults is
                   1643:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1644: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1645:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1646:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      1647:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1648:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1649: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1650:            List of acceptable licenses. License names are case-sensitive.
                   1651:            Whenever you try to build a package whose license is not in this
                   1652:            list, you will get an error message. If the license condition is
                   1653:            simple enough, the error message will include specific
                   1654:            instructions on how to change this variable.</p></li>
1.75      rillig   1655: </ul></div>
                   1656: </div>
1.148     asau     1657: <div class="sect1">
1.75      rillig   1658: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1659: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1660: <p>
1.75      rillig   1661:       </p>
1.148     asau     1662: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1663: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1664:            directory for the binary packages. The default is
1.76      rillig   1665:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1666: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1667:            The top level directory where, if defined, the separate
                   1668:            working directories will get created, and symbolically
1.76      rillig   1669:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1670:            This is useful for building packages on several
1.76      rillig   1671:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1672:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1673:            is local to every architecture. (It should be noted that
                   1674:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1675:            &mdash; it is an internal definition which refers to the
1.75      rillig   1676:            root of the pkgsrc tree. It is possible to have many
                   1677:            pkgsrc tree instances.)</p></li>
1.128     wiz      1678: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1679:            Directory for local patches that aren't part of pkgsrc.
1.219     rillig   1680:            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   1681:            information.</p></li>
1.128     wiz      1682: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1683:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1684:            BSD-style Makefile. If this is not set,
                   1685:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1686:            <code class="filename">/dev/null</code> to avoid picking up
                   1687:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128     wiz      1688: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82      rillig   1689:            By default, dependencies are only installed, and no binary
                   1690:            package is created for them. You can set this variable to
1.174     asau     1691:            <code class="literal">package-install</code> to automatically create binary
1.190     wiz      1692:            packages after installing dependencies. Please note that the
1.194     bsiegert 1693:            <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.190     wiz      1694:            <code class="literal">yes</code> to preserve binary packages when
                   1695:            using the <code class="literal">install</code> as well.</p></li>
1.75      rillig   1696: </ul></div>
                   1697: </div>
1.148     asau     1698: <div class="sect1">
1.75      rillig   1699: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   1700: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.217     jnemeth  1701: <p>Packages have to support installation into a
1.103     wiz      1702:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1703:     to be built, before the actual filesystem is touched. DESTDIR
                   1704:     support exists in two variations:</p>
1.148     asau     1705: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1706: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1707:       installation and packaging is still run as root.</p></li>
                   1708: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1709:       build, installation and packaging as normal user. Root
                   1710:       privileges are only needed to add packages.</p></li>
                   1711: </ul></div>
1.103     wiz      1712: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1713:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1714: <p>Considering the <code class="filename">foo/bar</code> package,
                   1715:     DESTDIR full support can be tested using the following commands
                   1716: 
                   1717: </p>
                   1718: <pre class="programlisting">
                   1719: <code class="prompt">$</code> id
                   1720: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1721: <code class="prompt">$</code> mkdir $HOME/packages
                   1722: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1723: </pre>
                   1724: <p>
                   1725: 
                   1726:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1727:     should be needed
                   1728: 
                   1729: </p>
                   1730: <pre class="programlisting">
1.174     asau     1731: <code class="prompt">$</code> make stage-install
1.118     imil     1732: </pre>
                   1733: <p>
                   1734: 
                   1735:     Create a package without root privileges
                   1736: 
                   1737: </p>
                   1738: <pre class="programlisting">
1.174     asau     1739: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1740: </pre>
                   1741: <p>
                   1742: 
                   1743:     For the following command, you must be able to gain root
1.232     sevan    1744:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     1745: 
                   1746: </p>
                   1747: <pre class="programlisting">
1.174     asau     1748: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1749: </pre>
                   1750: <p>
                   1751: 
                   1752:     Then, as a simple user
                   1753: 
                   1754: </p>
                   1755: <pre class="programlisting">
                   1756: <code class="prompt">$</code> make clean
                   1757: </pre>
                   1758: <p>
                   1759: 
                   1760:     </p>
1.103     wiz      1761: </div>
1.148     asau     1762: <div class="sect1">
1.103     wiz      1763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1764: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1765: <div class="sect2">
1.78      rillig   1766: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      1767: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1768: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1769:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1770: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1771: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1772: <dd>
                   1773: <p>This is a list of values specifying the chain of
                   1774:          compilers to invoke when building packages.  Valid values
                   1775:          are:</p>
1.148     asau     1776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1777: <li class="listitem"><p><code class="varname">ccc</code>:
                   1778:            Compaq C Compilers (Tru64)</p></li>
                   1779: <li class="listitem"><p><code class="varname">ccache</code>:
                   1780:            compiler cache (chainable)</p></li>
                   1781: <li class="listitem"><p><code class="varname">clang</code>:
                   1782:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1783: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1784:            distributed C/C++ (chainable)</p></li>
1.174     asau     1785: <li class="listitem"><p><code class="varname">f2c</code>:
                   1786:            Fortran 77 to C compiler (chainable)</p></li>
                   1787: <li class="listitem"><p><code class="varname">icc</code>:
                   1788:            Intel C++ Compiler (Linux)</p></li>
                   1789: <li class="listitem"><p><code class="varname">ido</code>:
                   1790:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1791: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1792:            GNU C/C++ Compiler</p></li>
1.174     asau     1793: <li class="listitem"><p><code class="varname">hp</code>:
                   1794:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1795: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1796:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1797: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1798:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1799: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1800:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1801: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1802:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1803: </ul></div>
                   1804: <p>The default is
1.128     wiz      1805:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   1806:          <code class="varname">ccache</code> and/or
                   1807:          <code class="varname">distcc</code> with an appropriate
                   1808:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      1809:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 1810:          variable should always be terminated with a value for
                   1811:          a real compiler.  Note that only one real compiler
1.128     wiz      1812:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 1813:          is not allowed).</p>
1.89      rillig   1814: </dd>
                   1815: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1816: <dd><p>This specifies the minimum version of GCC to use
                   1817:          when building packages.  If the system GCC doesn't
                   1818:          satisfy this requirement, then pkgsrc will build and
                   1819:          install one of the GCC packages to use instead.</p></dd>
1.225     maya     1820: <dt><span class="term"><code class="varname">PYTHON_DEFAULT_VERSION</code>:</span></dt>
                   1821: <dd><p>Specifies which version of python to use when several
                   1822:          options are available.</p></dd>
                   1823: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
                   1824: <dd><p>Specifies the fortran compiler to use.
                   1825:          The default is <code class="varname">g95</code>, and
                   1826:          <code class="varname">gfortran</code> is an alternative.</p></dd>
                   1827: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1828: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1829:          <code class="varname">gfortran</code> is used, this option specifies which
                   1830:          version to use.</p></dd>
1.89      rillig   1831: </dl></div>
                   1832: </div>
1.148     asau     1833: <div class="sect2">
1.89      rillig   1834: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      1835: <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   1836: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1837:        please make sure to use the <code class="literal">+=</code> operator
                   1838:        instead of the <code class="literal">=</code> operator:</p>
                   1839: <pre class="programlisting">
1.100     rillig   1840: CFLAGS+=        -your -flags
1.78      rillig   1841: </pre>
                   1842: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      1843:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  1844:        need to add their own flags.  You may want to take a look
1.232     sevan    1845:        at the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128     wiz      1846:        package if you're interested in optimization specifically
                   1847:        for the current CPU. </p>
1.78      rillig   1848: </div>
1.148     asau     1849: <div class="sect2">
1.88      wiz      1850: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      1851: <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      1852: <p>If you want to pass flags to the linker, both in the configure
                   1853: step and the build step, you can do this in two ways.  Either set
                   1854: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1855: between the two is that <code class="varname">LIBS</code> will be appended to
                   1856: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1857: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1858: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1859: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1860: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1861: settings, use the <code class="literal">+=</code> operator:</p>
                   1862: <pre class="programlisting">
1.100     rillig   1863: LDFLAGS+=        -your -linkerflags
1.88      wiz      1864: </pre>
                   1865: </div>
1.78      rillig   1866: </div>
1.148     asau     1867: <div class="sect1">
1.78      rillig   1868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      1869: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 1870: <p>
1.75      rillig   1871:       </p>
1.148     asau     1872: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1873: <li class="listitem">
1.75      rillig   1874: <p><code class="varname">PKG_DEVELOPER</code>:
                   1875:            Run some sanity checks that package developers want:
                   1876:            </p>
1.148     asau     1877: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      1878: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      1879:              fuzz</p></li>
1.128     wiz      1880: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      1881:              binaries will find their shared libs.</p></li>
1.75      rillig   1882: </ul></div>
                   1883: <p>
1.87      wiz      1884:        </p>
1.75      rillig   1885: </li>
1.128     wiz      1886: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      1887:        of debugging output which is displayed whilst making and
                   1888:        installing the package.  The default value for this is 0,
                   1889:        which will not display the commands as they are executed
                   1890:        (normal, default, quiet operation); the value 1 will display
                   1891:        all shell commands before their invocation, and the value 2
                   1892:        will display both the shell commands before their invocation,
1.223     rillig   1893:        as well as their actual execution progress with <span class="command"><strong>set
                   1894:        -x</strong></span>.</p></li>
1.75      rillig   1895: </ul></div>
                   1896: <p>
                   1897:     </p>
                   1898: </div>
1.148     asau     1899: <div class="sect1">
1.75      rillig   1900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      1901: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      1902: <p>Some packages have build time options, usually to select
                   1903:     between different dependencies, enable optional support for big
                   1904:     dependencies or enable experimental features.</p>
1.75      rillig   1905: <p>To see which options, if any, a package supports, and which
1.110     hubertf  1906:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      1907:     show-options</strong></span>, for example:</p>
1.75      rillig   1908: <pre class="programlisting">
                   1909:     The following options are supported by this package:
                   1910:         ssl      Enable SSL support.
                   1911:     Exactly one of the following gecko options is required:
                   1912:         firefox  Use firefox as gecko rendering engine.
                   1913:         mozilla  Use mozilla as gecko rendering engine.
                   1914:     At most one of the following database options may be selected:
                   1915:         mysql    Enable support for MySQL database.
                   1916:         pgsql    Enable support for PostgreSQL database.
1.1       grant    1917: 
1.75      rillig   1918:     These options are enabled by default: firefox
                   1919:     These options are currently enabled: mozilla ssl
1.1       grant    1920: </pre>
1.75      rillig   1921: <p>The following variables can be defined in
1.110     hubertf  1922:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      1923:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   1924:     which can be used to select or disable options for all packages
                   1925:     that support them, and
                   1926:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   1927:     which can be used to select or disable options specifically for
                   1928:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      1929:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      1930:     are disabled. A few examples:</p>
1.75      rillig   1931: <pre class="screen">
1.110     hubertf  1932: <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   1933: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   1934: PKG_OPTIONS.kdebase=    debug -sasl
                   1935: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   1936: <p>It is important to note that options that were specifically
1.120     snj      1937:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   1938:     you do not wish to include the option.  If you are unsure you can view
                   1939:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      1940: <p>The following settings are consulted in the order given, and
                   1941:     the last setting that selects or disables an option is
                   1942:     used:</p>
1.128     wiz      1943: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1944: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      1945:       maintainer</p></li>
1.128     wiz      1946: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      1947:       variables (see below)</p></li>
1.128     wiz      1948: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   1949: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   1950: </ol></div>
                   1951: <p>For groups of mutually exclusive options, the last option
1.88      wiz      1952:     selected is used, all others are automatically disabled.  If an
                   1953:     option of the group is explicitly disabled, the previously
                   1954:     selected option, if any, is used.  It is an error if no option
                   1955:     from a required group of options is selected, and building the
                   1956:     package will fail.</p>
                   1957: <p>Before the options framework was introduced, build options
                   1958:     were selected by setting a variable (often named
                   1959:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  1960:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      1961:     transition to the options framework for the user, these legacy
                   1962:     variables are converted to the appropriate options setting
                   1963:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   1964:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  1965:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      1966:     directly.  Support for the legacy variables will be removed
                   1967:     eventually.</p>
1.75      rillig   1968: </div>
                   1969: </div>
1.148     asau     1970: <div class="chapter">
1.75      rillig   1971: <div class="titlepage"><div><div><h2 class="title">
                   1972: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   1973: <div class="toc">
                   1974: <p><b>Table of Contents</b></p>
1.210     leot     1975: <dl class="toc">
1.75      rillig   1976: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   1977: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   1978: </dl>
                   1979: </div>
1.148     asau     1980: <div class="sect1">
1.75      rillig   1981: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1982: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      1983: <p>Once you have built and installed a package, you can create
                   1984:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.232     sevan    1985:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      1986:     the same package on a group of hosts and wasting CPU time. It also
                   1987:     provides a simple means for others to install your package, should
                   1988:     you distribute it.</p>
                   1989: <p>To create a binary package, change into the appropriate
1.110     hubertf  1990:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      1991:     package</strong></span>:</p>
                   1992: <pre class="screen">
1.223     rillig   1993: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1994: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   1995: </pre>
1.87      wiz      1996: <p>This will build and install your package (if not already done),
                   1997:     and then build a binary package from what was installed. You can
1.110     hubertf  1998:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      1999:     it. Binary packages are created by default in
                   2000:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2001:     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.232     sevan    2002:     continuation of the above <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.110     hubertf  2003: <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      2004:     such a binary package.</p>
1.75      rillig   2005: </div>
1.148     asau     2006: <div class="sect1">
1.75      rillig   2007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2008: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2009: <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   2010: </div>
                   2011: </div>
1.148     asau     2012: <div class="chapter">
1.106     rillig   2013: <div class="titlepage"><div><div><h2 class="title">
                   2014: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2015: builds)</h2></div></div></div>
                   2016: <div class="toc">
                   2017: <p><b>Table of Contents</b></p>
1.210     leot     2018: <dl class="toc">
1.180     wiz      2019: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                   2020: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                   2021: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                   2022: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau     2023: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2024: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2025: </dl>
                   2026: </div>
1.180     wiz      2027: <p>For a number of reasons you may want to build binary packages
                   2028: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
                   2029: For instance, when you have multiple machines that should run the same software,
                   2030: it is wasted time if they all build their packages themselves from source.
                   2031: Or you may want to build a list of packages you want and check them before
                   2032: deploying onto production system.
                   2033: There is a way of getting a set of binary packages:
1.223     rillig   2034: The bulk build system, or pbulk ("p" stands for "parallel").
                   2035: This chapter describes how to set it up.</p>
1.148     asau     2036: <div class="sect1">
1.106     rillig   2037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2038: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
                   2039: <p>First of all, you have to decide whether you build all packages
                   2040: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2041: both space and time, than builds for some practical sets of packages.
                   2042: There exists a number of particularly heavy packages that are not actually
                   2043: interesting to a wide audience.
                   2044: 
                   2045: For a limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2046: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2047: </p>
                   2048: <p>During bulk builds various packages are installed and deinstalled
                   2049: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2050: so make sure that you don't need any package during the builds.
1.223     rillig   2051: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2052: or something even more restrictive, depending on what the operating system provides,
                   2053: or dedicate the whole physical machine.
                   2054: As a useful side effect this makes sure that bulk builds cannot
                   2055: break anything in your system. There have been numerous cases where
1.106     rillig   2056: certain packages tried to install files outside the
                   2057: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2058: <code class="filename">/etc</code>.
                   2059: </p>
1.106     rillig   2060: </div>
1.148     asau     2061: <div class="sect1">
1.106     rillig   2062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2063: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   2064: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148     asau     2065: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2066: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2067: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2068: </ul></div>
1.148     asau     2069: <div class="sect2">
1.116     rillig   2070: <div class="titlepage"><div><div><h3 class="title">
1.180     wiz      2071: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.223     rillig   2072: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2073: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2074: Configure network access to fetch distribution files.
1.223     rillig   2075: Create a user with name "pbulk".</p>
1.178     asau     2076: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2077: <pre class="screen">
1.181     wiz      2078: <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>
                   2079: <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>
                   2080: <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     2081: </pre>
                   2082: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2083: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2084: <pre class="screen">
1.230     sevan    2085: <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     2086: <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>
                   2087: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2088: </pre>
                   2089: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2090: <h3 class="title">Note</h3>
                   2091: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2092: <code class="filename">mk.conf</code> that contains settings you want to
                   2093: apply to packages you build. For instance,</p>
                   2094: <pre class="programlisting">
1.223     rillig   2095: PKG_DEVELOPER=          yes     # perform more checks
                   2096: X11_TYPE=               modular # use pkgsrc X11
                   2097: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2098:                                 # when building all packages)
1.178     asau     2099: </pre>
                   2100: </div>
                   2101: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2102: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2103: <pre class="programlisting">
                   2104: www/firefox
                   2105: mail/thunderbird
                   2106: misc/libreoffice4
                   2107: </pre>
1.179     asau     2108: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2109: and make final amendments, if wanted.</p>
1.178     asau     2110: <p>Start it:</p>
                   2111: <pre class="screen">
                   2112: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2113: </pre>
                   2114: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2115: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2116: </p>
                   2117: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2118: <h3 class="title">Note</h3>
                   2119: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2120: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2121: The script is kept small enough for better understanding.</p>
                   2122: </div>
                   2123: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2124: <h3 class="title">Note</h3>
                   2125: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2126: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2127: </div>
1.106     rillig   2128: </div>
                   2129: </div>
1.148     asau     2130: <div class="sect1">
1.106     rillig   2131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2132: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
                   2133: <p>A complete bulk build requires lots of disk space. Some of the
                   2134: disk space can be read-only, some other must be writable. Some can be on
                   2135: remote filesystems (such as NFS) and some should be local. Some can be
                   2136: temporary filesystems, others must survive a sudden reboot.</p>
                   2137: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2138: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2139: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2140: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2141: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2142: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2143: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2144: </ul></div>
                   2145: </div>
                   2146: <div class="sect1">
                   2147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174     asau     2148: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2149: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2150:     create a CD-ROM set of the resulting binary packages to assist
                   2151:     in installing packages on other machines.  The
1.232     sevan    2152:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      2153:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2154:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2155:     way that keeps all the dependencies for a given package on the same
                   2156:     CD as that package.</p>
1.148     asau     2157: <div class="sect2">
1.75      rillig   2158: <div class="titlepage"><div><div><h3 class="title">
1.174     asau     2159: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2160: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2161:       man page. The following short example assumes that the binary
                   2162:       packages are left in
                   2163:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2164:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2165:       hold the ISO 9660 images.</p>
                   2166: <pre class="screen">
                   2167: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2168: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2169: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2170:       </pre>
                   2171: <p>If you wish to include a common set of files
                   2172:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2173:       etc.) on each CD in the collection, then you need to create a
                   2174:       directory which contains these files. e.g.</p>
                   2175: <pre class="screen">
                   2176: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2177: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2178: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2179: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2180: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2181: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2182: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2183:       </pre>
1.75      rillig   2184: <p>Now create the images:</p>
                   2185: <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   2186: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2187:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2188:       in their root directories.</p>
1.75      rillig   2189: </div>
                   2190: </div>
                   2191: </div>
1.148     asau     2192: <div class="chapter">
1.75      rillig   2193: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2194: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2195: <div class="toc">
                   2196: <p><b>Table of Contents</b></p>
1.210     leot     2197: <dl class="toc">
1.128     wiz      2198: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2199: <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   2200: </dl>
                   2201: </div>
                   2202: <p>The files that are installed by pkgsrc are organized in a way that
                   2203: is similar to what you find in the <code class="filename">/usr</code> directory
                   2204: of the base system. But some details are different. This is because
                   2205: pkgsrc initially came from FreeBSD and had adopted its file system
                   2206: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2207: which operating system you are using pkgsrc with, you can expect the
                   2208: same layout for pkgsrc.</p>
1.91      rillig   2209: <p>There are mainly four root directories for pkgsrc, which are all
                   2210: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2211: When pkgsrc has been installed as root, the default locations
                   2212: are:</p>
                   2213: <pre class="programlisting">
1.100     rillig   2214: LOCALBASE=              /usr/pkg
                   2215: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2216: VARBASE=                /var
1.231     sevan    2217: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2218: </pre>
                   2219: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2220: user), the default locations are:</p>
                   2221: <pre class="programlisting">
1.100     rillig   2222: LOCALBASE=              ${HOME}/pkg
                   2223: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2224: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2225: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2226: </pre>
                   2227: <p>What these four directories are for, and what they look like is
                   2228: explained below.</p>
1.148     asau     2229: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2230: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2231: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2232: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2233: the well-known subdirectories like <code class="filename">bin</code>,
                   2234: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2235: <code class="filename">share</code> and
                   2236: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2237: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2238: <code class="filename">/var</code> in the base system. Some programs (especially
                   2239: games, network daemons) need write access to it during normal
                   2240: operation.</p></li>
1.128     wiz      2241: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2242: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2243: 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   2244: itself.</p></li>
                   2245: </ul></div>
1.148     asau     2246: <div class="sect1">
1.90      rillig   2247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2248: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2249: </h2></div></div></div>
1.90      rillig   2250: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2251: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2252: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2253: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2254: <dd><p>Contains executable programs that are intended to be
                   2255: directly used by the end user.</p></dd>
                   2256: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2257: <dd><p>Contains files for the emulation layers of various other
                   2258: operating systems, especially for
                   2259: NetBSD.</p></dd>
                   2260: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2261: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2262: <dd><p>Contains
                   2263: the configuration files.</p></dd>
                   2264: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2265: <dd><p>Contains headers for the C and C++ programming
                   2266: languages.</p></dd>
                   2267: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2268: <dd><p>Contains GNU info files of various
                   2269: packages.</p></dd>
                   2270: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2271: <dd><p>Contains shared and static
                   2272: libraries.</p></dd>
                   2273: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2274: <dd><p>Contains data files that don't change after
                   2275: installation. Other data files belong into
                   2276: <code class="filename">${VARBASE}</code>.</p></dd>
                   2277: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2278: <dd><p>Contains programs that are not intended to be used by
                   2279: end users, such as helper programs or network
                   2280: daemons.</p></dd>
                   2281: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2282: <dd><p>Contains programs that are intended to be executed as
                   2283: CGI scripts by a web server.</p></dd>
                   2284: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2285: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2286: <dd><p>Contains brief
                   2287: documentation in form of manual pages.</p></dd>
                   2288: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2289: <dd><p>Contains programs that are intended to be used only by
                   2290: the super-user.</p></dd>
                   2291: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2292: <dd><p>Contains platform-independent data files that don't
                   2293: change after installation.</p></dd>
                   2294: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2295: <dd><p>Contains documentation files provided by the
                   2296: packages.</p></dd>
                   2297: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2298: <dd><p>Contains example files provided by the packages. Among
                   2299: others, the original configuration files are saved here and copied to
                   2300: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2301: installation.</p></dd>
                   2302: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2303: <dd><p>Contains the original files for rc.d
                   2304: scripts.</p></dd>
                   2305: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2306: <code class="filename">${VARBASE}</code>)</span></dt>
                   2307: <dd><p>Contains files
                   2308: that may be modified after
                   2309: installation.</p></dd>
                   2310: </dl></div>
                   2311: </div>
1.148     asau     2312: <div class="sect1">
1.90      rillig   2313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2314: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2315: </h2></div></div></div>
1.148     asau     2316: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2317: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2318: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2319: <dd><p>Contains
                   2320: information about the currently installed
                   2321: packages.</p></dd>
                   2322: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2323: <dd><p>Contains highscore
                   2324: files.</p></dd>
                   2325: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2326: <dd><p>Contains log files.</p></dd>
                   2327: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2328: <dd><p>Contains informational files about daemons that are
                   2329: currently running.</p></dd>
                   2330: </dl></div>
                   2331: </div>
                   2332: </div>
1.148     asau     2333: <div class="chapter">
1.90      rillig   2334: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2335: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2336: <div class="toc">
                   2337: <p><b>Table of Contents</b></p>
1.210     leot     2338: <dl class="toc">
1.106     rillig   2339: <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 2340: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                   2341: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                   2342: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2343: <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>
                   2344: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                   2345: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                   2346: <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>
                   2347: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                   2348: <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      2349: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert 2350: <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>
                   2351: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2352: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   2353: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                   2354: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2355: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                   2356: <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   2357: </dl>
                   2358: </div>
                   2359: <p>This section contains hints, tips &amp; tricks on special things in
                   2360: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2361: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2362: <div class="sect1">
1.75      rillig   2363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2364: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2365: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2366: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2367: <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   2368:          This is a general purpose list for most issues regarding
                   2369:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2370:          for pkgsrc configuration, unexpected build failures, using
                   2371:          particular packages, upgrading pkgsrc installations,
                   2372:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2373:          proposals for changes that impact the pkgsrc user community,
                   2374:          e.g. major infrastructure changes, new features, package
                   2375:          removals, etc., may also be posted.</p></li>
1.128     wiz      2376: <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   2377:          A list where the results of pkgsrc bulk builds are sent and
                   2378:          discussed.</p></li>
1.128     wiz      2379: <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   2380:          This list is for those who are interested in getting a
                   2381:          commit message for every change committed to pkgsrc. It is
                   2382:          also available in digest form, meaning one daily message
                   2383:          containing all commit messages for changes to the package
                   2384:          source tree in that 24 hour period.</p></li>
                   2385: </ul></div>
                   2386: <p>To subscribe, do:</p>
                   2387: <pre class="programlisting">
1.100     rillig   2388: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2389: </pre>
                   2390: <p>Archives for all these mailing lists are available from
1.110     hubertf  2391: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2392: </div>
1.148     asau     2393: <div class="sect1">
1.75      rillig   2394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2395: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2396: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2397: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2398: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2399: they might be useful, and not to duplicate the documentation that comes
                   2400: with each package.</p>
                   2401: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.232     sevan    2402: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   2403:       Symlinks for use by buildlink.</p></li></ul></div>
                   2404: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2405: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232     sevan    2406: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233     sevan    2407:       Calculates various kinds of checksums (including SHA3).</p></li>
1.232     sevan    2408: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   2409:       Compatibility library for pkgsrc tools.</p></li>
1.232     sevan    2410: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      2411:       non-BSD systems due to lack of native mtree.</p></li>
1.232     sevan    2412: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   2413:       Up-to-date replacement for
1.76      rillig   2414:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2415:       systems where pkg_install is not present.</p></li>
                   2416: </ul></div>
                   2417: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2418: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232     sevan    2419: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   2420:       Create a binary package from an
1.110     hubertf  2421:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2422:       save the old package.</p></li>
1.232     sevan    2423: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   2424:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2425:       from multiple locations. It currently supports the following
                   2426:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.232     sevan    2427: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117     jnemeth  2428:       the best compiler flags to optimise code for your current
1.128     wiz      2429:       CPU and compiler. </p></li>
1.75      rillig   2430: </ul></div>
                   2431: <p>Utilities for keeping track of installed packages, being up to date,
                   2432: etc:</p>
1.148     asau     2433: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232     sevan    2434: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173     wiz      2435:     update tool similar to apt(1). Download, install, and upgrade
                   2436:     binary packages easily.</p></li>
1.232     sevan    2437: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   2438:       packages whose installed versions do not match the latest pkgsrc
                   2439:       entries.</p></li>
1.232     sevan    2440: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   2441:       dependency graphs of packages, to aid in choosing a strategy for
                   2442:       updating.</p></li>
1.232     sevan    2443: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   2444:       graphs from the output of <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   2445: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   2446:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.232     sevan    2447: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   2448:       does various checks on the complete pkgsrc system.</p></li>
1.232     sevan    2449: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   2450:       packages you have installed.</p></li>
                   2451: </ul></div>
                   2452: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2453: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232     sevan    2454: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   2455:       making and maintaining patches for a package (includes pkgdiff,
                   2456:       pkgvi, mkpatches, etc.).</p></li>
1.232     sevan    2457: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   2458:       converting to pkgsrc.</p></li>
                   2459: </ul></div>
                   2460: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2461: utilities)</p>
1.148     asau     2462: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232     sevan    2463: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   2464:       packages in a chrooted area.</p></li>
1.232     sevan    2465: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   2466:       kernel version for chrooted cross builds.</p></li>
                   2467: </ul></div>
                   2468: </div>
1.148     asau     2469: <div class="sect1">
1.75      rillig   2470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2471: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2472: <p>To install packages from source as a non-root user, download
                   2473: 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
                   2474: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2475: --unprivileged</strong></span>.</p>
                   2476: <p>This will install the binary part of pkgsrc to
                   2477: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2478: into <code class="filename">~/pkg/etc</code>.</p>
                   2479: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2480: </div>
1.148     asau     2481: <div class="sect1">
1.75      rillig   2482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2483: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2484: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2485: enable this feature by adding the option
                   2486: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2487: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2488: distfile is found, pkgsrc will try to resume it.</p>
                   2489: <p>You can also
1.168     wiz      2490: use a different program than the platform default program by changing the
1.117     jnemeth  2491: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2492: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2493: by using the value manual.  A value of custom disables the system defaults
                   2494: and dependency tracking for the fetch program.  In that case you have to
                   2495: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2496: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2497: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2498: <p>For example, if you want to use
1.117     jnemeth  2499: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2500: like:</p>
                   2501: <pre class="programlisting">
1.223     rillig   2502: FETCH_USING=    wget
1.1       grant    2503: </pre>
1.75      rillig   2504: </div>
1.148     asau     2505: <div class="sect1">
1.75      rillig   2506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2507: <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      2508: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   2509: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   2510: you will have to add the following line into
1.110     hubertf  2511: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   2512: <pre class="programlisting">
1.103     wiz      2513: X11_TYPE=modular
1.1       grant    2514: </pre>
1.75      rillig   2515: </div>
1.148     asau     2516: <div class="sect1">
1.75      rillig   2517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2518: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   2519: <p>If you are sitting behind a firewall which does not allow direct
                   2520: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2521: relevant proxy hosts.  This is done using an environment variable in the
                   2522: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      2523: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   2524: port 80 as the proxy port number.  So the proxy environment variables
                   2525: are:</p>
                   2526: <pre class="programlisting">
1.100     rillig   2527: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2528: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    2529: </pre>
1.75      rillig   2530: </div>
1.148     asau     2531: <div class="sect1">
1.75      rillig   2532: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2533: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      2534: <p>Some fetch tools are not prepared to support HTTPS by default
                   2535: (for example, the one in NetBSD 6.0), or the one installed by the
                   2536: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2537: dependency graph).</p>
                   2538: <p>Usually you won't notice, because distribution files are
                   2539: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2540: be often enough if you are following pkgsrc-current. In that case, set
                   2541: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2542: <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
                   2543: with HTTPS support by default. Of course, these tools need to be
                   2544: installed before you can use them this way.</p>
                   2545: </div>
                   2546: <div class="sect1">
                   2547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2548: <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   2549: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   2550: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   2551: the first available command from the following list:</p>
1.148     asau     2552: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2553: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2554: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   2555: </ul></div>
                   2556: <p>On a default NetBSD installation, this will be
1.76      rillig   2557: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   2558: connections first, and falls back to active connections if the server
                   2559: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  2560: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   2561: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2562: <p>Having that option present will prevent
1.76      rillig   2563: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   2564: transfers.</p>
                   2565: </div>
1.148     asau     2566: <div class="sect1">
1.75      rillig   2567: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2568: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      2569: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  2570: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      2571: 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   2572: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  2573: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   2574: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   2575: resulting list to your machine at work/school and use it there.  If you
1.232     sevan    2576: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   2577: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2578: URL:</p>
                   2579: <p>At home:</p>
                   2580: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2581: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2582: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2583: <p>At work:</p>
                   2584: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   2585: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   2586: home.</p>
                   2587: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      2588: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2589: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  2590: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      2591: directly by running:</p>
1.75      rillig   2592: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2593: <p>If you even decide to ignore
                   2594: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2595: by running:</p>
                   2596: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2597: </div>
1.148     asau     2598: <div class="sect1">
1.75      rillig   2599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2600: <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      2601: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.232     sevan    2602: <p>When compiling the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   2603: package, you get the error from make that it doesn't know how to make
1.76      rillig   2604: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      2605: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   2606: the NetBSD base distribution on your machine.  It is recommended to do
                   2607: that to format man pages.</p>
1.232     sevan    2608: <p>In the case of the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   2609: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  2610: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   2611: </div>
1.148     asau     2612: <div class="sect1">
1.75      rillig   2613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2614: <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      2615: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   2616: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   2617: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   2618: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2619: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   2620: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  2621: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   2622: -r</strong></span>).</p>
                   2623: </div>
1.148     asau     2624: <div class="sect1">
1.75      rillig   2625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2626: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   2627: <p>When installing packages as non-root user and using the just-in-time
1.232     sevan    2628: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-7.0.2"><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   2629: password for each required package installed.  To avoid this, the sudo
                   2630: package can be used, which does password caching over a limited time.  To
                   2631: use it, install sudo (either as binary package or from
1.232     sevan    2632: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  2633: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      2634: <span class="emphasis"><em>after</em></span> the definition of the
                   2635: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   2636: <pre class="programlisting">
1.100     rillig   2637: .if exists(${LOCALBASE}/bin/sudo)
                   2638: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2639: .endif
1.1       grant    2640: </pre>
1.75      rillig   2641: </div>
1.148     asau     2642: <div class="sect1">
1.75      rillig   2643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2644: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   2645: <p>As the system administrator, you can choose where configuration files
                   2646: are installed.  The default settings make all these files go into
1.76      rillig   2647: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   2648: be suboptimal depending on your expectations (e.g., a read-only,
                   2649: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   2650: configuration of the provided packages).</p>
                   2651: <p>In order to change the defaults, you can modify the
                   2652: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  2653: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   2654: directory; some common examples include <code class="filename">/etc</code> or
                   2655: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   2656: <p>Furthermore, you can change this value on a per-package basis by
                   2657: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   2658: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   2659: package you would like to modify, that is, the contents of
                   2660: <code class="varname">PKGBASE</code>.</p>
                   2661: <p>Note that after changing these settings, you must rebuild and
                   2662: reinstall any affected packages.</p>
                   2663: </div>
1.148     asau     2664: <div class="sect1">
1.75      rillig   2665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2666: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75      rillig   2667: <p>Please be aware that there can often be bugs in third-party software,
                   2668: and some of these bugs can leave a machine vulnerable to exploitation by
                   2669: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   2670: maintains a database of known-exploits to packages which have at one time
                   2671: been included in pkgsrc.  The database can be downloaded automatically, and
                   2672: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 2673: do this, refer to the following two tools (installed as part of the
1.232     sevan    2674: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128     wiz      2675: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2676: <li class="listitem">
1.122     reed     2677: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   2678:     download a list of the security vulnerabilities information.  This list
1.132     spz      2679:     is kept up to date by the pkgsrc security team, and is distributed
                   2680:     from the NetBSD ftp server:</p>
                   2681: <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   2682: </li>
1.128     wiz      2683: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   2684:     current machine, checking each known vulnerability.  If a
1.75      rillig   2685:     vulnerable package is installed, it will be shown by output to stdout,
                   2686:     including a description of the type of vulnerability, and a URL
                   2687:     containing more information.</p></li>
                   2688: </ol></div>
1.233     sevan    2689: <p>Use of these tools is strongly recommended!
                   2690: See <a class="xref" href="#vulnerabilities" title="4.1.5. Checking for security vulnerabilities in installed packages">Section 4.1.5, &#8220;Checking for security vulnerabilities in installed packages&#8221;</a> for instructions on how to automate checking and
                   2691: reporting.</p>
                   2692: <p>If this database is installed, pkgsrc builds will use it to
                   2693: perform a security check before building any package.</p>
1.75      rillig   2694: </div>
1.148     asau     2695: <div class="sect1">
1.75      rillig   2696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2697: <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   2698: <p>When you add your own preferences to the
                   2699:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  2700:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   2701:        environment variables to the <code class="filename">./configure</code>
1.232     sevan    2702:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   2703:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   2704:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   2705:        package.</p>
                   2706: <p>Currently there is no solution to this problem. If you
                   2707:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  2708:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   2709:        directory and then inspect any <code class="filename">Makefile</code> and
                   2710:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   2711:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      2712:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   2713:        programmers write so bad code that it only works for the
                   2714:        specific combination of <code class="varname">CFLAGS</code> they have
                   2715:        chosen.</p>
                   2716: </div>
1.148     asau     2717: <div class="sect1">
1.80      rillig   2718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2719: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      2720: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     2721: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   2722:        case that occurs often is that people only update pkgsrc in
                   2723:        parts, because of performance reasons. Since pkgsrc is one large
                   2724:        system, not a collection of many small systems, there are
                   2725:        sometimes changes that only work when the whole pkgsrc tree is
                   2726:        updated.</p></li>
1.148     asau     2727: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      2728:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   2729:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   2730:        files.</p></li>
1.148     asau     2731: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  2732:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   2733:        verify this.</p></li>
1.218     rillig   2734: <li class="step"><p>If you are a package developer who wants to invest
                   2735:        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     2736: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   2737:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   2738: </ol></div>
                   2739: </div>
1.148     asau     2740: <div class="sect1">
1.88      wiz      2741: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2742: <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   2743: <p>You have modified a file from pkgsrc, and someone else has
                   2744: modified that same file afterwards in the CVS repository. Both changes
                   2745: are in the same region of the file, so when you updated pkgsrc, the
                   2746: <code class="literal">cvs</code> command marked the conflicting changes in the
                   2747: file. Because of these markers, the file is no longer a valid
                   2748: <code class="filename">Makefile</code>.</p>
                   2749: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  2750: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   2751: -dP</strong></span> in that directory to download the current version.</p>
                   2752: </div>
1.75      rillig   2753: </div>
                   2754: </div>
1.148     asau     2755: <div class="part">
1.75      rillig   2756: <div class="titlepage"><div><div><h1 class="title">
                   2757: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     2758: <div class="partintro">
1.77      rillig   2759: <div></div>
                   2760: <p>This part of the book deals with creating and
1.128     wiz      2761:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   2762:        guide on creating a new package. The remaining chapters are more
                   2763:        like a reference manual for pkgsrc.</p>
1.75      rillig   2764: <div class="toc">
                   2765: <p><b>Table of Contents</b></p>
1.210     leot     2766: <dl class="toc">
1.106     rillig   2767: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   2768: <dd><dl>
1.106     rillig   2769: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   2770: <dd><dl>
1.106     rillig   2771: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.233     sevan    2772: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 &amp; KDE4 applications</a></span></dt>
1.118     imil     2773: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   2774: </dl></dd>
1.106     rillig   2775: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   2776: <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>
                   2777: </dl></dd>
                   2778: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   2779: <dd><dl>
1.128     wiz      2780: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   2781: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219     rillig   2782: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig   2783: <dd><dl>
                   2784: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   2785: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   2786: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   2787: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   2788: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   2789: </dl></dd>
                   2790: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   2791: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   2792: <dd><dl>
                   2793: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   2794: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   2795: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   2796: </dl></dd>
1.128     wiz      2797: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   2798: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   2799: </dl></dd>
1.128     wiz      2800: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   2801: <dd><dl>
                   2802: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      2803: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   2804: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   2805: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   2806: <dd><dl>
                   2807: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228     yyamano  2808: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220     wiz      2809: <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>
                   2810: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig   2811: </dl></dd>
                   2812: </dl></dd>
                   2813: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   2814: <dd><dl>
                   2815: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      2816: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   2817: <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   2818: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   2819: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      2820: <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   2821: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz      2822: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   2823: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106     rillig   2824: </dl></dd>
                   2825: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   2826: <dd><dl>
                   2827: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      2828: <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   2829: <dd><dl>
                   2830: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      2831: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   2832:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2833:       and
                   2834:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2835:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   2836: </dl></dd>
1.128     wiz      2837: <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   2838: <dd><dl>
1.128     wiz      2839: <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   2840: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   2841: </dl></dd>
                   2842: </dl></dd>
                   2843: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   2844: <dd><dl>
                   2845: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   2846: <dd><dl>
                   2847: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   2848: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   2849: </dl></dd>
                   2850: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   2851: <dd><dl>
1.128     wiz      2852: <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   2853: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   2854: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   2855: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   2856: </dl></dd>
                   2857: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   2858: <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>
                   2859: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   2860: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   2861: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   2862: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   2863: <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>
                   2864: </dl></dd>
                   2865: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   2866: <dd><dl>
                   2867: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      2868: <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   2869: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   2870: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   2871: </dl></dd>
                   2872: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   2873: <dd><dl>
                   2874: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   2875: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   2876: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   2877: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      2878: <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   2879: <dd><dl>
                   2880: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   2881: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   2882: </dl></dd>
1.128     wiz      2883: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   2884: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   2885: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   2886: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   2887: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   2888: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2889: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2890: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   2891: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2892: <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   2893: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   2894: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   2895: </dl></dd>
                   2896: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   2897: <dd><dl>
                   2898: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   2899: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   2900: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   2901: </dl></dd>
                   2902: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   2903: <dd><dl>
                   2904: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   2905: <dd><dl>
1.218     rillig   2906: <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>
                   2907: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                   2908: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                   2909: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                   2910: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                   2911: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                   2912: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                   2913: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   2914: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                   2915: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   2916: <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   2917: </dl></dd>
1.218     rillig   2918: <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   2919: <dd><dl>
                   2920: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   2921: <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      2922: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig   2923: </dl></dd>
1.218     rillig   2924: <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   2925: <dd><dl>
                   2926: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   2927: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   2928: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   2929: </dl></dd>
                   2930: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   2931: <dd><dl>
                   2932: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   2933: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   2934: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      2935: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   2936: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   2937: </dl></dd>
1.218     rillig   2938: <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   2939: <dd><dl>
                   2940: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   2941: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      2942: <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   2943: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   2944: </dl></dd>
1.218     rillig   2945: <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   2946: <dd><dl>
                   2947: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   2948: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   2949: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   2950: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   2951: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   2952: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   2953: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   2954: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   2955: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   2956: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   2957: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   2958: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   2959: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   2960: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   2961: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   2962: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   2963: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   2964: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      2965:     emulation</a></span></dt>
1.106     rillig   2966: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   2967: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   2968: </dl></dd>
1.106     rillig   2969: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   2970: </dl></dd>
1.106     rillig   2971: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   2972: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   2973: <dd><dl>
1.106     rillig   2974: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   2975: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   2976: <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      2977: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig   2978: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     2979: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   2980: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig   2981: </dl></dd>
                   2982: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   2983: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   2984: <dd><dl>
                   2985: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   2986: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   2987: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   2988: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     2989: </dl></dd>
1.75      rillig   2990: </dl>
                   2991: </div>
1.77      rillig   2992: </div>
1.148     asau     2993: <div class="chapter">
1.77      rillig   2994: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2995: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   2996: <div class="toc">
                   2997: <p><b>Table of Contents</b></p>
1.210     leot     2998: <dl class="toc">
1.106     rillig   2999: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3000: <dd><dl>
1.106     rillig   3001: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.233     sevan    3002: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 &amp; KDE4 applications</a></span></dt>
1.118     imil     3003: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3004: </dl></dd>
1.106     rillig   3005: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3006: <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   3007: </dl>
                   3008: </div>
1.77      rillig   3009: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3010: most likely have a URL from where you can download the source
                   3011: code. Starting with this URL, creating a package involves only a
                   3012: few steps.</p>
1.128     wiz      3013: <div class="procedure"><ol class="procedure" type="1">
1.232     sevan    3014: <li class="step"><p>First, install the packages <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.148     asau     3015: <li class="step"><p>Then, choose one of the top-level directories as the
1.91      rillig   3016: category in which you want to place your package. You can also create a
                   3017: directory of your own (maybe called <code class="filename">local</code>). In that
                   3018: category directory, create another directory for your package and change
                   3019: into it.</p></li>
1.148     asau     3020: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3021: you for a URL. Enter the URL of the distribution file (in most cases a
                   3022: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3023: of your package are created automatically. The distribution file is
                   3024: extracted automatically to fill in some details in the
                   3025: <code class="filename">Makefile</code> that would otherwise have to be done
                   3026: manually.</p></li>
1.148     asau     3027: <li class="step">
1.91      rillig   3028: <p>Examine the extracted files to determine the dependencies of
                   3029: your package. Ideally, this is mentioned in some
                   3030: <code class="filename">README</code> file, but things may differ. For each of
                   3031: these dependencies, look where it exists in pkgsrc, and if there is a
                   3032: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3033: line to your package <code class="filename">Makefile</code> which includes that
                   3034: file just before the last line. If the
1.132     spz      3035: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3036: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3037: <p>If you just need binaries from a package, add a
1.91      rillig   3038: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3039: version of the dependency and where it can be found in pkgsrc. This line
                   3040: should be placed in the third paragraph. If the dependency is only
                   3041: needed for building the package, but not when using it, use
                   3042: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3043: Your package may then look like this:</p>
1.77      rillig   3044: <pre class="programlisting">
1.100     rillig   3045: [...]
1.77      rillig   3046: 
1.174     asau     3047: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100     rillig   3048: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3049: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3050: 
1.100     rillig   3051: [...]
1.77      rillig   3052: 
1.100     rillig   3053: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3054: .include "../../devel/glib2/buildlink3.mk"
                   3055: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3056: </pre>
                   3057: </li>
1.148     asau     3058: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128     wiz      3059: 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  3060: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3061: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3062: -e</strong></span>, which outputs additional
                   3063: explanations.</p></li>
1.148     asau     3064: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  3065: 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   3066: over there, you can hopefully continue here.</p></li>
1.148     asau     3067: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3068: directory from the extracted files. Besides these files, a lot of cache
                   3069: files and other system information has been saved in the working
                   3070: directory, which may become wrong after you edited the
                   3071: <code class="filename">Makefile</code>.</p></li>
1.148     asau     3072: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110     hubertf  3073: 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     3074: <li class="step"><p>When the package builds fine, the next step is to install
1.110     hubertf  3075: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3076: everything works.</p></li>
1.148     asau     3077: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91      rillig   3078: contains a list of the files that are installed by the package, is
1.110     hubertf  3079: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3080: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3081: the file using your preferred text editor to see if the list of
                   3082: files looks plausible.</p></li>
1.148     asau     3083: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3084: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148     asau     3085: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3086: has been registered in the database of installed files, but with an
1.110     hubertf  3087: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3088: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3089: registered with the list of files from
                   3090: <code class="filename">PLIST</code>.</p></li>
1.148     asau     3091: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3092: package from the set of installed files.</p></li>
1.77      rillig   3093: </ol></div>
1.148     asau     3094: <div class="sect1">
1.91      rillig   3095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3096: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148     asau     3097: <div class="sect2">
1.91      rillig   3098: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3099: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   3100: <p>Simple Perl modules are handled automatically by
1.110     hubertf  3101: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   3102: </div>
1.148     asau     3103: <div class="sect2">
1.91      rillig   3104: <div class="titlepage"><div><div><h3 class="title">
1.233     sevan    3105: <a name="creating.kde-app"></a>10.1.2. KDE3 &amp; KDE4 applications</h3></div></div></div>
1.174     asau     3106: <p>KDE3 applications should always include
1.91      rillig   3107: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.233     sevan    3108: settings that are typical of KDE3 packages and KDE4 applications should
                   3109: always include <code class="filename">meta-pkgs/kde4/kde4.mk</code>, respectively.</p>
1.91      rillig   3110: </div>
1.148     asau     3111: <div class="sect2">
1.118     imil     3112: <div class="titlepage"><div><div><h3 class="title">
                   3113: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   3114: <p>Python modules and programs packages are easily created using a
                   3115: set of predefined variables.</p>
                   3116: <p>
1.171     wiz      3117: If some Python versions are not supported by the software, set the
                   3118: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   3119: that are not supported, e.g.
1.118     imil     3120: </p>
                   3121: <pre class="programlisting">
1.203     sevan    3122: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.118     imil     3123: </pre>
                   3124: <p>
1.213     wiz      3125: If the packaged software is a Python module, include one of
                   3126: <code class="filename">../../lang/python/egg.mk</code>,
                   3127: <code class="filename">../../lang/python/distutils.mk</code>, or
                   3128: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   3129: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3130: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3131: if the packaged software is using setuptools, you only need
                   3132: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   3133: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   3134: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>.
                   3135: so pkgsrc will use this framework.
                   3136: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3137: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   3138: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3139: to the name of the script.</p>
                   3140: <p>Either way, the package directory should be called
1.128     wiz      3141: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3142: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.118     imil     3143: </p>
                   3144: <pre class="programlisting">
                   3145: DISTNAME=   foopymodule-1.2.10
                   3146: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3147: </pre>
1.171     wiz      3148: <p>If it is an application, include
                   3149: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   3150: In order to correctly set the path to the Python interpreter, use the
1.118     imil     3151: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142     wiz      3152: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171     wiz      3153: For example:
1.118     imil     3154: </p>
                   3155: <pre class="programlisting">
1.142     wiz      3156: REPLACE_PYTHON=   *.py
1.118     imil     3157: </pre>
1.171     wiz      3158: <p>Some Python modules have separate distributions for Python-2.x
                   3159: and Python-3.x support. In pkgsrc this is handled by the
                   3160: <code class="filename">versioned_dependencies.mk</code> file. Set
                   3161: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   3162: packages that should be depended upon and include
                   3163: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   3164: then the pkgsrc infrastructure will depend on the appropriate package
                   3165: version. For example:
                   3166: </p>
                   3167: <pre class="programlisting">
1.236   ! wiz      3168: PYTHON_VERSIONED_DEPENDENCIES=gobject
1.171     wiz      3169: </pre>
                   3170: <p>
                   3171: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   3172: of supported packages.</p>
1.118     imil     3173: </div>
1.91      rillig   3174: </div>
1.148     asau     3175: <div class="sect1">
1.91      rillig   3176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3177: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148     asau     3178: <div class="sect2">
1.91      rillig   3179: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3180: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148     asau     3181: <div class="sect3">
1.91      rillig   3182: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3183: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   3184: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128     wiz      3185: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.91      rillig   3186: pkgsrc. As the description says it has to do with the web, the obvious
1.128     wiz      3187: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.91      rillig   3188: <pre class="programlisting">
1.100     rillig   3189: <code class="prompt">$</code> mkdir www/nvu
                   3190: <code class="prompt">$</code> cd www/nvu
1.91      rillig   3191: </pre>
                   3192: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  3193: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   3194: <pre class="programlisting">
1.100     rillig   3195: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   3196: </pre>
                   3197: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3198: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128     wiz      3199: 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   3200: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3201: <code class="varname">COMMENT</code> fields. Then the package
                   3202: <code class="filename">Makefile</code> looked like that:</p>
                   3203: <pre class="programlisting">
1.233     sevan    3204: # $NetBSD $
1.100     rillig   3205: #
1.91      rillig   3206: 
1.100     rillig   3207: DISTNAME=       nvu-1.0-sources
                   3208: PKGNAME=        nvu-1.0
                   3209: CATEGORIES=     www
                   3210: MASTER_SITES=   http://cvs.nvu.com/download/
                   3211: EXTRACT_SUFX=   .tar.bz2
                   3212: 
                   3213: MAINTAINER=     rillig@NetBSD.org
                   3214: HOMEPAGE=       http://cvs.nvu.com/
                   3215: COMMENT=        Web Authoring System
1.91      rillig   3216: 
1.100     rillig   3217: # url2pkg-marker (please do not remove this line.)
                   3218: .include "../../mk/bsd.pkg.mk"
1.91      rillig   3219: </pre>
1.236   ! wiz      3220: <p>On the first line of output above, an artificial space has been added betweeen NetBSD and $,
1.233     sevan    3221: this is a workaround to prevent CVS expanding to the filename of the
                   3222: guide.</p>
1.91      rillig   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.232     sevan    3377: interface. I looked up in <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.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>:
1.232     sevan    3495:     an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.190     wiz      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.232     sevan    3505:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.0.2"><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.234     leot     3523: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
                   3524:     applicable for the package. See <a class="xref" href="#handling-licenses" title="19.1.3. Handling licenses">Section 19.1.3, &#8220;Handling licenses&#8221;</a> for further details.</p></li>
1.75      rillig   3525: </ul></div>
                   3526: <p>Other variables that affect the build:
1.87      wiz      3527:   </p>
1.148     asau     3528: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75      rillig   3529: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      3530:       interesting distribution files of the package are found. The
                   3531:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3532:       works for most packages.</p>
1.75      rillig   3533: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      3534:       (most GNU software does, for instance), but extracts itself in
                   3535:       the current directory, you should set
                   3536:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3537: <p>If a package doesn't create a subdirectory with the
                   3538:       name of <code class="varname">DISTNAME</code> but some different name,
                   3539:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3540:       <code class="filename">${WRKDIR}</code>, for example
                   3541:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.232     sevan    3542:       <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75      rillig   3543: <p>The name of the working directory created by pkgsrc is
1.87      wiz      3544:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3545:       variable. By default, its value is
                   3546:       <code class="filename">work</code>. If you want to use the same
                   3547:       pkgsrc tree for building different kinds of binary packages,
                   3548:       you can change the variable according to your needs. Two
                   3549:       other variables handle common cases of setting
                   3550:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3551:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  3552:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      3553:       the host's name is attached to the directory name. If
                   3554:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3555:       is attached, which might look like
                   3556:       <code class="filename">work.i386</code> or
                   3557:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   3558: </li></ul></div>
                   3559: <p>Please pay attention to the following gotchas:</p>
1.148     asau     3560: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3561: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      3562:       installed in compressed form by the package.  For packages using
                   3563:       BSD-style makefiles which honor MANZ, there is
                   3564:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128     wiz      3565: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3566:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.88      wiz      3567:       below).</p></li>
1.128     wiz      3568: <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   3569: </ul></div>
                   3570: </div>
1.148     asau     3571: <div class="sect1">
1.75      rillig   3572: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3573: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   3574: </h2></div></div></div>
1.76      rillig   3575: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      3576:   digest, or checksum, of each distfile needed for the package. This
                   3577:   ensures that the distfiles retrieved from the Internet have not been
                   3578:   corrupted during transfer or altered by a malign force to introduce
1.219     rillig   3579:   a security hole. To provide maximum security, all distfiles are
                   3580:   protected using three different message digest algorithms (SHA1,
                   3581:   RMD160, SHA512), as well as the file size.</p>
1.76      rillig   3582: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      3583:   checksums for all the patches found in the
1.219     rillig   3584:   <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   3585: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.219     rillig   3586:   <span class="command"><strong>make distinfo</strong></span> command.</p>
1.75      rillig   3587: <p>Some packages have different sets of distfiles depending on
1.232     sevan    3588:   the platform, for example <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.87      wiz      3589:   <code class="filename">distinfo</code> file and care should be taken when
                   3590:   upgrading such a package to ensure distfile information is not
                   3591:   lost.</p>
1.75      rillig   3592: </div>
1.148     asau     3593: <div class="sect1">
1.75      rillig   3594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219     rillig   3595: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
                   3596: </h2></div></div></div>
                   3597: <p>Some packages don't work out-of-the box on the various
                   3598:   platforms that are supported by pkgsrc. These packages need
                   3599:   to be patched to make them work. The patch files can be
1.93      rillig   3600:   found in the <code class="filename">patches/</code> directory.</p>
                   3601: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3602:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.219     rillig   3603:   extracting them, in alphabetic order.</p>
1.148     asau     3604: <div class="sect2">
1.93      rillig   3605: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3606: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   3607: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  3608:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   3609:   problems. (To force patches to apply with fuzz you can set
                   3610:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 3611:   should contain only changes for a single file, and no file should be
1.93      rillig   3612:   patched by more than one patch file. This helps to keep future
                   3613:   modifications simple.</p>
                   3614: <p>Each patch file is structured as follows: In the first line,
                   3615:   there is the RCS Id of the patch itself. The second line should be
                   3616:   empty for aesthetic reasons. After that, there should be a comment for
                   3617:   each change that the patch does. There are a number of standard
                   3618:   cases:</p>
1.148     asau     3619: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3620: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93      rillig   3621:   mention the vulnerability ID (CAN, CVE).</p></li>
1.128     wiz      3622: <li class="listitem"><p>Patches that change source code should mention the
1.93      rillig   3623:   platform and other environment (for example, the compiler) that the
                   3624:   patch is needed for.</p></li>
                   3625: </ul></div>
1.219     rillig   3626: <p>The patch should be commented so that any
1.93      rillig   3627:   developer who knows the code of the application can make some use of
                   3628:   the patch. Special care should be taken for the upstream developers,
                   3629:   since we generally want that they accept our patches, so we have less
                   3630:   work in the future.</p>
                   3631: </div>
1.148     asau     3632: <div class="sect2">
1.93      rillig   3633: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3634: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   3635: <p>One important thing to mention is to pay attention that no RCS
                   3636:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      3637:   later checked into the NetBSD CVS tree. Use the
1.232     sevan    3638:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93      rillig   3639:   problems.</p>
1.87      wiz      3640: <p>For even more automation, we recommend using
1.110     hubertf  3641:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      3642:   whole set of patches. You just have to backup files before you
                   3643:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  3644:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3645:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      3646:   you upgrade a package this way, you can easily compare the new
                   3647:   set of patches with the previously existing one with
1.130     wiz      3648:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3649:   are replaced by new files, so carefully check if you want to take all
                   3650:   the changes.</p>
1.87      wiz      3651: <p>When you have finished a package, remember to generate
1.110     hubertf  3652:   the checksums for the patch files by using the <span class="command"><strong>make
1.128     wiz      3653:   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      3654: <p>When adding a patch that corrects a problem in the
                   3655:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3656:   man pages should go), send the patch as a bug report to the
                   3657:   maintainer.  This benefits non-pkgsrc users of the package,
                   3658:   and usually makes it possible to remove the patch in future
                   3659:   version.</p>
1.101     rillig   3660: <p>The file names of the patch files are usually of the form
1.130     wiz      3661:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3662:   Many packages still use the previous convention
                   3663:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3664:   but new patches should be of the form containing the filename.
1.232     sevan    3665:   <span class="command"><strong>mkpatches</strong></span> included in <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.130     wiz      3666:   automatically.</p>
1.93      rillig   3667: </div>
1.148     asau     3668: <div class="sect2">
1.93      rillig   3669: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3670: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      3671: <p>If you want to share patches between multiple packages
                   3672:   in pkgsrc, e.g. because they use the same distfiles, set
                   3673:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3674:   can be found, e.g.:</p>
                   3675: <pre class="programlisting">
1.100     rillig   3676: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   3677: </pre>
1.75      rillig   3678: <p>Patch files that are distributed by the author or other
1.87      wiz      3679:     maintainers can be listed in
                   3680:     <code class="varname">PATCHFILES</code>.</p>
                   3681: <p>If it is desired to store any patches that should not be
                   3682:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3683:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3684:     directory tree there is expected to have the same
1.128     wiz      3685:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.87      wiz      3686:     patches are expected to be stored inside these dirs (also
                   3687:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3688:     example, if you want to keep a private patch for
                   3689:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3690:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3691:     files in the named directory are expected to be patch files,
                   3692:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3693:     applied</em></span>.</p>
1.93      rillig   3694: </div>
1.148     asau     3695: <div class="sect2">
1.85      jmmv     3696: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3697: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     3698: <p>When fixing a portability issue in the code do not use
                   3699:       preprocessor magic to check for the current operating system nor
                   3700:       platform.  Doing so hurts portability to other platforms because
                   3701:       the OS-specific details are not abstracted appropriately.</p>
                   3702: <p>The general rule to follow is: instead of checking for the
                   3703:       operating system the application is being built on, check for the
                   3704:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3705:       instead of assuming that kqueue is available under NetBSD and
                   3706:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126     jakllsch 3707:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     3708:       yes, this generally involves patching the
1.110     hubertf  3709:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     3710:       that prevents some OSes from adopting interfaces from other OSes
                   3711:       (e.g. Linux implementing kqueue), something that the above checks
                   3712:       cannot take into account.</p>
                   3713: <p>Of course, checking for features generally involves more
                   3714:       work on the developer's side, but the resulting changes are
1.87      wiz      3715:       cleaner and there are chances they will work on many other
1.85      jmmv     3716:       platforms.  Not to mention that there are higher chances of being
                   3717:       later integrated into the mainstream sources.  Remember:
                   3718:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3719: <p>Some typical examples:</p>
                   3720: <div class="table">
1.106     rillig   3721: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.216     tnn      3722: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.85      jmmv     3723: <colgroup>
                   3724: <col>
                   3725: <col>
                   3726: <col>
                   3727: </colgroup>
                   3728: <thead><tr>
                   3729: <th>Where</th>
                   3730: <th>Incorrect</th>
                   3731: <th>Correct</th>
                   3732: </tr></thead>
                   3733: <tbody>
                   3734: <tr>
                   3735: <td>configure script</td>
                   3736: <td>
1.100     rillig   3737: <pre class="programlisting">
                   3738: case ${target_os} in
                   3739: netbsd*) have_kvm=yes ;;
                   3740: *)       have_kvm=no  ;;
                   3741: esac
                   3742: </pre>
1.85      jmmv     3743:              </td>
                   3744: <td>
1.100     rillig   3745: <pre class="programlisting">
                   3746: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   3747: </pre>
1.85      jmmv     3748:              </td>
                   3749: </tr>
                   3750: <tr>
                   3751: <td>C source file</td>
                   3752: <td>
1.100     rillig   3753: <pre class="programlisting">
                   3754: #if defined(__NetBSD__)
                   3755: #  include &lt;sys/event.h&gt;
                   3756: #endif
                   3757: </pre>
1.85      jmmv     3758:              </td>
                   3759: <td>
1.100     rillig   3760: <pre class="programlisting">
                   3761: #if defined(HAVE_SYS_EVENT_H)
                   3762: #  include &lt;sys/event.h&gt;
                   3763: #endif
                   3764: </pre>
1.85      jmmv     3765:              </td>
                   3766: </tr>
                   3767: <tr>
                   3768: <td>C source file</td>
                   3769: <td>
1.100     rillig   3770: <pre class="programlisting">
                   3771: int
                   3772: monitor_file(...)
                   3773: {
                   3774: #if defined(__NetBSD__)
                   3775:         int fd = kqueue();
                   3776:         ...
                   3777: #else
                   3778:         ...
                   3779: #endif
                   3780: }
                   3781: </pre>
1.85      jmmv     3782:              </td>
                   3783: <td>
1.100     rillig   3784: <pre class="programlisting">
                   3785: int
                   3786: monitor_file(...)
                   3787: {
                   3788: #if defined(HAVE_KQUEUE)
                   3789:         int fd = kqueue();
                   3790:         ...
                   3791: #else
1.223     rillig   3792:         ...
1.100     rillig   3793: #endif
                   3794: }
                   3795: </pre>
1.85      jmmv     3796:              </td>
                   3797: </tr>
                   3798: </tbody>
1.91      rillig   3799: </table></div>
1.85      jmmv     3800: </div>
1.91      rillig   3801: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110     hubertf  3802:       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
                   3803:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85      jmmv     3804:       2</a>).  It summarizes multiple details on how to make
                   3805:       software easier to package; all the suggestions in it were
                   3806:       collected from our experience in pkgsrc work, so they are possibly
                   3807:       helpful when creating patches too.</p>
                   3808: </div>
1.148     asau     3809: <div class="sect2">
1.85      jmmv     3810: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3811: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     3812: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3813:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3814:       improvements you do to a package to the mainstream developers.
                   3815:       This is the only way to get their attention on portability issues
                   3816:       and to ensure that future versions can be built out-of-the box on
                   3817:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3818:       the fixes straight from the packaged code.</p>
1.93      rillig   3819: <p>This generally involves cleaning up the patches
                   3820:       (because sometimes the patches that are
1.147     wiz      3821:       added to pkgsrc are quick hacks), filing bug reports in the
1.85      jmmv     3822:       appropriate trackers for the projects and working with the
                   3823:       mainstream authors to accept your changes.  It is
                   3824:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3825:       the packages in pkgsrc are kept simple and thus further changes
                   3826:       can be done without much hassle.</p>
1.130     wiz      3827: <p>When you have done this, please add a URL to the upstream
                   3828:       bug report to the patch comment.</p>
1.85      jmmv     3829: <p>Support the idea of free software!</p>
                   3830: </div>
1.75      rillig   3831: </div>
1.148     asau     3832: <div class="sect1">
1.75      rillig   3833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3834: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148     asau     3835: <div class="variablelist"><dl class="variablelist">
1.76      rillig   3836: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   3837: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      3838:          any credits where they are due.  Please bear in mind that others do not
                   3839:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3840:          will read everything that you write here.</p></dd>
1.76      rillig   3841: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      3842: <dd><p>This file governs the files that are installed on your
                   3843:          system: all the binaries, manual pages, etc. There are other
                   3844:          directives which may be entered in this file, to control the
                   3845:          creation and deletion of directories, and the location of
1.110     hubertf  3846:          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      3847:          information.</p></dd>
1.75      rillig   3848: </dl></div>
                   3849: </div>
1.148     asau     3850: <div class="sect1">
1.75      rillig   3851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3852: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148     asau     3853: <div class="sect2">
1.78      rillig   3854: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3855: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148     asau     3856: <div class="variablelist"><dl class="variablelist">
1.76      rillig   3857: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135     wiz      3858: <dd>
1.232     sevan    3859: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      3860:            First time after package extraction and before files are
                   3861:            moved in place, the second time after the files to install
                   3862:            are moved in place. This can be used to do any custom
                   3863:            procedures not possible with @exec commands in
1.232     sevan    3864:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   3865:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.0.2"><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      3866:            Please note that you can modify variables in it easily by using
                   3867:            <code class="varname">FILES_SUBST</code> in the package's
                   3868:            <code class="filename">Makefile</code>:</p>
                   3869: <pre class="programlisting">
                   3870: FILES_SUBST+=  SOMEVAR="somevalue"
                   3871: </pre>
                   3872: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3873:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3874:            performed for <code class="varname">PREFIX</code>,
                   3875:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3876:            <code class="varname">VARBASE</code>, and a few others, type
                   3877:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3878:            complete list.</p>
                   3879: </dd>
1.76      rillig   3880: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   3881: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      3882:            this script's responsibility to clean up any additional messy details
                   3883:            around the package's installation, since all pkg_delete knows is how to
                   3884:            delete the files created in the original distribution.
1.232     sevan    3885:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   3886:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135     wiz      3887:            The same methods to replace variables can be used as for
                   3888:            the <code class="filename">INSTALL</code> file.</p></dd>
1.76      rillig   3889: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   3890: <dd>
                   3891: <p>This file is displayed after installation of the package.
1.87      wiz      3892:            Useful for things like legal notices on almost-free
                   3893:            software and hints for updating config files after
                   3894:            installing modules for apache, PHP etc.
                   3895:            Please note that you can modify variables in it easily by using
                   3896:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3897:            <code class="filename">Makefile</code>:</p>
1.75      rillig   3898: <pre class="programlisting">
1.100     rillig   3899: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   3900: </pre>
1.128     wiz      3901: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.87      wiz      3902:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3903:            performed for <code class="varname">PKGNAME</code>,
                   3904:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.209     sevan    3905:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.87      wiz      3906:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3907:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  3908:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      3909: <p>You can display a different or additional files by
                   3910:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3911:            default is <code class="filename">MESSAGE</code>, if the file
                   3912:            exists.</p>
1.75      rillig   3913: </dd>
1.78      rillig   3914: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174     asau     3915: <dd>
                   3916: <p>This file is used by the alternatives framework.
                   3917:            It creates, configures, and destroys generic wrappers used to
                   3918:            run programs with similar interfaces.
                   3919:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3920:             for more information.</p>
                   3921: <p>Each line of the file contains two filenames, first
                   3922:            the wrapper and then the alternative provided by the package.
                   3923:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3924: </dd>
1.78      rillig   3925: </dl></div>
                   3926: </div>
1.148     asau     3927: <div class="sect2">
1.78      rillig   3928: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3929: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148     asau     3930: <div class="variablelist"><dl class="variablelist">
1.78      rillig   3931: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3932: <dd><p>This file contains arbitrary things that could
                   3933:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3934:        to be used by more than one package. This file should only be
                   3935:        used when the packages that will use the file are known in
                   3936:        advance. For other purposes it is often better to write a
                   3937:        <code class="filename">*.mk</code> file and give it a good name that
                   3938:        describes what it does.</p></dd>
                   3939: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3940: <dd><p>This file contains the dependency information
1.110     hubertf  3941:        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   3942: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3943: <dd><p>This file contains workarounds for compiler bugs
                   3944:        and similar things. It is included automatically by the pkgsrc
                   3945:        infrastructure, so you don't need an extra
                   3946:        <code class="literal">.include</code> line for
                   3947:        it.</p></dd>
                   3948: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3949: <dd><p>This file contains the code for the
1.110     hubertf  3950:        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   3951:        selected by the user. If a package has only one or two options,
                   3952:        it is equally acceptable to put the code directly into the
                   3953:        <code class="filename">Makefile</code>.</p></dd>
                   3954: </dl></div>
                   3955: </div>
1.148     asau     3956: <div class="sect2">
1.78      rillig   3957: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3958: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148     asau     3959: <div class="variablelist"><dl class="variablelist">
1.78      rillig   3960: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   3961: <dd><p>These files do not take place in the creation of
                   3962:        a package and thus are purely informative to the package
                   3963:        developer.</p></dd>
                   3964: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   3965: <dd><p>This file contains things that need to be done
                   3966:        to make the package even
                   3967:        better.</p></dd>
1.75      rillig   3968: </dl></div>
                   3969: </div>
1.78      rillig   3970: </div>
1.148     asau     3971: <div class="sect1">
1.75      rillig   3972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3973: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   3974: </h2></div></div></div>
1.110     hubertf  3975: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      3976:     unpacked into the directory denoted by
                   3977:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  3978:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      3979:     directory is also used to keep various timestamp files.
                   3980:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   3981:     The default is <code class="filename">${.CURDIR}/work</code>
                   3982:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   3983:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   3984: </div>
1.148     asau     3985: <div class="sect1">
1.75      rillig   3986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3987: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   3988: </h2></div></div></div>
1.75      rillig   3989: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      3990:     to configuration or building, you could place these files here and use
1.110     hubertf  3991:     a <span class="command"><strong>${CP}</strong></span> command in the
1.128     wiz      3992:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.87      wiz      3993:     this. Alternatively, you could simply diff the file against
                   3994:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   3995:     the creation of this file.</p>
                   3996: <p>If you want to share files in this way with other
                   3997:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   3998:     to the other package's <code class="filename">files</code> directory,
                   3999:     e.g.:</p>
                   4000: <pre class="programlisting">
1.100     rillig   4001: FILESDIR=${.CURDIR}/../xemacs/files
                   4002: </pre>
1.75      rillig   4003: </div>
                   4004: </div>
1.148     asau     4005: <div class="chapter">
1.75      rillig   4006: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4007: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4008: <div class="toc">
                   4009: <p><b>Table of Contents</b></p>
1.210     leot     4010: <dl class="toc">
1.106     rillig   4011: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      4012: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   4013: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4014: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4015: <dd><dl>
                   4016: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228     yyamano  4017: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220     wiz      4018: <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>
                   4019: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.75      rillig   4020: </dl></dd>
                   4021: </dl>
                   4022: </div>
1.76      rillig   4023: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4024:   each of which forms a well-defined part of the pkgsrc system. Using
1.232     sevan    4025:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75      rillig   4026:   like pkgsrc requires some discipline to keep the code correct and
                   4027:   understandable.</p>
1.76      rillig   4028: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4029:   programming are variables (which are actually macros) and shell
                   4030:   commands. Among these shell commands may even be more complex ones
1.232     sevan    4031:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75      rillig   4032:   as intended it is necessary to quote all variables correctly when they
                   4033:   are used.</p>
                   4034: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4035:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4036:   with them.</p>
1.148     asau     4037: <div class="sect1">
1.75      rillig   4038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4039: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148     asau     4040: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97      rillig   4041: <p>When you are creating a file as a
                   4042:     target of a rule, always write the data to a temporary file first
                   4043:     and finally rename that file. Otherwise there might occur an error
                   4044:     in the middle of generating the file, and when the user runs
1.232     sevan    4045:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><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   4046:     regenerated properly. Example:</p>
                   4047: <pre class="programlisting">
1.100     rillig   4048: wrong:
                   4049:         @echo "line 1" &gt; ${.TARGET}
                   4050:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4051:         @false
                   4052: 
                   4053: correct:
                   4054:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4055:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4056:         @false
                   4057:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4058: </pre>
1.110     hubertf  4059: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4060:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4061:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4062:     correct</strong></span> gives an error message twice, as expected.</p>
1.232     sevan    4063: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97      rillig   4064:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4065:     happens when it is interrupted, for example by pressing
                   4066:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.232     sevan    4067:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97      rillig   4068: </li></ul></div>
                   4069: </div>
1.148     asau     4070: <div class="sect1">
1.97      rillig   4071: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4072: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4073: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4074:     can be processed using the five operators ``='', ``+='', ``?='',
1.232     sevan    4075:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75      rillig   4076:     page.</p>
                   4077: <p>When a variable's value is parsed from a
1.76      rillig   4078:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4079:     backslash character ``\'' are handled specially. If a backslash is
                   4080:     followed by a newline, any whitespace immediately in front of the
                   4081:     backslash, the backslash, the newline, and any whitespace
                   4082:     immediately behind the newline are replaced with a single space. A
                   4083:     backslash character and an immediately following hash character are
                   4084:     replaced with a single hash character. Otherwise, the backslash is
                   4085:     passed as is. In a variable assignment, any hash character that is
                   4086:     not preceded by a backslash starts a comment that continues upto the
                   4087:     end of the logical line.</p>
1.219     rillig   4088: <p>The evaluation of variables either happens immediately or lazy.
                   4089:     It happens immediately when the variable occurs
                   4090:     on the right-hand side of the ``:='' or the ``!='' operator, in a
                   4091:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   4092:     In the other cases, it is evaluated lazily.</p>
1.75      rillig   4093: <p>Some of the modifiers split the string into words and then
                   4094:     operate on the words, others operate on the string as a whole. When
1.232     sevan    4095:     a string is split into words, it is split like in <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.75      rillig   4096: <p>There are several types of variables that should be handled
                   4097:     differently. Strings and two types of lists.</p>
1.148     asau     4098: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4099: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75      rillig   4100:       characters. Nevertheless, you should restrict yourself to only
                   4101:       using printable characters. Examples are
                   4102:       <code class="varname">PREFIX</code> and
                   4103:       <code class="varname">COMMENT</code>.</p></li>
1.128     wiz      4104: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75      rillig   4105:       are never exported to any shell command. Their elements are
                   4106:       separated by whitespace. Therefore, the elements themselves cannot
                   4107:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  4108:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   4109:       Examples are <code class="varname">DEPENDS</code> and
                   4110:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128     wiz      4111: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75      rillig   4112:       may be exported to a shell command. Their elements can contain any
                   4113:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  4114:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   4115:       <code class="varname">DISTFILES</code> and
                   4116:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4117: </ul></div>
1.148     asau     4118: <div class="sect2">
1.75      rillig   4119: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4120: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148     asau     4121: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4122: <li class="listitem"><p>All variable names starting with an underscore
1.75      rillig   4123:        are reserved for use by the pkgsrc infrastructure. They shall
                   4124:        not be used by package
1.76      rillig   4125:        <code class="filename">Makefile</code>s.</p></li>
1.128     wiz      4126: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4127:        lowercase variable names for the iteration
                   4128:        variables.</p></li>
1.128     wiz      4129: <li class="listitem"><p>All list variables should have a ``plural''
1.75      rillig   4130:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4131:        <code class="varname">DISTFILES</code>.</p></li>
                   4132: </ul></div>
                   4133: </div>
                   4134: </div>
1.148     asau     4135: <div class="sect1">
1.75      rillig   4136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4137: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.148     asau     4138: <div class="sect2">
1.75      rillig   4139: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4140: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.220     wiz      4141: <p>When adding a string that possibly contains whitespace or quotes to
                   4142: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   4143: modifier.</p>
                   4144: <p>When adding another list to a list (example 2), it must not be
                   4145: quoted, since its elements are already quoted.</p>
1.75      rillig   4146: <pre class="programlisting">
1.220     wiz      4147: STRING=         foo * bar `date`
                   4148: LIST=           # empty
                   4149: ANOTHER_LIST=   a=b c=d
                   4150: 
                   4151: LIST+=          ${STRING:Q}       # 1
                   4152: LIST+=          ${ANOTHER_LIST}   # 2
                   4153: </pre>
1.75      rillig   4154: </div>
1.148     asau     4155: <div class="sect2">
1.75      rillig   4156: <div class="titlepage"><div><div><h3 class="title">
1.228     yyamano  4157: <a name="echo-literal"></a>12.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.220     wiz      4158: <p>Echoing a string containing special characters needs special
                   4159: work.</p>
1.75      rillig   4160: <pre class="programlisting">
1.100     rillig   4161: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
1.219     rillig   4162: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
1.1       grant    4163: 
1.100     rillig   4164: all:
                   4165:         echo ${STRING}                  # 1
1.219     rillig   4166:         echo ${STRING:Q}                # 2
                   4167:         printf '%s\n' ${STRING:Q}''     # 3
1.220     wiz      4168:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.1       grant    4169: </pre>
1.220     wiz      4170: <p>Example 1 leads to a syntax error in the shell, as the characters
                   4171: are just copied.</p>
                   4172: <p>Example 2 quotes the string so that the shell interprets it
                   4173: correctly. But the echo command may additionally interpret strings with a
                   4174: leading dash or those containing backslashes.</p>
1.232     sevan    4175: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.220     wiz      4176: interprets the format string, but not the next argument.</p>
                   4177: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   4178: need to be quoted because the quoting has already been done
                   4179: when adding elements to the list.</p>
1.75      rillig   4180: </div>
1.148     asau     4181: <div class="sect2">
1.75      rillig   4182: <div class="titlepage"><div><div><h3 class="title">
1.220     wiz      4183: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   4184: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   4185: GNU-style configure script (especially those that call other configure
                   4186: scripts), it must not have leading or trailing whitespace, since
                   4187: otherwise the configure script gets confused. To trim leading and
                   4188: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   4189: following example:</p>
1.75      rillig   4190: <pre class="programlisting">
1.100     rillig   4191: CPPFLAGS=               # empty
1.220     wiz      4192: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
1.100     rillig   4193: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4194: 
                   4195: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4196: 
                   4197: all:
                   4198:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
1.220     wiz      4199:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
1.1       grant    4200: </pre>
1.220     wiz      4201: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   4202: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   4203: space.</p>
                   4204: </div>
                   4205: <div class="sect2">
                   4206: <div class="titlepage"><div><div><h3 class="title">
                   4207: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
                   4208: <p>When a possibly empty variable is used in a shell program, it may
                   4209: lead to a syntax error.</p>
                   4210: <pre class="programlisting">
                   4211: EGFILES=        # empty
                   4212: 
                   4213: install-examples:   # produces a syntax error in the shell
                   4214:         for egfile in ${EGFILES}; do            \
                   4215:                 echo "Installing $$egfile";     \
                   4216:         done
                   4217: </pre>
                   4218: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.232     sevan    4219: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.220     wiz      4220: To fix this syntax error, use one of the snippets below.</p>
                   4221: <pre class="programlisting">
                   4222: EMPTY=          # empty
                   4223: 
                   4224: install-examples:
                   4225:         for egfile in ${EGFILES} ""; do         \
                   4226:                 [ -n "$$egfile" ] || continue;  \
                   4227:                 echo "Installing $$egfile";     \
1.100     rillig   4228:         done
1.220     wiz      4229: </pre>
                   4230: <p>In this case, an empty string is appended to the iteration list (to
                   4231: prevent the syntax error) and filtered out later.</p>
                   4232: <pre class="programlisting">
                   4233: EGFILES=        # empty
1.100     rillig   4234: 
1.220     wiz      4235: install-examples:
                   4236: .for egfile in ${EGFILES}
                   4237:         echo "Installing ${egfile}"
1.100     rillig   4238: .endfor
1.1       grant    4239: </pre>
1.220     wiz      4240: <p>This variant only works when <code class="varname">EGFILES</code> does not
                   4241: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
                   4242: simple whitespace.</p>
                   4243: <p>To have a shell command test whether a make variable is empty, use
                   4244: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.75      rillig   4245: </div>
                   4246: </div>
                   4247: </div>
1.148     asau     4248: <div class="chapter">
1.75      rillig   4249: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4250: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   4251: <div class="toc">
                   4252: <p><b>Table of Contents</b></p>
1.210     leot     4253: <dl class="toc">
1.106     rillig   4254: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      4255: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   4256: <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   4257: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   4258: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      4259: <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   4260: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz      4261: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   4262: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.75      rillig   4263: </dl>
                   4264: </div>
1.87      wiz      4265: <p>The <code class="filename">PLIST</code> file contains a package's
1.128     wiz      4266:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.87      wiz      4267:   the package (relative to the <code class="filename">${PREFIX}</code>
                   4268:   directory it's been installed in) plus some additional statements
1.232     sevan    4269:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87      wiz      4270:   This chapter addresses some issues that need attention when
                   4271:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   4272:   below!).</p>
1.148     asau     4273: <div class="sect1">
1.75      rillig   4274: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4275: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      4276: <p>Be sure to add a RCS ID line as the first thing in any
                   4277:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   4278: <pre class="programlisting">
1.233     sevan    4279: @comment $NetBSD $
1.222     sevan    4280: </pre>
1.235     yyamano  4281: <p>An artificial space has been added between NetBSD and $, this is a
1.233     sevan    4282: workaround here to prevent CVS expanding to the filename of the guide. When
                   4283: adding the RCS ID the space should be ommited.</p>
1.75      rillig   4284: </div>
1.148     asau     4285: <div class="sect1">
1.75      rillig   4286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4287: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  4288: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      4289:     to output a PLIST that matches any new files since the package
1.110     hubertf  4290:     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      4291:     more information on this target.</p>
1.75      rillig   4292: </div>
1.148     asau     4293: <div class="sect1">
1.75      rillig   4294: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  4295: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   4296: </h2></div></div></div>
1.87      wiz      4297: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   4298:     of AWK patterns and actions that are used to filter the output of
                   4299:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   4300:     scripting you like to it, but be careful with quoting.</p>
                   4301: <p>For example, to get all files inside the
                   4302:     <code class="filename">libdata/foo</code> directory removed from the
                   4303:     resulting PLIST:</p>
                   4304: <pre class="programlisting">
1.100     rillig   4305: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.222     sevan    4306: </pre>
1.75      rillig   4307: </div>
1.148     asau     4308: <div class="sect1">
1.75      rillig   4309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4310: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      4311: <p>A number of variables are substituted automatically in
                   4312:     PLISTs when a package is installed on a system. This includes the
                   4313:     following variables:</p>
1.148     asau     4314: <div class="variablelist"><dl class="variablelist">
1.75      rillig   4315: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   4316: <dd>
                   4317: <p>Some packages like emacs and perl embed information
1.87      wiz      4318:          about which architecture they were built on into the
                   4319:          pathnames where they install their files. To handle this
                   4320:          case, PLIST will be preprocessed before actually used, and
                   4321:          the symbol
1.128     wiz      4322:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.110     hubertf  4323:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      4324:          same is done if the string
                   4325:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   4326:          PLIST somewhere - use this on packages that have GNU
                   4327:          autoconf-created configure scripts.</p>
1.148     asau     4328: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   4329: <h3 class="title">Legacy note</h3>
                   4330: <p>There used to be a symbol
1.128     wiz      4331:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.110     hubertf  4332:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      4333:            -m</strong></span>, but that's no longer supported and has
                   4334:            been removed.</p>
1.75      rillig   4335: </div>
                   4336: </dd>
                   4337: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   4338: <dd>
                   4339: <p>Some packages want to embed the OS name and version
1.87      wiz      4340:          into some paths.  To do this, use these variables in the
                   4341:          <code class="filename">PLIST</code>:
                   4342:          </p>
1.148     asau     4343: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4344: <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>
                   4345: <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>
                   4346: <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   4347: </ul></div>
                   4348: </dd>
                   4349: </dl></div>
1.199     tnn      4350: <p>For a list of values which are replaced by
                   4351:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   4352: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   4353: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87      wiz      4354: <p>If you want to change other variables not listed above, you
                   4355:     can add variables and their expansions to this variable in the
1.110     hubertf  4356:     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   4357: <pre class="programlisting">
1.100     rillig   4358: PLIST_SUBST+=   SOMEVAR="somevalue"
1.222     sevan    4359: </pre>
1.128     wiz      4360: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.87      wiz      4361:     in the <code class="filename">PLIST</code> with
1.128     wiz      4362:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.120     snj      4363: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119     mishka   4364:     the common case of conditionally including some
                   4365:     <code class="filename">PLIST</code> entries. It can be done by adding
                   4366:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120     snj      4367:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   4368:     to <code class="literal">yes</code> if the entry should be included.
1.128     wiz      4369:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.119     mishka   4370:     in the <code class="filename">PLIST</code> with either
1.128     wiz      4371:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   4372:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.119     mishka   4373:     For example, in <code class="filename">Makefile</code>:</p>
                   4374: <pre class="programlisting">
1.223     rillig   4375: PLIST_VARS+=    foo
1.119     mishka   4376: .if <em class="replaceable"><code>condition</code></em>
1.223     rillig   4377: PLIST.foo=      yes
1.119     mishka   4378: .else
1.222     sevan    4379: </pre>
1.119     mishka   4380: <p>And then in <code class="filename">PLIST</code>:</p>
                   4381: <pre class="programlisting">
1.233     sevan    4382: @comment $NetBSD $
1.119     mishka   4383: bin/bar
                   4384: man/man1/bar.1
                   4385: ${PLIST.foo}bin/foo
                   4386: ${PLIST.foo}man/man1/foo.1
                   4387: ${PLIST.foo}share/bar/foo.data
1.222     sevan    4388: </pre>
1.235     yyamano  4389: <p>An artificial space has been added between NetBSD and $, this is a
1.233     sevan    4390: workaround here to prevent CVS expanding to the filename of the guide. When
                   4391: adding the RCS ID the space should be ommited.</p>
1.75      rillig   4392: </div>
1.148     asau     4393: <div class="sect1">
1.75      rillig   4394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4395: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   4396: <p>Man pages should be installed in compressed form if
1.87      wiz      4397:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   4398:     and uncompressed otherwise. To handle this in the
1.128     wiz      4399:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.87      wiz      4400:     appended/removed automatically for man pages according to
                   4401:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   4402:     or not, see above for details. This modification of the
                   4403:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   4404:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   4405: </div>
1.148     asau     4406: <div class="sect1">
1.75      rillig   4407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4408: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   4409: </h2></div></div></div>
1.76      rillig   4410: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      4411:     in generating the binary package, set the variable
                   4412:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.232     sevan    4413:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87      wiz      4414:     important. The default for <code class="varname">PLIST_SRC</code> is
                   4415:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   4416: </div>
1.148     asau     4417: <div class="sect1">
1.75      rillig   4418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4419: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   4420: <p>Some packages decide to install a different set of files based on
1.87      wiz      4421:     the operating system being used. These differences can be
                   4422:     automatically handled by using the following files:</p>
1.148     asau     4423: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4424: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   4425: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   4426: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   4427: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   4428: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   4429: </ul></div>
                   4430: </div>
1.148     asau     4431: <div class="sect1">
1.75      rillig   4432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.197     wiz      4433: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
                   4434: <p>Some packages decide to generate hard-to-guess file names
                   4435:     during installation that are hard to wire down.</p>
                   4436: <p>In such cases, you can set the
                   4437:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   4438:     terminated (with a semicolon) that will output PLIST entries which
                   4439:     will be appended to the PLIST</p>
                   4440: <p>You can find one example in editors/xemacs:</p>
                   4441: <pre class="programlisting">
1.222     sevan    4442: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   4443: </pre>
1.197     wiz      4444: <p>which will append something like
                   4445:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   4446:     <code class="filename">PLIST</code>.
                   4447:     </p>
                   4448: </div>
                   4449: <div class="sect1">
                   4450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4451: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.128     wiz      4452: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.87      wiz      4453:     multiple (and unrelated) packages install files.  These
1.125     wiz      4454:     directories were problematic because you had to add special
                   4455:     tricks in the PLIST to conditionally remove them, or have some
1.87      wiz      4456:     centralized package handle them.</p>
1.125     wiz      4457: <p>In pkgsrc, it is now easy: Each package should create
                   4458:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   4459:     will remove any directories left empty after uninstalling a
                   4460:     package.</p>
                   4461: <p>If a package needs an empty directory to work, create
                   4462:     the directory during installation as usual, and also add an
                   4463:     entry to the PLIST:
1.222     sevan    4464: 
                   4465: </p>
1.87      wiz      4466: <pre class="programlisting">
1.125     wiz      4467: @pkgdir path/to/empty/directory
1.222     sevan    4468: </pre>
1.125     wiz      4469: <p>
1.222     sevan    4470: 
1.197     wiz      4471:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   4472:     <code class="varname">OWN_DIRS</code>.
1.125     wiz      4473:     </p>
1.75      rillig   4474: </div>
                   4475: </div>
1.148     asau     4476: <div class="chapter">
1.75      rillig   4477: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4478: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   4479: <div class="toc">
                   4480: <p><b>Table of Contents</b></p>
1.210     leot     4481: <dl class="toc">
1.106     rillig   4482: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      4483: <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   4484: <dd><dl>
1.106     rillig   4485: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      4486: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   4487:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4488:       and
                   4489:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4490:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   4491: </dl></dd>
1.128     wiz      4492: <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   4493: <dd><dl>
1.128     wiz      4494: <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   4495: <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   4496: </dl></dd>
                   4497: </dl>
                   4498: </div>
                   4499: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      4500:   are seen by a package's configure and build processes.  This is implemented
                   4501:   in a two step process:</p>
1.128     wiz      4502: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4503: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87      wiz      4504:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   4505:       of <code class="varname">WRKDIR</code>.</p></li>
1.128     wiz      4506: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      4507:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   4508:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   4509:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   4510:       native compiler on some operating systems look like GCC, so that
                   4511:       packages that expect GCC won't require modifications to build with
                   4512:       those native compilers.</p></li>
1.75      rillig   4513: </ol></div>
                   4514: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      4515:   package may be built consistently despite what other software may be
                   4516:   installed. Please note that the normal system header and library paths,
                   4517:   e.g. <code class="filename">/usr/include</code>,
                   4518:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   4519:   designed to insulate the package build from non-system-supplied
                   4520:   software.</p>
1.148     asau     4521: <div class="sect1">
1.75      rillig   4522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4523: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   4524: <p>The process of converting packages to use the buildlink3
1.128     wiz      4525:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.87      wiz      4526:     The things to keep in mind are:</p>
1.128     wiz      4527: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4528: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87      wiz      4529:        instead of the actual toolchain.  Some packages are tricky,
                   4530:        and the only way to know for sure is the check
                   4531:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   4532:        wrappers are being invoked.</p></li>
1.128     wiz      4533: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87      wiz      4534:        the package Makefile, e.g. Java VMs, standalone shells,
                   4535:        etc., because the code to symlink files into
                   4536:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128     wiz      4537:        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      4538:        </p></li>
1.128     wiz      4539: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87      wiz      4540:        <code class="filename">buildlink3.mk</code> files that you list in a
                   4541:        package's Makefile are added as dependencies for that package.
                   4542:        </p></li>
1.75      rillig   4543: </ol></div>
1.87      wiz      4544: <p>If a dependency on a particular package is required for its libraries and
                   4545:     headers, then we replace:</p>
1.75      rillig   4546: <pre class="programlisting">
1.100     rillig   4547: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   4548: </pre>
1.75      rillig   4549: <p>with</p>
                   4550: <pre class="programlisting">
1.100     rillig   4551: .include "../../category/foo/buildlink3.mk"
                   4552: </pre>
1.75      rillig   4553: <p>The buildlink3.mk files usually define the required dependencies.
                   4554:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      4555:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   4556: <pre class="programlisting">
1.100     rillig   4557: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   4558: .include "../../category/foo/buildlink3.mk"
                   4559: </pre>
1.76      rillig   4560: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      4561:     files in <code class="filename">pkgsrc/mk</code>
                   4562:     that handle special package issues:</p>
1.148     asau     4563: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4564: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      4565:        the native or a pkgsrc Berkeley DB implementation based on
                   4566:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   4567:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128     wiz      4568: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      4569:        comes with neither Curses nor NCurses, this will take care
1.232     sevan    4570:        to install the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.128     wiz      4571: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      4572:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   4573:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   4574:        require a Kerberos 5 implementation.</p></li>
1.128     wiz      4575: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88      wiz      4576:        system-provided Motif installation or adds a dependency on
1.232     sevan    4577:        <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a> or <a href="http://cdn.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      4578:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.151     obache   4579:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span> or
                   4580:        <span class="quote">&#8220;<span class="quote">openmotif</span>&#8221;</span> to choose
1.88      wiz      4581:        which Motif version will be used.</p></li>
1.161     ryoon    4582: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162     wiz      4583:        system-provided GNU readline or editline (libedit) installation,
1.232     sevan    4584:        or adds a dependency on <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
                   4585:        <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.161     ryoon    4586:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   4587:        If your package really needs GNU readline library, its Makefile
                   4588:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   4589:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128     wiz      4590: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      4591:        variables that may be used by packages that use the
                   4592:        Open Sound System (OSS) API.</p></li>
1.128     wiz      4593: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142     wiz      4594:        any of the Postgres versions in the variable
                   4595:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   4596:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87      wiz      4597:        the file for more information.</p></li>
1.128     wiz      4598: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      4599:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.232     sevan    4600:        a dependency on <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.128     wiz      4601: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      4602:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   4603:        library.</p></li>
1.75      rillig   4604: </ul></div>
1.76      rillig   4605: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      4606:     files provide a more complete
                   4607:     description of how to use them properly.</p>
1.75      rillig   4608: </div>
1.148     asau     4609: <div class="sect1">
1.75      rillig   4610: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4611: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   4612: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      4613:     included by Makefiles to indicate the need to compile and link
                   4614:     against header files and libraries provided by the package.  A
                   4615:     <code class="filename">buildlink3.mk</code> file should always provide
                   4616:     enough information to add the correct type of dependency
                   4617:     relationship and include any other
                   4618:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   4619:     headers and libraries that it needs in turn.</p>
                   4620: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.232     sevan    4621:     file for further editing, Rene Hexel's <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87      wiz      4622:     package is highly recommended.  For most packages, the following
                   4623:     command will generate a good starting point for
                   4624:     <code class="filename">buildlink3.mk</code> files:</p>
                   4625: <pre class="screen">
                   4626: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   4627: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   4628:     </pre>
1.148     asau     4629: <div class="sect2">
1.75      rillig   4630: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4631: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   4632: <p>The following real-life example
1.87      wiz      4633:       <code class="filename">buildlink3.mk</code> is taken
                   4634:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   4635: <pre class="programlisting">
1.120     snj      4636: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       grant    4637: 
1.223     rillig   4638: BUILDLINK_TREE+=        tiff
1.1       grant    4639: 
1.120     snj      4640: .if !defined(TIFF_BUILDLINK3_MK)
                   4641: TIFF_BUILDLINK3_MK:=
1.87      wiz      4642: 
1.223     rillig   4643: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   4644: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   4645: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
1.87      wiz      4646: 
1.100     rillig   4647: .include "../../devel/zlib/buildlink3.mk"
                   4648: .include "../../graphics/jpeg/buildlink3.mk"
1.120     snj      4649: .endif # TIFF_BUILDLINK3_MK
1.87      wiz      4650: 
1.223     rillig   4651: BUILDLINK_TREE+=        -tiff
1.100     rillig   4652: </pre>
1.87      wiz      4653: <p>The header and footer manipulate
1.120     snj      4654:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87      wiz      4655:       <code class="filename">buildlink3.mk</code> files and is used to track
1.120     snj      4656:       the dependency tree.</p>
                   4657: <p>The main section is protected from multiple inclusion
1.87      wiz      4658:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   4659:       added.  Several important variables are set in the section:</p>
1.148     asau     4660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4661: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4662:          is the actual dependency recorded in the installed
                   4663:          package; this should always be set using
1.110     hubertf  4664:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      4665:          we're appending to any pre-existing list of values.  This
                   4666:          variable should be set to the first version of the
1.133     wiz      4667:          package that had an backwards-incompatible API change.
1.87      wiz      4668:          </p></li>
1.128     wiz      4669: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4670:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   4671:          pkgsrc directory.</p></li>
1.128     wiz      4672: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4673:          (not shown above) controls whether we use
                   4674:          <code class="varname">BUILD_DEPENDS</code> or
                   4675:          <code class="varname">DEPENDS</code> to add the dependency on
                   4676:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   4677:          selected by setting
                   4678:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4679:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.87      wiz      4680:          used.</p></li>
1.128     wiz      4681: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4682:            and
                   4683:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   4684:            (not shown above) are lists of subdirectories of
1.76      rillig   4685:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   4686:            to add to the header and library search paths.  These
1.128     wiz      4687:            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      4688:          respectively.</p></li>
1.128     wiz      4689: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4690:            (not shown above) is the list of preprocessor flags to add
                   4691:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128     wiz      4692:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.75      rillig   4693:            should be avoided and instead be handled using
                   4694:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      4695:          above.</p></li>
1.75      rillig   4696: </ul></div>
1.87      wiz      4697: <p>The following variables are all optionally defined within
                   4698:       this second section (protected against multiple inclusion) and
                   4699:       control which package files are symlinked into
                   4700:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   4701:       transformed during the symlinking:</p>
1.148     asau     4702: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4703: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4704:            (not shown above) is a shell glob pattern relative to
1.76      rillig   4705:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   4706:            to be symlinked into
1.76      rillig   4707:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      4708:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.128     wiz      4709: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4710:            (not shown above) is a shell pipeline that
                   4711:            outputs to stdout a list of files relative to
                   4712:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   4713:            The resulting files are to be symlinked
                   4714:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   4715:            this takes the <code class="filename">+CONTENTS</code> of a
                   4716:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   4717:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128     wiz      4718: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4719:            (not shown above) is a filter command that filters
1.76      rillig   4720:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   4721:            relative to
1.76      rillig   4722:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194     bsiegert 4723:            on stdout.  By default,
1.75      rillig   4724:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   4725:            outputs the contents of the <code class="filename">include</code>
                   4726:            and <code class="filename">lib</code> directories in the package
1.194     bsiegert 4727:            <code class="filename">+CONTENTS</code>.</p></li>
1.128     wiz      4728: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4729:            (not shown above) is a list of sed arguments used to
                   4730:            transform the name of the source filename into a
1.110     hubertf  4731:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      4732:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   4733: </ul></div>
1.120     snj      4734: <p>This section can additionally include any
1.87      wiz      4735:       <code class="filename">buildlink3.mk</code> needed for
                   4736:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   4737:       Including these <code class="filename">buildlink3.mk</code> files
                   4738:       means that the headers and libraries for these
                   4739:       dependencies are also symlinked into
                   4740:       <code class="filename">${BUILDLINK_DIR}</code>
                   4741:       whenever the <em class="replaceable"><code>pkg</code></em>
                   4742:       <code class="filename">buildlink3.mk</code>
1.120     snj      4743:       file is included. Dependencies are only added for directly
                   4744:       include <code class="filename">buildlink3.mk</code> files.</p>
1.153     wiz      4745: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   4746:       including other <code class="filename">buildlink3.mk</code> files in it,
1.156     wiz      4747:       please only add necessary ones, i.e., those whose libraries or
1.153     wiz      4748:       header files are automatically exposed when the package is
                   4749:       use.</p>
                   4750: <p>In particular, if only an executable
                   4751:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   4752:       library does not need to be propagated in the
                   4753:       <code class="filename">buildlink3.mk</code> file.</p>
                   4754: <p>The following steps should help you decide if a
                   4755:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   4756:       </p>
                   4757: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4758: <li class="listitem"><p>Look at the installed header files: What
                   4759:        headers do they include? The packages providing these files
                   4760:        must be buildlinked.</p></li>
1.155     wiz      4761: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   4762:        libraries and look against what other libraries they link.
                   4763:        Some of the packages providing these probably need to be
                   4764:        buildlinked; however, it's not automatic, since e.g. GTK on
                   4765:        some systems pulls in the X libraries, so they will show up in
                   4766:        the <code class="filename">ldd</code> output, while on others (like OS
1.156     wiz      4767:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.155     wiz      4768:        used as a hint.</p></li>
1.153     wiz      4769: </ul></div>
                   4770: <p>
                   4771:       </p>
1.75      rillig   4772: </div>
1.148     asau     4773: <div class="sect2">
1.75      rillig   4774: <div class="titlepage"><div><div><h3 class="title">
1.133     wiz      4775: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87      wiz      4776:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      4777:       and
                   4778:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4779:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   4780: <p>These two variables differ in that one describes source
                   4781:       compatibility (API) and the other binary compatibility (ABI).
                   4782:       The difference is that a change in the API breaks compilation of
                   4783:       programs while changes in the ABI stop compiled programs from
                   4784:       running.</p>
                   4785: <p>Changes to the
1.134     wiz      4786:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      4787:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   4788:       very rarely. One possible reason is that all packages depending
                   4789:       on this already need a newer version. In case it is bumped see
                   4790:       the description below.</p>
                   4791: <p>The most common example of an ABI change is that the major
                   4792:       version of a shared library is increased. In this case,
                   4793:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4794:       should be adjusted to require at least the new package version.
                   4795:       Then the packages that depend on this package need their
                   4796:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   4797:       <code class="filename">buildlink3.mk</code> files, their
                   4798:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4799:       adjusted, too. This is needed so pkgsrc will require the correct
                   4800:       package dependency and not settle for an older one when building
                   4801:       the source.</p>
1.218     rillig   4802: <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      4803:       more information about dependencies on other packages,
                   4804:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      4805:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   4806: <p>Please take careful consideration before adjusting
                   4807:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4808:       or
                   4809:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4810:       as we don't want to cause unneeded package deletions and
                   4811:       rebuilds.  In many cases, new versions of packages work just
                   4812:       fine with older dependencies.</p>
                   4813: <p>Also it is not needed to set
1.133     wiz      4814:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4815:       when it is identical to
1.87      wiz      4816:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   4817: </div>
                   4818: </div>
1.148     asau     4819: <div class="sect1">
1.75      rillig   4820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4821: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      4822: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   4823:       coincide with headers and libraries present in the base system.
1.76      rillig   4824:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   4825:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   4826:       file that includes the necessary checks to decide whether using
                   4827:       the built-in software or the pkgsrc software is
1.87      wiz      4828:     appropriate.</p>
                   4829: <p>The only requirements of a builtin.mk file for
                   4830:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.128     wiz      4831: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4832: <li class="listitem"><p>It should set
1.87      wiz      4833:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4834:        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      4835:        after it is included.</p></li>
1.128     wiz      4836: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87      wiz      4837:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4838:        which is already set before the
                   4839:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.128     wiz      4840: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.87      wiz      4841:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   4842:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   4843: </ol></div>
1.148     asau     4844: <div class="sect2">
1.75      rillig   4845: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4846: <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   4847: <p>The following is the recommended template for builtin.mk
1.87      wiz      4848:       files:</p>
1.75      rillig   4849: <pre class="programlisting">
1.100     rillig   4850: .if !defined(IS_BUILTIN.foo)
                   4851: #
                   4852: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   4853: # genuinely exists in the system or not.
                   4854: #
                   4855: IS_BUILTIN.foo?=        no
                   4856: 
                   4857: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   4858: # version can be determined.
                   4859: #
                   4860: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   4861: BUILTIN_PKG.foo?=       foo-1.0
                   4862: .  endif
                   4863: .endif  # IS_BUILTIN.foo
                   4864: 
                   4865: .if !defined(USE_BUILTIN.foo)
                   4866: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   4867: .  if defined(BUILTIN_PKG.foo)
                   4868: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   4869: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   4870: USE_BUILTIN.foo!=                                                       \
                   4871:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   4872:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   4873: .      endif
                   4874: .    endfor
                   4875: .  endif
                   4876: .endif  # USE_BUILTIN.foo
                   4877: 
                   4878: CHECK_BUILTIN.foo?=     no
                   4879: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   4880: #
                   4881: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   4882: # "yes" or "no".
                   4883: #
                   4884: .endif  # CHECK_BUILTIN.foo
                   4885: </pre>
1.87      wiz      4886: <p>The first section sets
                   4887:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4888:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   4889:       in the base system.  This should not be a base system software
                   4890:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128     wiz      4891:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.87      wiz      4892:       included as part of the base system.  This variable is only
                   4893:       used internally within the <code class="filename">builtin.mk</code>
                   4894:       file.</p>
                   4895: <p>The second section sets
                   4896:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4897:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   4898:       system if it exists (if
                   4899:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4900:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.87      wiz      4901:       within the <code class="filename">builtin.mk</code> file.</p>
                   4902: <p>The third section sets
                   4903:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4904:       and is <span class="emphasis"><em>required</em></span> in all
                   4905:       <code class="filename">builtin.mk</code> files.  The code in this
                   4906:       section must make the determination whether the built-in
                   4907:       software is adequate to satisfy the dependencies listed in
                   4908:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   4909:       This is typically done by comparing
                   4910:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4911:       against each of the dependencies in
                   4912:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   4913:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4914:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   4915:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   4916:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4917:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.87      wiz      4918:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4919:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.87      wiz      4920:       that the built-in version of the software is similar enough to
                   4921:       be used as a replacement.</p>
                   4922: <p>The last section is guarded by
                   4923:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   4924:       and includes code that uses the value of
                   4925:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4926:       set in the previous section.  This typically includes, e.g.,
                   4927:       adding additional dependency restrictions and listing additional
                   4928:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   4929:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   4930: </div>
1.148     asau     4931: <div class="sect2">
1.75      rillig   4932: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4933: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      4934: <p>When building packages, it's possible to choose whether to set
                   4935:        a global preference for using either the built-in (native)
                   4936:        version or the pkgsrc version of software to satisfy a
                   4937:        dependency.  This is controlled by setting
                   4938:        <code class="varname">PREFER_PKGSRC</code> and
                   4939:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.128     wiz      4940:        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      4941:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   4942:        use the pkgsrc versions of software, while
                   4943:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   4944:        built-in versions.  Preferences are determined by the most
                   4945:        specific instance of the package in either
                   4946:        <code class="varname">PREFER_PKGSRC</code> or
                   4947:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   4948:        in neither or in both variables, then
                   4949:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   4950:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   4951:        using pkgsrc versions of software for all but the most basic
                   4952:       bits on a NetBSD system, you can set:</p>
                   4953: <pre class="programlisting">
1.100     rillig   4954: PREFER_PKGSRC=  yes
                   4955: PREFER_NATIVE=  getopt skey tcp_wrappers
                   4956: </pre>
1.87      wiz      4957: <p>A package <span class="emphasis"><em>must</em></span> have a
                   4958:       <code class="filename">builtin.mk</code>
                   4959:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   4960:       otherwise it is simply ignored in that list.</p>
1.229     sevan    4961: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
                   4962:       straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
                   4963:       bootstrap.
                   4964:       Switching between settings globally at a later date can introduce
                   4965:       complications with dependency resolution. This is caused by packages
                   4966:       built with the opposite preference being installed alongside each other.</p>
                   4967: <pre class="screen">
                   4968: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
                   4969: </pre>
1.75      rillig   4970: </div>
                   4971: </div>
                   4972: </div>
1.148     asau     4973: <div class="chapter">
1.75      rillig   4974: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4975: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   4976: <div class="toc">
                   4977: <p><b>Table of Contents</b></p>
1.210     leot     4978: <dl class="toc">
1.106     rillig   4979: <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   4980: <dd><dl>
1.106     rillig   4981: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   4982: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   4983: </dl></dd>
1.106     rillig   4984: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   4985: <dd><dl>
1.128     wiz      4986: <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   4987: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   4988: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   4989: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   4990: </dl></dd>
                   4991: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   4992: <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>
                   4993: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   4994: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   4995: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   4996: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   4997: <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   4998: </dl>
                   4999: </div>
                   5000: <p>This chapter describes the framework known as
                   5001: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148     asau     5002: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5003: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75      rillig   5004:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      5005: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75      rillig   5006:     provided that packages are correctly designed.</p></li>
1.128     wiz      5007: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5008: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5009: <li class="listitem"><p>Registration of system shells.</p></li>
                   5010: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75      rillig   5011: </ul></div>
                   5012: <p>The following sections inspect each of the above points in detail.</p>
                   5013: <p>You may be thinking that many of the things described here could be
                   5014: easily done with simple code in the package's post-installation target
                   5015: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5016: as the code in them is only executed when building from source.  Machines
                   5017: using binary packages could not benefit from it at all (as the code itself
                   5018: could be unavailable).  Therefore, the only way to achieve any of the items
                   5019: described above is by means of the installation scripts, which are
                   5020: automatically generated by pkginstall.</p>
1.148     asau     5021: <div class="sect1">
1.75      rillig   5022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5023: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5024: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5025: of files and directories that belong to a package.  The names used in it
1.76      rillig   5026: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5027: which means that it cannot register files outside this directory (absolute
                   5028: path names are not allowed).  Despite this restriction, some packages need
                   5029: to install files outside this location; e.g., under
1.76      rillig   5030: <code class="filename">${VARBASE}</code> or
1.87      wiz      5031: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5032: is to create such files during installation time by using
                   5033: installation scripts.</p>
                   5034: <p>The generic installation scripts are shell scripts that can
                   5035: contain arbitrary code.  The list of scripts to execute is taken from
                   5036: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5037: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5038: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5039: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5040: commands, so they have the potential to create and manage files
                   5041: anywhere in the file system.</p>
                   5042: <p>Using these general installation files is not recommended, but
                   5043: may be needed in some special cases.  One reason for avoiding them is
                   5044: that the user has to trust the packager that there is no unwanted or
                   5045: simply erroneous code included in the installation script. Also,
                   5046: previously there were many similar scripts for the same functionality,
                   5047: and fixing a common error involved finding and changing all of
                   5048: them.</p>
                   5049: <p>The pkginstall framework offers another, standardized way.  It
                   5050: provides generic scripts to abstract the manipulation of such files
                   5051: and directories based on variables set in the package's
                   5052: <code class="filename">Makefile</code>.  The rest of this section describes
                   5053: these variables.</p>
1.148     asau     5054: <div class="sect2">
1.75      rillig   5055: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5056: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5057: <p>The following variables can be set to request the creation of
                   5058: directories anywhere in the file system:</p>
1.148     asau     5059: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.218     rillig   5060: <li class="listitem">
                   5061: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75      rillig   5062:     contain a list of directories that should be created and should attempt
                   5063:     to be destroyed by the installation scripts.  The difference between
                   5064:     the two is that the latter prompts the administrator to remove any
                   5065:     directories that may be left after deinstallation (because they were
1.218     rillig   5066:     not empty), while the former does not.  Example:</p>
                   5067: <pre class="programlisting">
                   5068: MAKE_DIRS+=             ${VARBASE}/foo/private
                   5069: </pre>
                   5070: </li>
1.128     wiz      5071: <li class="listitem">
1.75      rillig   5072: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5073:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5074:     which directories should be created and should attempt to be destroyed
                   5075:     by the installation scripts.  Each tuple holds the following values,
                   5076:     separated by spaces: the directory name, its owner, its group and its
                   5077:     numerical mode.  For example:</p>
                   5078: <pre class="programlisting">
1.218     rillig   5079: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   5080:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5081: </pre>
1.75      rillig   5082: <p>The difference between the two is exactly the same as their
                   5083:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5084: </li>
                   5085: </ul></div>
                   5086: </div>
1.148     asau     5087: <div class="sect2">
1.75      rillig   5088: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5089: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5090: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5091: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5092: To overcome this problem, the only solution is to extract the file in the
                   5093: known place (i.e., inside the installation prefix) and copy it to the
                   5094: appropriate location during installation (done by the installation scripts
                   5095: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5096: file</em></span> in the following paragraphs, which describe the variables
                   5097: that can be used to automatically and consistently handle files outside the
                   5098: installation prefix:</p>
1.148     asau     5099: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5100: <li class="listitem">
1.75      rillig   5101: <p><code class="varname">CONF_FILES</code> and
1.137     wiz      5102:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75      rillig   5103:     During installation time, the master file is copied to the target one
                   5104:     if and only if the latter does not exist.  Upon deinstallation, the
                   5105:     target file is removed provided that it was not modified by the
                   5106:     installation.</p>
                   5107: <p>The difference between the two is that the latter prompts the
                   5108:     administrator to remove any files that may be left after
                   5109:     deinstallation (because they were not empty), while the former does
                   5110:     not.</p>
                   5111: </li>
1.128     wiz      5112: <li class="listitem">
1.75      rillig   5113: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137     wiz      5114:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75      rillig   5115:     files as well as their target locations.  For each of them, it also
                   5116:     specifies their owner, their group and their numeric permissions, in
                   5117:     this order.  For example:</p>
                   5118: <pre class="programlisting">
1.218     rillig   5119: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   5120:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5121: </pre>
1.75      rillig   5122: <p>The difference between the two is exactly the same as their
                   5123:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5124: </li>
                   5125: </ul></div>
                   5126: </div>
                   5127: </div>
1.148     asau     5128: <div class="sect1">
1.75      rillig   5129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5130: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   5131: <p>Configuration files are special in the sense that they are installed
                   5132: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5133: need special treatment during installation (most of which is automated by
                   5134: pkginstall).  The main concept you must bear in mind is that files marked
                   5135: as configuration files are automatically copied to the right place (somewhere
                   5136: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5137: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5138: be removed if they have local modifications.  This ensures that
                   5139: administrators never lose any custom changes they may have made.</p>
1.148     asau     5140: <div class="sect2">
1.75      rillig   5141: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5142: <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   5143: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5144: specifies where configuration files shall be installed.  Its contents are
                   5145: set based upon the following variables:</p>
1.148     asau     5146: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5147: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5148:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5149:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5150:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5151:     Packages must not use it directly.</p></li>
1.128     wiz      5152: <li class="listitem">
1.75      rillig   5153: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5154:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5155:     for the package being built shall be installed.  The definition of this
                   5156:     variable only makes sense in the package's
1.76      rillig   5157:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5158: <p>As an example, consider the Apache package,
1.232     sevan    5159:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.75      rillig   5160:     configuration files under the
1.76      rillig   5161:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5162:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5163:     Makefile.</p>
                   5164: </li>
1.128     wiz      5165: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75      rillig   5166:     variable that holds this package's configuration directory (if
                   5167:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5168:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5169:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128     wiz      5170: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75      rillig   5171:     directory where the configuration files for the package identified by
                   5172:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5173: </ul></div>
                   5174: <p>Based on the above variables, pkginstall determines the value of
                   5175: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5176: variable that can be used within a package to refer to its configuration
                   5177: directory.  The algorithm used to set its value is basically the
                   5178: following:</p>
1.128     wiz      5179: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5180: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75      rillig   5181:     its value is used.</p></li>
1.128     wiz      5182: <li class="listitem"><p>If the previous variable is not defined but
1.75      rillig   5183:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5184:     <code class="filename">Makefile</code>, the resulting value is
                   5185:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128     wiz      5186: <li class="listitem"><p>Otherwise, it is set to
1.76      rillig   5187:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5188: </ol></div>
1.76      rillig   5189: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117     jnemeth  5190: 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
                   5191: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   5192: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   5193: </div>
1.148     asau     5194: <div class="sect2">
1.75      rillig   5195: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5196: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   5197: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5198: known place, you need to teach each package where it shall install its
                   5199: files.  In some cases you will have to patch the package Makefiles to
                   5200: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5201: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5202: generated files:</p>
                   5203: <pre class="programlisting">
1.100     rillig   5204: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    5205: </pre>
1.75      rillig   5206: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5207: for</em></span> its configuration files, not where they will be originally
                   5208: installed (although the difference is never explicit,
                   5209: unfortunately).</p>
                   5210: </div>
1.148     asau     5211: <div class="sect2">
1.75      rillig   5212: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5213: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   5214: <p>As said before, pkginstall automatically handles configuration files.
                   5215: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   5216: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   5217: directly</strong></span>.  Bad news is that many software installation scripts
                   5218: will, out of the box, mess with the contents of that directory.  So what is
                   5219: the correct procedure to fix this issue?</p>
                   5220: <p>You must teach the package (usually by manually patching it) to
                   5221: install any configuration files under the examples hierarchy,
1.76      rillig   5222: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5223: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   5224: has the original copies available.</p>
                   5225: <p>Once the required configuration files are in place (i.e., under the
                   5226: examples hierarchy), the pkginstall framework can use them as master copies
                   5227: during the package installation to update what is in
1.76      rillig   5228: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   5229: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  5230: 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   5231: about their syntax and their purpose.  Here is an example, taken from the
1.232     sevan    5232: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75      rillig   5233: <pre class="programlisting">
1.100     rillig   5234: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5235: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    5236: </pre>
1.75      rillig   5237: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5238: package and has no meaning outside it.</p>
                   5239: </div>
1.148     asau     5240: <div class="sect2">
1.75      rillig   5241: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5242: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   5243: <p>The automatic copying of config files can be toggled by setting the
                   5244: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5245: installation.</p>
                   5246: </div>
                   5247: </div>
1.148     asau     5248: <div class="sect1">
1.75      rillig   5249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5250: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   5251: <p>System startup scripts are special files because they must be
                   5252: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  5253: 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   5254: can be used.  However, pkginstall provides a special mechanism to handle
                   5255: these files.</p>
                   5256: <p>In order to provide system startup scripts, the package has
                   5257: to:</p>
1.128     wiz      5258: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5259: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   5260:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.232     sevan    5261:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.76      rillig   5262:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128     wiz      5263: <li class="listitem">
1.75      rillig   5264: <p>Tell pkginstall to handle it, appending the name of the script,
                   5265:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5266:     Continuing the previous example:</p>
                   5267: <pre class="programlisting">
1.100     rillig   5268: RCD_SCRIPTS+=   cupsd
1.1       grant    5269: </pre>
1.75      rillig   5270: </li>
                   5271: </ol></div>
                   5272: <p>Once this is done, pkginstall will do the following steps for each
                   5273: script in an automated fashion:</p>
1.128     wiz      5274: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5275: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76      rillig   5276:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   5277:     variable.</p></li>
1.128     wiz      5278: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76      rillig   5279:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   5280:     that this master file must be explicitly registered in the
1.76      rillig   5281:     <code class="filename">PLIST</code>.</p></li>
1.128     wiz      5282: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75      rillig   5283:     from the examples hierarchy into the system-wide startup scripts
                   5284:     directory.</p></li>
                   5285: </ol></div>
1.148     asau     5286: <div class="sect2">
1.75      rillig   5287: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5288: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   5289: <p>The automatic copying of config files can be toggled by setting the
                   5290: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   5291: installation.  Note that the scripts will be always copied inside the
1.76      rillig   5292: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   5293: matter what the value of this variable is.</p>
                   5294: </div>
                   5295: </div>
1.148     asau     5296: <div class="sect1">
1.75      rillig   5297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5298: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   5299: <p>If a package needs to create special users and/or groups during
                   5300: installation, it can do so by using the pkginstall framework.</p>
                   5301: <p>Users can be created by adding entries to the
                   5302: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   5303: syntax:</p>
                   5304: <pre class="programlisting">
1.100     rillig   5305: user:group
1.1       grant    5306: </pre>
1.87      wiz      5307: <p>Further specification of user details may be done by setting
                   5308: per-user variables.
                   5309: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   5310: numeric UID for the user.
                   5311: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   5312: user's description or comment.
                   5313: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   5314: user's home directory, and defaults to
                   5315: <code class="filename">/nonexistent</code> if not specified.
                   5316: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 5317: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      5318: not specified.</p>
1.75      rillig   5319: <p>Similarly, groups can be created by adding entries to the
                   5320: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   5321: <pre class="programlisting">
1.100     rillig   5322: group
1.1       grant    5323: </pre>
1.93      rillig   5324: <p>The numeric GID of the group may be set by defining
1.75      rillig   5325: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   5326: <p>If a package needs to create the users and groups at an earlier
1.227     wiz      5327: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   5328: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   5329: <code class="literal">pre-install</code> to indicate the phase before which the
                   5330: users and groups are created. In this case, the numeric UIDs and GIDs
                   5331: of the created users and groups are automatically hardcoded into the
                   5332: final installation scripts.</p>
1.75      rillig   5333: </div>
1.148     asau     5334: <div class="sect1">
1.75      rillig   5335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5336: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   5337: <p>Packages that install system shells should register them in the shell
1.76      rillig   5338: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   5339: administrator.  This must be done from the installation scripts to keep
                   5340: binary packages working on any system.  pkginstall provides an easy way to
                   5341: accomplish this task.</p>
                   5342: <p>When a package provides a shell interpreter, it has to set the
                   5343: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   5344: add some hooks to the installation scripts to handle it.  Consider the
1.232     sevan    5345: following example, taken from <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75      rillig   5346: <pre class="programlisting">
1.100     rillig   5347: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    5348: </pre>
1.148     asau     5349: <div class="sect2">
1.75      rillig   5350: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5351: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   5352: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   5353: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   5354: environment variable to <code class="literal">NO</code>.</p>
                   5355: </div>
                   5356: </div>
1.148     asau     5357: <div class="sect1">
1.75      rillig   5358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5359: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   5360: <p>Packages that install X11 fonts should update the database files
                   5361: that index the fonts within each fonts directory.  This can easily be
                   5362: accomplished within the pkginstall framework.</p>
                   5363: <p>When a package installs X11 fonts, it must list the directories in
                   5364: which fonts are installed in the
                   5365: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128     wiz      5366: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   5367: <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   5368: installation scripts to run the appropriate commands to update the fonts
                   5369: database files within each of those directories.  For convenience, if the
                   5370: directory path is relative, it is taken to be relative to the package's
1.232     sevan    5371: installation prefix.  Consider the following example, taken from <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   5372: <pre class="programlisting">
1.175     wiz      5373: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       grant    5374: </pre>
1.148     asau     5375: <div class="sect2">
1.75      rillig   5376: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5377: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   5378: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   5379: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   5380: environment variable to <code class="literal">NO</code>.</p>
                   5381: </div>
                   5382: </div>
                   5383: </div>
1.148     asau     5384: <div class="chapter">
1.75      rillig   5385: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5386: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   5387: <div class="toc">
                   5388: <p><b>Table of Contents</b></p>
1.210     leot     5389: <dl class="toc">
1.106     rillig   5390: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      5391: <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   5392: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   5393: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   5394: </dl>
                   5395: </div>
                   5396: <p>Many packages have the ability to be built to support different
1.76      rillig   5397: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   5398: in pkgsrc that provides generic handling of those options that
                   5399: determine different ways in which the packages can be built.  It's
                   5400: possible for the user to specify exactly which sets of options will be
                   5401: built into a package or to allow a set of global default options
                   5402: apply.</p>
1.107     rillig   5403: <p>There are two broad classes of behaviors that one might want to
                   5404: control via options.  One is whether some particular feature is
                   5405: enabled in a program that will be built anyway, often by including or
                   5406: not including a dependency on some other package.  The other is
                   5407: whether or not an additional program will be built as part of the
                   5408: package.  Generally, it is better to make a split package for such
                   5409: additional programs instead of using options, because it enables
                   5410: binary packages to be built which can then be added separately.  For
                   5411: example, the foo package might have minimal dependencies (those
                   5412: packages without which foo doesn't make sense), and then the foo-gfoo
                   5413: package might include the GTK frontend program gfoo.  This is better
                   5414: than including a gtk option to foo that adds gfoo, because either that
                   5415: option is default, in which case binary users can't get foo without
                   5416: gfoo, or not default, in which case they can't get gfoo.  With split
                   5417: packages, they can install foo without having GTK, and later decide to
                   5418: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5419: source users too, avoiding the need for rebuilds.</p>
                   5420: <p>Plugins with widely varying dependencies should usually be split
                   5421: instead of options.</p>
                   5422: <p>It is often more work to maintain split packages, especially if
                   5423: the upstream package does not support this.  The decision of split
                   5424: vs. option should be made based on the likelihood that users will want
                   5425: or object to the various pieces, the size of the dependencies that are
                   5426: included, and the amount of work.</p>
                   5427: <p>A further consideration is licensing.  Non-free parts, or parts
                   5428: that depend on non-free dependencies (especially plugins) should
                   5429: almost always be split if feasible.</p>
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="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   5433: <p>Global default options are listed in
                   5434: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5435: that should be built into every package if that option is supported.
1.110     hubertf  5436: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5437: </div>
1.148     asau     5438: <div class="sect1">
1.75      rillig   5439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5440: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   5441: </h2></div></div></div>
1.75      rillig   5442: <p>The following example shows how
1.76      rillig   5443: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   5444: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   5445: <code class="filename">Makefile</code>, or in a file,
                   5446: e.g. <code class="filename">options.mk</code>, that is included by the
                   5447: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5448: <pre class="programlisting">
1.100     rillig   5449: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5450: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5451: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5452: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5453: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5454: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5455: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5456: 
                   5457: .include "../../mk/bsd.prefs.mk"
                   5458: 
                   5459: # this package was previously named wibble2
                   5460: .if defined(PKG_OPTIONS.wibble2)
                   5461: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5462: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5463:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5464: .endif
                   5465: 
                   5466: .include "../../mk/bsd.options.mk"
                   5467: 
                   5468: # Package-specific option-handling
                   5469: 
                   5470: ###
                   5471: ### FOO support
                   5472: ###
                   5473: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5474: CONFIGURE_ARGS+=    --enable-foo
                   5475: .endif
                   5476: 
                   5477: ###
                   5478: ### LDAP support
                   5479: ###
                   5480: .if !empty(PKG_OPTIONS:Mldap)
                   5481: .  include "../../databases/openldap-client/buildlink3.mk"
                   5482: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5483: .endif
                   5484: 
                   5485: ###
                   5486: ### database support
                   5487: ###
                   5488: .if !empty(PKG_OPTIONS:Mmysql)
                   5489: .  include "../../mk/mysql.buildlink3.mk"
                   5490: .endif
                   5491: .if !empty(PKG_OPTIONS:Mpgsql)
                   5492: .  include "../../mk/pgsql.buildlink3.mk"
                   5493: .endif
1.75      rillig   5494: </pre>
                   5495: <p>The first section contains the information about which build
                   5496: options are supported by the package, and any default options settings
                   5497: if needed.</p>
1.128     wiz      5498: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5499: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.232     sevan    5500: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75      rillig   5501: options.  It should be set to
1.78      rillig   5502: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5503: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5504: at the point where the options are processed.</p></li>
1.128     wiz      5505: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75      rillig   5506: build options supported by the package.</p></li>
1.128     wiz      5507: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75      rillig   5508: list of names of groups of mutually exclusive options.  The options in
                   5509: each group are listed in
                   5510: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5511: The most specific setting of any option from the group takes
                   5512: precedence over all other options in the group.  Options from the
                   5513: groups will be automatically added to
                   5514: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128     wiz      5515: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75      rillig   5516: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5517: packages will fail if no option from the group is
                   5518: selected.</p></li>
1.128     wiz      5519: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75      rillig   5520: of names of sets of options.  At least one option from each set must
                   5521: be selected.  The options in each set are listed in
                   5522: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5523: Options from the sets will be automatically added to
                   5524: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5525: fail if no option from the set is selected.</p></li>
1.128     wiz      5526: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75      rillig   5527: build options which are enabled by default.</p></li>
1.128     wiz      5528: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75      rillig   5529: of
1.128     wiz      5530: <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  5531: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   5532: their option counterparts.  Pairs should be added with
1.128     wiz      5533: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.75      rillig   5534: warning will be issued if the user uses a legacy
                   5535: variable.</p></li>
1.128     wiz      5536: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75      rillig   5537: of
1.128     wiz      5538: <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   5539: pairs that map options that have been renamed to their new
1.128     wiz      5540: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.75      rillig   5541: the listing of global legacy options.  A warning will be issued if
                   5542: the user uses a legacy option.</p></li>
1.128     wiz      5543: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75      rillig   5544: options implied by deprecated variables used.  This can be used for
                   5545: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5546: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5547: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128     wiz      5548: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75      rillig   5549: a list of warnings about deprecated variables or options used, and
                   5550: what to use instead.</p></li>
                   5551: </ol></div>
                   5552: <p>A package should never modify
                   5553: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5554: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5555: To suggest a default set of options, use
                   5556: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5557: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   5558: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   5559: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5560: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5561: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5562: happen with platform-specific options if none of them is supported on
                   5563: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5564: empty list and the package is otherwise treated as not using the
                   5565: options framework.</p>
1.76      rillig   5566: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   5567: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5568: build options, properly filtered to remove unsupported and duplicate
                   5569: options.</p>
                   5570: <p>The remaining sections contain the logic that is specific to
                   5571: each option.  The correct way to check for an option is to check
                   5572: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5573: <pre class="programlisting">
1.100     rillig   5574: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   5575: </pre>
                   5576: </div>
1.148     asau     5577: <div class="sect1">
1.75      rillig   5578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5579: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   5580: <p>Options that enable similar features in different packages (like
                   5581: optional support for a library) should use a common name in all
                   5582: packages that support it (like the name of the library).  If another
                   5583: package already has an option with the same meaning, use the same
                   5584: name.</p>
                   5585: <p>Options that enable features specific to one package, where it's
                   5586: unlikely that another (unrelated) package has the same (or a similar)
                   5587: optional feature, should use a name prefixed with
                   5588: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5589: <p>If a group of related packages share an optional feature
                   5590: specific to that group, prefix it with the name of the
1.128     wiz      5591: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.75      rillig   5592: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5593: <p>For new options, add a line to
1.76      rillig   5594: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   5595: fields, separated by tab.  The first field is the option name, the
                   5596: second its description.  The description should be a whole sentence
                   5597: (starting with an uppercase letter and ending with a period) that
1.128     wiz      5598: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5599: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.75      rillig   5600: </div>
1.148     asau     5601: <div class="sect1">
1.107     rillig   5602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5603: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  5604: <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   5605: different dependencies based on the options with which the package was
                   5606: built. For querying these options, the file
                   5607: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5608: typical example looks like this:</p>
                   5609: <pre class="programlisting">
                   5610: pkgbase := libpurple
                   5611: .include "../../mk/pkg-build-options.mk"
                   5612: 
                   5613: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5614: ...
                   5615: .endif
                   5616: </pre>
                   5617: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5618: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5619: options of the libpurple package, which can then be queried like
                   5620: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5621: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5622: details.</p>
                   5623: </div>
1.75      rillig   5624: </div>
1.148     asau     5625: <div class="chapter">
1.75      rillig   5626: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5627: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   5628: <div class="toc">
                   5629: <p><b>Table of Contents</b></p>
1.210     leot     5630: <dl class="toc">
1.106     rillig   5631: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   5632: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   5633: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   5634: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      5635: <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   5636: <dd><dl>
                   5637: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   5638: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   5639: </dl></dd>
1.128     wiz      5640: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   5641: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   5642: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   5643: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   5644: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   5645: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   5646: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   5647: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   5648: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   5649: <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   5650: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   5651: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   5652: </dl>
                   5653: </div>
1.148     asau     5654: <div class="sect1">
1.75      rillig   5655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5656: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   5657: <p>This chapter gives a detailed description on how a package is
1.87      wiz      5658:     built. Building a package is separated into different
                   5659:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   5660:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120     snj      5661:     described in the following sections. Each phase is split into
1.87      wiz      5662:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   5663:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   5664:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   5665:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   5666:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   5667: <p>Never override the regular targets (like
                   5668:     <code class="varname">fetch</code>), if you have to, override the
                   5669:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   5670: <p>The basic steps for building a program are always the same.  First
1.87      wiz      5671:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   5672:     the local system and then extracted. After any pkgsrc-specific patches
                   5673:     to compile properly are applied, the software can be configured, then
                   5674:     built (usually by compiling), and finally the generated binaries, etc.
                   5675:     can be put into place on the system.</p>
1.97      rillig   5676: <p>To get more details about what is happening at each step,
                   5677:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   5678:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   5679:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   5680: </div>
1.148     asau     5681: <div class="sect1">
1.75      rillig   5682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5683: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   5684: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      5685:     the next section, here's a brief discussion on where programs are
                   5686:     installed, and which variables influence this.</p>
1.75      rillig   5687: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      5688:     where all files of the final program shall be installed. It is
                   5689:     usually set to <code class="varname">LOCALBASE</code>
                   5690:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      5691:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      5692:     <code class="varname">PREFIX</code> needs to be put
                   5693:     into the various places in the program's source where paths to
1.219     rillig   5694:     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   5695: <p>When choosing which of these variables to use,
1.87      wiz      5696:     follow the following rules:</p>
1.148     asau     5697: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5698: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88      wiz      5699:        where the current pkg will be installed.  When referring to a
                   5700:        pkg's own installation path, use
1.128     wiz      5701:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   5702: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88      wiz      5703:        are installed.  If you need to construct a -I or -L argument
                   5704:        to the compiler to find includes and libraries installed by
1.128     wiz      5705:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.87      wiz      5706:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   5707:        installed all packages in <code class="filename">/usr/local</code>. As
                   5708:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   5709:        administrator, this variable is a misnomer.</p></li>
1.128     wiz      5710: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88      wiz      5711:        distribution (from xsrc, etc.) is installed. When looking for
                   5712:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128     wiz      5713:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
1.209     sevan    5714: <li class="listitem"><p>X11-based packages using imake must set
                   5715:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   5716:        <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      5717: <li class="listitem">
1.209     sevan    5718: <p>To determine the prefix of an
1.88      wiz      5719:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   5720:        definition can be used. It takes pairs in the format
1.232     sevan    5721:        <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.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      5722:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   5723:        of the installed package &lt;package&gt;, or
1.209     sevan    5724:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> if the package is not
1.88      wiz      5725:        installed.</p>
1.75      rillig   5726: <p>This is best illustrated by example.</p>
                   5727: <p>The following lines are taken from
1.87      wiz      5728:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   5729: <pre class="programlisting">
1.100     rillig   5730: EVAL_PREFIX+=           GTKDIR=gtk+
                   5731: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   5732: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   5733: CONFIGURE_ARGS+=        --enable-multibyte
                   5734: </pre>
1.88      wiz      5735: <p>Specific defaults can be defined for the packages
                   5736:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   5737:        definition of the form:</p>
1.75      rillig   5738: <pre class="programlisting">
1.100     rillig   5739: GTKDIR_DEFAULT= ${LOCALBASE}
                   5740: </pre>
1.75      rillig   5741: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      5742:        to the first definition in
                   5743:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   5744: </li>
1.128     wiz      5745: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.232     sevan    5746:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87      wiz      5747:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   5748:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   5749: </ul></div>
                   5750: </div>
1.148     asau     5751: <div class="sect1">
1.75      rillig   5752: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5753: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 5754: <p>When building a package, various directories are used to store
1.87      wiz      5755:     source files, temporary files, pkgsrc-internal files, and so on. These
                   5756:     directories are explained here.</p>
1.75      rillig   5757: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      5758:     are two common base directories for these relative directories:
                   5759:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   5760:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   5761:     inside the package itself.</p>
1.148     asau     5762: <div class="variablelist"><dl class="variablelist">
1.75      rillig   5763: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   5764: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      5765:       root directory. Generally, you don't need
                   5766:       it.</p></dd>
1.97      rillig   5767: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   5768: <dd><p>This is an absolute pathname that points to the
                   5769:       current package.</p></dd>
1.75      rillig   5770: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   5771: <dd><p>This is a pathname relative to
1.87      wiz      5772:       <code class="varname">PKGSRCDIR</code> that points to the current
                   5773:       package.</p></dd>
1.75      rillig   5774: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   5775: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   5776:       where all work takes place. The distfiles are extracted to this
1.87      wiz      5777:       directory. It also contains temporary directories and log files used by
                   5778:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   5779:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   5780: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   5781: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      5782:       where the distfiles are extracted. It is usually a direct subdirectory
                   5783:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   5784:       that isn't hidden. This variable may be changed by a package
                   5785:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   5786: </dl></div>
1.114     jmcneill 5787: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   5788:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   5789:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 5790:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   5791:     If users would like to have their pkgsrc trees behave in a
                   5792:     read-only manner, then the value of
                   5793:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   5794:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   5795: </div>
1.148     asau     5796: <div class="sect1">
1.75      rillig   5797: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5798: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  5799: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      5800:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   5801:     phase. This will automatically run all phases that are required for this
                   5802:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  5803:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      5804:     the package will be built, but not installed.</p>
1.75      rillig   5805: </div>
1.148     asau     5806: <div class="sect1">
1.75      rillig   5807: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5808: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   5809: <p>The first step in building a package is to fetch the
1.88      wiz      5810:     distribution files (distfiles) from the sites that are providing
                   5811:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   5812:     phase.</p>
1.148     asau     5813: <div class="sect2">
1.81      rillig   5814: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5815: <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      5816: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   5817:       defines all URLs from where the distfile, whose name is
                   5818:       derived from the <code class="varname">DISTNAME</code> variable, is
                   5819:       fetched. The more complicated cases are described
                   5820:       below.</p>
                   5821: <p>The variable <code class="varname">DISTFILES</code> specifies
                   5822:       the list of distfiles that have to be fetched. Its value
1.174     asau     5823:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   5824:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88      wiz      5825:       so that most packages don't need to define it at all.
                   5826:       <code class="varname">EXTRACT_SUFX</code> is
                   5827:       <code class="literal">.tar.gz</code> by default, but can be changed
                   5828:       freely. Note that if your package requires additional
                   5829:       distfiles to the default one, you cannot just append the
                   5830:       additional filenames using the <code class="literal">+=</code>
                   5831:       operator, but you have write for example:</p>
1.81      rillig   5832: <pre class="programlisting">
1.174     asau     5833: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100     rillig   5834: </pre>
1.88      wiz      5835: <p>Each distfile is fetched from a list of sites, usually
                   5836:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   5837:       <code class="varname">DISTFILES</code> or multiple
                   5838:       <code class="varname">PATCHFILES</code> from different sites, you can
                   5839:       set
                   5840:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   5841:       to the list of URLs where the file
                   5842:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   5843:       (including the suffix) can be found.</p>
                   5844: <pre class="programlisting">
1.100     rillig   5845: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   5846: DISTFILES+=     foo-file.tar.gz
                   5847: SITES.foo-file.tar.gz= \
                   5848: http://www.somewhere.com/somehow/ \
                   5849: http://www.somewhereelse.com/mirror/somehow/
                   5850: </pre>
1.81      rillig   5851: <p>When actually fetching the distfiles, each item from
1.88      wiz      5852:       <code class="varname">MASTER_SITES</code> or
                   5853:       <code class="varname">SITES.*</code> gets the name of each distfile
                   5854:       appended to it, without an intermediate slash. Therefore,
                   5855:       all site values have to end with a slash or other separator
                   5856:       character. This allows for example to set
                   5857:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   5858:       that gets the name of the distfile as a parameter. In this
                   5859:       case, the definition would look like:</p>
1.81      rillig   5860: <pre class="programlisting">
1.100     rillig   5861: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   5862: </pre>
1.125     wiz      5863: <p> The exception to this rule are URLs starting with a dash.
1.174     asau     5864:       In that case the URL is taken as is, fetched and the result
                   5865:       stored under the name of the distfile. You can use this style
                   5866:       for the case when the download URL style does not match the
                   5867:       above common case. For example, if permanent download URL is a
                   5868:       redirector to the real download URL, or the download file name
                   5869:       is offered by an HTTP Content-Disposition header. In the
                   5870:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   5871:       created instead of the default
                   5872:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   5873: <pre class="programlisting">
                   5874: DISTNAME=       foo-1.0.0
                   5875: MASTER_SITES=   -http://www.example.com/archive/v1.0.0.tar.gz
                   5876: </pre>
1.81      rillig   5877: <p>There are some predefined values for
1.88      wiz      5878:       <code class="varname">MASTER_SITES</code>, which can be used in
                   5879:       packages.  The names of the variables should speak for
                   5880:       themselves.</p>
                   5881: <pre class="programlisting">
1.100     rillig   5882: ${MASTER_SITE_APACHE}
                   5883: ${MASTER_SITE_BACKUP}
                   5884: ${MASTER_SITE_CYGWIN}
                   5885: ${MASTER_SITE_DEBIAN}
                   5886: ${MASTER_SITE_FREEBSD}
                   5887: ${MASTER_SITE_FREEBSD_LOCAL}
                   5888: ${MASTER_SITE_GENTOO}
                   5889: ${MASTER_SITE_GNOME}
                   5890: ${MASTER_SITE_GNU}
                   5891: ${MASTER_SITE_GNUSTEP}
1.174     asau     5892: ${MASTER_SITE_HASKELL_HACKAGE}
1.100     rillig   5893: ${MASTER_SITE_IFARCHIVE}
                   5894: ${MASTER_SITE_KDE}
                   5895: ${MASTER_SITE_MOZILLA}
1.174     asau     5896: ${MASTER_SITE_MOZILLA_ALL}
                   5897: ${MASTER_SITE_MOZILLA_ESR}
1.100     rillig   5898: ${MASTER_SITE_MYSQL}
1.174     asau     5899: ${MASTER_SITE_NETLIB}
1.100     rillig   5900: ${MASTER_SITE_OPENOFFICE}
1.208     ryoon    5901: ${MASTER_SITE_OSDN}
1.100     rillig   5902: ${MASTER_SITE_PERL_CPAN}
                   5903: ${MASTER_SITE_PGSQL}
1.174     asau     5904: ${MASTER_SITE_RUBYGEMS}
1.100     rillig   5905: ${MASTER_SITE_R_CRAN}
                   5906: ${MASTER_SITE_SOURCEFORGE}
                   5907: ${MASTER_SITE_SUNSITE}
                   5908: ${MASTER_SITE_SUSE}
                   5909: ${MASTER_SITE_TEX_CTAN}
                   5910: ${MASTER_SITE_XCONTRIB}
                   5911: ${MASTER_SITE_XEMACS}
1.174     asau     5912: ${MASTER_SITE_XORG}
1.100     rillig   5913: </pre>
1.88      wiz      5914: <p>Some explanations for the less self-explaining ones:
                   5915:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133     wiz      5916:       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      5917:       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      5918: <p>If you choose one of these predefined sites, you may
                   5919:       want to specify a subdirectory of that site. Since these
                   5920:       macros may expand to more than one actual site, you
                   5921:       <span class="emphasis"><em>must</em></span> use the following construct to
                   5922:       specify a subdirectory:</p>
1.81      rillig   5923: <pre class="programlisting">
1.100     rillig   5924: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   5925: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   5926: </pre>
1.81      rillig   5927: <p>Note the trailing slash after the subdirectory
1.88      wiz      5928:       name.</p>
1.81      rillig   5929: </div>
1.148     asau     5930: <div class="sect2">
1.81      rillig   5931: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5932: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      5933: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   5934:       all the distfiles exist in a local directory
1.93      rillig   5935:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      5936:       user). If the files do not exist, they are fetched using
                   5937:       commands of the form</p>
1.75      rillig   5938: <pre class="programlisting">
1.100     rillig   5939: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   5940: </pre>
1.88      wiz      5941: <p>where <code class="literal">${site}</code> varies through
                   5942:       several possibilities in turn: first,
                   5943:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   5944:       sites specified in either <code class="varname">SITES.file</code> if
                   5945:       defined, else <code class="varname">MASTER_SITES</code> or
                   5946:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   5947:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   5948:       all except the first and the last can be optionally sorted
                   5949:       by the user, via setting either
                   5950:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   5951:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      5952:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  5953: <p> The specific command and arguments used depend on the
                   5954:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   5955:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   5956: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   5957:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   5958:       distfiles, if they are freely distributable.  Packages setting
                   5959:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128     wiz      5960:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.97      rillig   5961:       mirrored.</p>
1.81      rillig   5962: </div>
1.75      rillig   5963: </div>
1.148     asau     5964: <div class="sect1">
1.75      rillig   5965: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5966: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      5967: <p>After the distfile(s) are fetched, their checksum is
                   5968:     generated and compared with the checksums stored in the
                   5969:     distinfo file. If the checksums don't match, the build is
                   5970:     aborted. This is to ensure the same distfile is used for
                   5971:     building, and that the distfile wasn't changed, e.g. by some
                   5972:     malign force, deliberately changed distfiles on the master
                   5973:     distribution site or network lossage.</p>
1.75      rillig   5974: </div>
1.148     asau     5975: <div class="sect1">
1.75      rillig   5976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5977: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   5978: <p>When the distfiles are present on the local system, they
1.88      wiz      5979:     need to be extracted, as they usually come in the form of some
                   5980:     compressed archive format.</p>
1.75      rillig   5981: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      5982:     extracted. If you only need some of them, you can set the
                   5983:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   5984:     files.</p>
                   5985: <p>Extracting the files is usually done by a little
1.93      rillig   5986:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      5987:     already knows how to extract various archive formats, so most
                   5988:     likely you will not need to change anything here. But if you
                   5989:     need, the following variables may help you:</p>
1.148     asau     5990: <div class="variablelist"><dl class="variablelist">
1.75      rillig   5991: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   5992: <dd><p>Use these variables to override the default
1.88      wiz      5993:       options for an extract command, which are defined in
1.93      rillig   5994:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   5995: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   5996: <dd><p>This variable can be set to
1.114     jmcneill 5997:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   5998:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      5999:       absolute pathname pointing to the command with which tar
1.114     jmcneill 6000:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6001:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   6002: </dl></div>
1.88      wiz      6003: <p>If the <code class="filename">extract</code> program doesn't
                   6004:     serve your needs, you can also override the
                   6005:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6006:     command used for extracting the files. This command is
                   6007:     executed in the <code class="filename">${WRKSRC}</code>
                   6008:     directory. During execution of this command, the shell
                   6009:     variable <code class="varname">extract_file</code> holds the absolute
                   6010:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6011: <p>And if that still does not suffice, you can override the
1.88      wiz      6012:     <code class="varname">do-extract</code> target in the package
                   6013:     Makefile.</p>
1.75      rillig   6014: </div>
1.148     asau     6015: <div class="sect1">
1.75      rillig   6016: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6017: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6018: <p>After extraction, all the patches named by the
1.88      wiz      6019:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6020:     subdirectory of the package as well as in
                   6021:     $LOCALPATCHES/$PKGPATH (e.g.
                   6022:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6023:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6024:     <code class="filename">.gz</code> are uncompressed before they are
                   6025:     applied, files ending in <code class="filename">.orig</code> or
                   6026:     <code class="filename">.rej</code> are ignored. Any special options to
1.232     sevan    6027:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.219     rillig   6028:     <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.232     sevan    6029: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88      wiz      6030:     it fail if the patches apply with some lines of fuzz. Please
                   6031:     fix (regen) the patches so that they apply cleanly. The
                   6032:     rationale behind this is that patches that don't apply cleanly
                   6033:     may end up being applied in the wrong place, and cause severe
                   6034:     harm there.</p>
1.75      rillig   6035: </div>
1.148     asau     6036: <div class="sect1">
1.75      rillig   6037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6038: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  6039: <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      6040:     </p>
1.75      rillig   6041: </div>
1.148     asau     6042: <div class="sect1">
1.75      rillig   6043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6044: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6045: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6046:     linkers. The following variables can be used to tweak the
                   6047:     wrappers.</p>
1.148     asau     6048: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6049: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6050: <dd><p>The command used to print progress
1.88      wiz      6051:       messages. Does nothing by default. Set to
                   6052:       <code class="literal">${ECHO}</code> to see the progress
                   6053:       messages.</p></dd>
1.75      rillig   6054: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6055: <dd><p>This variable can be set to
1.88      wiz      6056:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6057:       depending on whether you want additional information in the
                   6058:       wrapper log file.</p></dd>
1.75      rillig   6059: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6060: <dd><p>This variable can be set to
1.88      wiz      6061:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6062:       on whether the wrapper should use its cache, which will
                   6063:       improve the speed. The default value is
                   6064:       <code class="literal">yes</code>, but is forced to
                   6065:       <code class="literal">no</code> if the platform does not support
                   6066:       it.</p></dd>
1.75      rillig   6067: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6068: <dd><p>A list of reordering commands. A reordering
                   6069:       command has the form
                   6070:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6071:       It ensures that that
                   6072:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6073:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6074:       </p></dd>
1.75      rillig   6075: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6076: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6077:       investigate further]</p></dd>
1.75      rillig   6078: </dl></div>
                   6079: </div>
1.148     asau     6080: <div class="sect1">
1.75      rillig   6081: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6082: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6083: <p>Most pieces of software need information on the header
                   6084:     files, system calls, and library routines which are available
                   6085:     on the platform they run on. The process of determining this
                   6086:     information is known as configuration, and is usually
                   6087:     automated. In most cases, a script is supplied with the
                   6088:     distfiles, and its invocation results in generation of header
                   6089:     files, Makefiles, etc.</p>
                   6090: <p>If the package contains a configure script, this can be
                   6091:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128     wiz      6092:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.88      wiz      6093:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128     wiz      6094:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.88      wiz      6095:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6096: <pre class="programlisting">
1.100     rillig   6097: .for d in ${CONFIGURE_DIRS}
                   6098:         cd ${WRKSRC} \
                   6099:         &amp;&amp; cd ${d} \
                   6100:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6101: .endfor
                   6102: </pre>
1.88      wiz      6103: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128     wiz      6104:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6105:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6106:     configure script is run with the environment
                   6107:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6108:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6109:     <code class="varname">CONFIGURE_ENV</code>,
                   6110:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128     wiz      6111:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.88      wiz      6112:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6113:     package.</p>
1.144     wiz      6114: <p>If the program uses the Perl way of configuration (mainly Perl
                   6115:     modules, but not only), i.e. a file called
                   6116:     <code class="filename">Makefile.PL</code>, it should include
                   6117:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6118:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6119:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88      wiz      6120: <p>If the program uses an <code class="filename">Imakefile</code>
                   6121:     for configuration, the appropriate steps can be invoked by
                   6122:     setting <code class="varname">USE_IMAKE</code> to
1.209     sevan    6123:     <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>.
                   6124:     You can add variables to xmkmf's environment by adding them to the
1.97      rillig   6125:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   6126: <p>If the program uses <code class="filename">cmake</code>
                   6127:     for configuration, the appropriate steps can be invoked by
1.128     wiz      6128:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.111     rillig   6129:     You can add variables to cmake's environment by adding them to the
                   6130:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6131:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6132:     The top directory argument is given by the
                   6133:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128     wiz      6134:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   6135: <p>If there is no configure step at all, set
1.128     wiz      6136:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6137: </div>
1.148     asau     6138: <div class="sect1">
1.75      rillig   6139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6140: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6141: <p>For building a package, a rough equivalent of the
                   6142:     following code is executed.</p>
1.75      rillig   6143: <pre class="programlisting">
1.100     rillig   6144: .for d in ${BUILD_DIRS}
                   6145:         cd ${WRKSRC} \
                   6146:         &amp;&amp; cd ${d} \
                   6147:         &amp;&amp; env ${MAKE_ENV} \
                   6148:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6149:                 -f ${MAKE_FILE} \
                   6150:                 ${BUILD_TARGET}
                   6151: .endfor
                   6152: </pre>
1.88      wiz      6153: <p><code class="varname">BUILD_DIRS</code> (default:
1.128     wiz      6154:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6155:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6156:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6157:     <code class="varname">MAKE_ENV</code> and arguments
                   6158:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6159:     <code class="varname">MAKE_ENV</code>,
                   6160:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6161:     <code class="varname">MAKE_FILE</code> and
                   6162:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6163:     package.</p>
1.75      rillig   6164: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128     wiz      6165:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6166:     <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      6167:     default value of <code class="varname">MAKE_FILE</code> is
1.128     wiz      6168:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6169:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.97      rillig   6170: <p>If there is no build step at all, set
1.128     wiz      6171:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6172: </div>
1.148     asau     6173: <div class="sect1">
1.75      rillig   6174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6175: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6176: <p>[TODO]</p>
                   6177: </div>
1.148     asau     6178: <div class="sect1">
1.75      rillig   6179: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6180: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6181: <p>Once the build stage has completed, the final step is to
1.88      wiz      6182:     install the software in public directories, so users can
                   6183:     access the programs and files.</p>
1.75      rillig   6184: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6185:     equivalent of the following code is executed. Additionally,
                   6186:     before and after this code, much magic is performed to do
                   6187:     consistency checks, registering the package, and so on.</p>
                   6188: <pre class="programlisting">
1.100     rillig   6189: .for d in ${INSTALL_DIRS}
                   6190:         cd ${WRKSRC} \
                   6191:         &amp;&amp; cd ${d} \
                   6192:         &amp;&amp; env ${MAKE_ENV} \
                   6193:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6194:                 -f ${MAKE_FILE} \
                   6195:                 ${INSTALL_TARGET}
                   6196: .endfor
                   6197: </pre>
1.75      rillig   6198: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6199:     <span class="emphasis"><em>build</em></span> phase.
                   6200:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6201:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128     wiz      6202:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   6203:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.88      wiz      6204:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6205:     defined.</p>
1.75      rillig   6206: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6207:     variables are useful. They are all variations of the
1.232     sevan    6208:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88      wiz      6209:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6210:     install command. The specialized variants, together with their
                   6211:     intended use, are:</p>
1.148     asau     6212: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6213: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6214: <dd><p>directories that contain
                   6215:       binaries</p></dd>
1.75      rillig   6216: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6217: <dd><p>directories that contain
                   6218:       scripts</p></dd>
1.75      rillig   6219: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6220: <dd><p>directories that contain shared and static
                   6221:       libraries</p></dd>
1.75      rillig   6222: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6223: <dd><p>directories that contain data
                   6224:       files</p></dd>
1.75      rillig   6225: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6226: <dd><p>directories that contain man
                   6227:       pages</p></dd>
1.210     leot     6228: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   6229: <dd><p>directories that contain data files for games
                   6230:       </p></dd>
1.75      rillig   6231: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      6232: <dd><p>binaries that can be stripped from debugging
                   6233:       symbols</p></dd>
1.75      rillig   6234: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      6235: <dd><p>binaries that cannot be
                   6236:       stripped</p></dd>
1.75      rillig   6237: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      6238: <dd><p>game
                   6239:       binaries</p></dd>
1.75      rillig   6240: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      6241: <dd><p>shared and static
                   6242:       libraries</p></dd>
1.75      rillig   6243: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6244: <dd><p>data files</p></dd>
                   6245: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      6246: <dd><p>data files for
                   6247:       games</p></dd>
1.75      rillig   6248: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6249: <dd><p>man pages</p></dd>
                   6250: </dl></div>
                   6251: <p>Some other variables are:</p>
1.148     asau     6252: <div class="variablelist"><dl class="variablelist">
1.216     tnn      6253: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.232     sevan    6254: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?strip+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.216     tnn      6255:       when installing binaries. Any debugging sections and symbols present in
                   6256:       binaries will be preserved.
                   6257:       </p></dd>
1.75      rillig   6258: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6259: <dd><p>A list of directories relative to
1.88      wiz      6260:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      6261:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6262:       The package is supposed to create all needed directories itself
                   6263:       before installing files to it and list all other directories here.
                   6264:       </p></dd>
1.75      rillig   6265: </dl></div>
1.97      rillig   6266: <p>In the rare cases that a package shouldn't install anything,
1.128     wiz      6267:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.97      rillig   6268:     mostly relevant for packages in the <code class="filename">regress</code>
                   6269:     category.</p>
1.75      rillig   6270: </div>
1.148     asau     6271: <div class="sect1">
1.75      rillig   6272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6273: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      6274: <p>Once the install stage has completed, a binary package of
                   6275:     the installed files can be built.  These binary packages can be
                   6276:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  6277:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   6278:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      6279: <p>By default, the binary packages are created in
                   6280:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6281:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6282:     one for each category in the <code class="varname">CATEGORIES</code>
                   6283:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6284:     <code class="filename">pkgsrc/packages</code>.</p>
                   6285: </div>
1.148     asau     6286: <div class="sect1">
1.88      wiz      6287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6288: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      6289: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  6290:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      6291:     to clean the work directories of all dependencies too, use
1.110     hubertf  6292:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   6293: </div>
1.148     asau     6294: <div class="sect1">
1.75      rillig   6295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6296: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148     asau     6297: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6298: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      6299: <dd><p>For any of the main targets described in the
                   6300:          previous section, two auxiliary targets exist with
1.128     wiz      6301:          <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      6302:          prefix for the main target's name.  These targets are
1.88      wiz      6303:          invoked before and after the main target is called,
                   6304:          allowing extra configuration or installation steps be
                   6305:          performed from a package's Makefile, for example, which
                   6306:          a program's configure script or install target
                   6307:          omitted.</p></dd>
1.75      rillig   6308: <dt><span class="term">do-*</span></dt>
1.88      wiz      6309: <dd><p>Should one of the main targets do the wrong thing,
                   6310:          and should there be no variable to fix this, you can
                   6311:          redefine it with the do-* target.  (Note that redefining
                   6312:          the target itself instead of the do-* target is a bad
                   6313:          idea, as the pre-* and post-* targets won't be called
                   6314:          anymore, etc.) You will not usually need to do
                   6315:          this.</p></dd>
1.75      rillig   6316: <dt><span class="term">reinstall</span></dt>
1.88      wiz      6317: <dd>
1.110     hubertf  6318: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      6319:          you noticed some file was not installed properly, you
                   6320:          can repeat the installation with this target, which will
1.128     wiz      6321:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.88      wiz      6322: <p>This is the default value of
                   6323:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  6324:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      6325:          package</strong></span>, where the defaults are
1.128     wiz      6326:          <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      6327:          respectively.</p>
                   6328: </dd>
1.75      rillig   6329: <dt><span class="term">deinstall</span></dt>
                   6330: <dd>
1.232     sevan    6331: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88      wiz      6332:          current directory, effectively de-installing the
                   6333:          package. The following variables can be used to tune the
                   6334:          behaviour:</p>
1.148     asau     6335: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6336: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.232     sevan    6337: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75      rillig   6338: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      6339: <dd><p>Remove all packages that require (depend on)
                   6340:                the given package.  This can be used to remove any
                   6341:                packages that may have been pulled in by a given
1.110     hubertf  6342:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      6343:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      6344:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   6345:                likely to remove whole KDE. Works by adding
1.232     sevan    6346:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88      wiz      6347:                command line.</p></dd>
1.75      rillig   6348: </dl></div>
                   6349: </dd>
1.88      wiz      6350: <dt><span class="term">bin-install</span></dt>
                   6351: <dd><p>Install a binary package from local disk and via FTP
                   6352:          from a list of sites (see the
                   6353:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  6354:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      6355:          available anywhere.  The arguments given to
1.110     hubertf  6356:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      6357:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   6358:          operation, etc.</p></dd>
1.205     wiz      6359: <dt><span class="term">install-clean</span></dt>
                   6360: <dd><p>This target removes the state files for the "install" and later
                   6361:          phases so that the "install" target may be re-invoked. This can be
                   6362:          used after editing the PLIST to install the package without
                   6363:          rebuilding it.</p></dd>
                   6364: <dt><span class="term">build-clean</span></dt>
                   6365: <dd><p>This target removes the state files for the "build" and later
                   6366:          phases so that the "build" target may be re-invoked.</p></dd>
1.75      rillig   6367: <dt><span class="term">update</span></dt>
                   6368: <dd>
1.88      wiz      6369: <p>This target causes the current package to be
                   6370:          updated to the latest version.  The package and all
                   6371:          depending packages first get de-installed, then current
                   6372:          versions of the corresponding packages get compiled and
                   6373:          installed.  This is similar to manually noting which
                   6374:          packages are currently installed, then performing a
1.110     hubertf  6375:          series of <span class="command"><strong>make deinstall</strong></span> and
                   6376:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      6377:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   6378:          packages.</p>
1.128     wiz      6379: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.110     hubertf  6380:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      6381:          update</strong></span> was interrupted for some reason.
                   6382:          However, in this case, make sure you don't call
1.110     hubertf  6383:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      6384:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   6385:          Otherwise, you lose the ability to automatically update
                   6386:          the current package along with the dependent packages
                   6387:          you have installed.</p>
1.110     hubertf  6388: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      6389:          update</strong></span> will only work as long as the package
                   6390:          tree remains unchanged.  If the source code for one of
                   6391:          the packages to be updated has been changed, resuming
1.110     hubertf  6392:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      6393:          fail!</p>
                   6394: <p>The following variables can be used either on the
1.110     hubertf  6395:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   6396:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      6397:          update</strong></span>:</p>
1.148     asau     6398: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6399: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      6400: <dd><p>Install target to recursively use for the
                   6401:                updated package and the dependent packages.
                   6402:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128     wiz      6403:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.110     hubertf  6404:                <span class="command"><strong>make update</strong></span>.  Other good
1.128     wiz      6405:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   6406:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   6407:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.88      wiz      6408:                endless loop!</p></dd>
1.75      rillig   6409: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      6410: <dd><p>Don't clean up after updating.  Useful if
                   6411:                you want to leave the work sources of the updated
                   6412:                packages around for inspection or other purposes.
                   6413:                Be sure you eventually clean up the source tree
1.128     wiz      6414:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.88      wiz      6415:                or you may run into troubles with old source code
                   6416:                still lying around on your next
1.110     hubertf  6417:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      6418:                update</strong></span>.</p></dd>
1.75      rillig   6419: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      6420: <dd><p>Deinstall each package before installing
                   6421:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   6422:                may be necessary if the
1.128     wiz      6423:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.110     hubertf  6424:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      6425:                update</strong></span>.</p></dd>
1.75      rillig   6426: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      6427: <dd><p>Allows you to disable recursion and hardcode
                   6428:                the target for packages.  The default is
1.128     wiz      6429:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.88      wiz      6430:                facilitating a recursive update of prerequisite
                   6431:                packages.  Only set
                   6432:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   6433:                disable recursive updates. Use
                   6434:                <code class="varname">UPDATE_TARGET</code> instead to just
                   6435:                set a specific target for each package to be
1.110     hubertf  6436:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      6437:                (see above).</p></dd>
1.75      rillig   6438: </dl></div>
                   6439: </dd>
                   6440: <dt><span class="term">clean-update</span></dt>
                   6441: <dd>
1.88      wiz      6442: <p>Clean the source tree for all packages that would
1.110     hubertf  6443:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      6444:          from the current directory.  This target should not be
                   6445:          used if the current package (or any of its depending
                   6446:          packages) have already been de-installed (e.g., after
1.110     hubertf  6447:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      6448:          some packages you intended to update. As a rule of
                   6449:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  6450:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      6451:          and only if you have a dirty package tree (e.g., if you
                   6452:          used <code class="varname">NOCLEAN</code>).</p>
                   6453: <p>If you are unsure about whether your tree is
1.110     hubertf  6454:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      6455:          clean</strong></span> at the top of the tree, or use the
                   6456:          following sequence of commands from the directory of the
                   6457:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  6458:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      6459:          time, otherwise you lose all the packages you wanted to
                   6460:          update!):</p>
1.87      wiz      6461: <pre class="screen">
                   6462: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   6463: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      6464: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   6465:          </pre>
1.88      wiz      6466: <p>The following variables can be used either on the
1.110     hubertf  6467:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   6468:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.148     asau     6469: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6470: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  6471: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      6472:                reconstruct the list of directories to update for
1.110     hubertf  6473:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      6474:                update</strong></span> successfully installed all
                   6475:                packages you wanted to update.  Normally, this is
1.110     hubertf  6476:                done automatically on <span class="command"><strong>make
1.88      wiz      6477:                update</strong></span>, but may have been suppressed by
                   6478:                the <code class="varname">NOCLEAN</code> variable (see
                   6479:                above).</p></dd>
1.75      rillig   6480: </dl></div>
                   6481: </dd>
1.88      wiz      6482: <dt><span class="term">replace</span></dt>
                   6483: <dd>
                   6484: <p>Update the installation of the current package.  This
                   6485:          differs from update in that it does not replace dependent
1.232     sevan    6486:          packages.  You will need to install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88      wiz      6487:          target to work.</p>
                   6488: <p><span class="emphasis"><em>Be careful when using this
                   6489:          target!</em></span> There are no guarantees that dependent
                   6490:          packages will still work, in particular they will most
1.110     hubertf  6491:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      6492:          library package whose shared library major version changed
                   6493:          between your installed version and the new one.  For this
                   6494:          reason, this target is not officially supported and only
                   6495:          recommended for advanced users.</p>
                   6496: </dd>
1.75      rillig   6497: <dt><span class="term">info</span></dt>
1.232     sevan    6498: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      6499:          package. You can use this to check which version of a
                   6500:          package is installed.</p></dd>
                   6501: <dt><span class="term">index</span></dt>
                   6502: <dd>
                   6503: <p>This is a top-level command, i.e. it should be used in
                   6504:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   6505:          database of all packages in the local pkgsrc tree, including
                   6506:          dependencies, comment, maintainer, and some other useful
                   6507:          information.  Individual entries are created by running
1.110     hubertf  6508:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      6509:          directories.  This index file is saved as
                   6510:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  6511:          verbose format by running <span class="command"><strong>make
1.88      wiz      6512:          print-index</strong></span>.  You can search in it with
1.110     hubertf  6513:          <span class="command"><strong>make search
1.88      wiz      6514:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   6515:          extract a list of all packages that depend on a particular
1.110     hubertf  6516:          one by running <span class="command"><strong>make show-deps
1.88      wiz      6517:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   6518: <p>Running this command takes a very long time, some
                   6519:          hours even on fast machines!</p>
                   6520: </dd>
1.75      rillig   6521: <dt><span class="term">readme</span></dt>
1.88      wiz      6522: <dd>
                   6523: <p>This target generates a
                   6524:          <code class="filename">README.html</code> file, which can be
1.232     sevan    6525:          viewed using a browser such as <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
1.88      wiz      6526:          contain references to any packages which are in the
                   6527:          <code class="varname">PACKAGES</code> directory on the local
                   6528:          host. The generated files can be made to refer to URLs
                   6529:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   6530:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   6531:          wanted to generate <code class="filename">README.html</code>
                   6532:          files which pointed to binary packages on the local
                   6533:          machine, in the directory
                   6534:          <code class="filename">/usr/packages</code>, set
                   6535:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   6536:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   6537:          <code class="varname">${PACKAGES}</code> directory and its
                   6538:          subdirectories will be searched for all the binary
                   6539:          packages.</p>
                   6540: <p>The target can be run at the toplevel or in category
                   6541:          directories, in which case it descends recursively.</p>
                   6542: </dd>
1.75      rillig   6543: <dt><span class="term">readme-all</span></dt>
1.88      wiz      6544: <dd><p>This is a top-level command, run it in
                   6545:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   6546:          file <code class="filename">README-all.html</code> which contains a
                   6547:          list of all packages currently available in the NetBSD
                   6548:          Packages Collection, together with the category they belong
                   6549:          to and a short description. This file is compiled from the
                   6550:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  6551:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      6552:          readme</strong></span>.</p></dd>
1.75      rillig   6553: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      6554: <dd><p>This is very much the same as the
1.128     wiz      6555:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.88      wiz      6556:          used when generating a pkgsrc tree to be written to a
                   6557:          CD-ROM.  This target also produces
                   6558:          <code class="filename">README.html</code> files, and can be made
                   6559:          to refer to URLs based on
                   6560:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      6561:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   6562: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      6563: <dd><p>This target shows which distfiles and patchfiles
                   6564:          are needed to build the package
                   6565:          (<code class="varname">ALLFILES</code>, which contains all
                   6566:          <code class="varname">DISTFILES</code> and
1.87      wiz      6567:          <code class="varname">PATCHFILES</code>, but not
                   6568:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   6569: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      6570: <dd><p>This target shows nothing if the package is not
                   6571:          installed. If a version of this package is installed,
                   6572:          but is not the version provided in this version of
                   6573:          pkgsrc, then a warning message is displayed. This target
                   6574:          can be used to show which of your installed packages are
                   6575:          downlevel, and so the old versions can be deleted, and
                   6576:          the current ones added.</p></dd>
1.75      rillig   6577: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      6578: <dd><p>This target shows the directory in the pkgsrc
                   6579:          hierarchy from which the package can be built and
                   6580:          installed. This may not be the same directory as the one
                   6581:          from which the package was installed. This target is
                   6582:          intended to be used by people who may wish to upgrade
                   6583:          many packages on a single host, and can be invoked from
                   6584:          the top-level pkgsrc Makefile by using the
1.128     wiz      6585:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.75      rillig   6586: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      6587: <dd><p>This target shows which installed packages match
                   6588:          the current package's <code class="varname">DEPENDS</code>. Useful
                   6589:          if out of date dependencies are causing build
                   6590:          problems.</p></dd>
1.205     wiz      6591: <dt><span class="term">print-build-depends-list</span></dt>
                   6592: <dd><p>This target shows the list of packages that the current package
                   6593:            depends on for building.</p></dd>
                   6594: <dt><span class="term">print-run-depends-list</span></dt>
                   6595: <dd><p>This target shows the list of packages that the current package
                   6596:            depends on for running.</p></dd>
1.75      rillig   6597: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      6598: <dd><p>After a package is installed, check all its
                   6599:          binaries and (on ELF platforms) shared libraries to see
                   6600:          if they find the shared libs they need.  Run by default
1.110     hubertf  6601:          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   6602: <dt><span class="term">print-PLIST</span></dt>
                   6603: <dd>
1.128     wiz      6604: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.88      wiz      6605:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  6606:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      6607:          -newer work/.extract_done</strong></span>.  An attempt is made
                   6608:          to care for shared libs etc., but it is
1.87      wiz      6609:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   6610:          result before putting it into
                   6611:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   6612:          diff the output of this command against an already
                   6613:          existing <code class="filename">PLIST</code> file.</p>
1.232     sevan    6614: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88      wiz      6615:          other methods that don't update file access times, be
                   6616:          sure to add these files manually to your
1.128     wiz      6617:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   6618:          -newer</span>&#8221;</span> command used by this target won't catch
1.87      wiz      6619:          them!</p>
1.128     wiz      6620: <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      6621:          information on this target.</p>
1.75      rillig   6622: </dd>
                   6623: <dt><span class="term">bulk-package</span></dt>
                   6624: <dd>
1.88      wiz      6625: <p>Used to do bulk builds. If an appropriate binary
                   6626:          package already exists, no action is taken. If not, this
                   6627:          target will compile, install and package it (and its
                   6628:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174     asau     6629:          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
                   6630: builds)</i></a>).
1.88      wiz      6631:          After creating the binary package, the sources, the
                   6632:          just-installed package and its required packages are
                   6633:          removed, preserving free disk space.</p>
                   6634: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6635:          all packages installed on a system!</em></span></p>
1.75      rillig   6636: </dd>
                   6637: <dt><span class="term">bulk-install</span></dt>
                   6638: <dd>
1.88      wiz      6639: <p>Used during bulk-installs to install required
                   6640:          packages. If an up-to-date binary package is available,
1.232     sevan    6641:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110     hubertf  6642:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      6643:          but the installed binary won't be removed.</p>
1.88      wiz      6644: <p>A binary package is considered
1.128     wiz      6645:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.232     sevan    6646:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148     asau     6647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6648: <li class="listitem"><p>None of the package's files
1.88      wiz      6649:              (<code class="filename">Makefile</code>, ...) were modified
                   6650:              since it was built.</p></li>
1.128     wiz      6651: <li class="listitem"><p>None of the package's required (binary)
1.88      wiz      6652:              packages were modified since it was built.</p></li>
1.75      rillig   6653: </ul></div>
1.88      wiz      6654: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6655:          all packages installed on a system!</em></span></p>
1.75      rillig   6656: </dd>
                   6657: </dl></div>
                   6658: </div>
                   6659: </div>
1.148     asau     6660: <div class="chapter">
1.75      rillig   6661: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6662: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   6663: <div class="toc">
                   6664: <p><b>Table of Contents</b></p>
1.210     leot     6665: <dl class="toc">
1.106     rillig   6666: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   6667: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   6668: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.75      rillig   6669: </dl>
                   6670: </div>
1.87      wiz      6671: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   6672: by pkgsrc and also for individual packages to define what commands
                   6673: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   6674: or for later run-time of an installed packaged (such as
                   6675: <code class="varname">DEPENDS</code>).
                   6676: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      6677: package will not be used.</p>
                   6678: <p>When building a package, the replacement tools are
1.75      rillig   6679: made available in a directory (as symlinks or wrapper scripts)
                   6680: that is early in the executable search path. Just like the buildlink
1.87      wiz      6681: system, this helps with consistent builds.</p>
                   6682: <p>A tool may be needed to help build a specific package. For example,
                   6683: perl, GNU make (gmake) or yacc may be needed.</p>
                   6684: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   6685: tool may be inefficient for building a package with pkgsrc.
                   6686: For example, a package may need GNU awk, bison (instead of
1.87      wiz      6687: yacc) or a better sed.</p>
                   6688: <p>The tools used by a package can be listed by running
1.110     hubertf  6689: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6690: <div class="sect1">
1.75      rillig   6691: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6692: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      6693: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   6694: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  6695: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6696: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   6697: These can be seen by running:
1.110     hubertf  6698: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      6699: <p>If a package needs a specific program to build
1.75      rillig   6700: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      6701: to define the tools needed.</p>
1.75      rillig   6702: </div>
1.148     asau     6703: <div class="sect1">
1.75      rillig   6704: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6705: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135     wiz      6706: <p>In the following examples, the :run means that it is needed at
                   6707: run-time (and becomes a DEPENDS).
1.75      rillig   6708: The default is a build dependency which can be set with
                   6709: :build. (So in this example, it is the same as gmake:build
1.87      wiz      6710: and pkg-config:build.)</p>
1.75      rillig   6711: <pre class="programlisting">
                   6712: USE_TOOLS+=     gmake perl:run pkg-config
                   6713: </pre>
1.87      wiz      6714: <p>When using the tools framework, a
1.75      rillig   6715: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6716: which contains the full path to the appropriate tool. For example,
1.128     wiz      6717: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.87      wiz      6718: on Linux systems.</p>
                   6719: <p>If you always need a pkgsrc version of the
1.75      rillig   6720: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6721: </p>
                   6722: </div>
1.148     asau     6723: <div class="sect1">
1.75      rillig   6724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6725: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      6726: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   6727: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   6728: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   6729: the name of the common tools. For example:</p>
                   6730: <pre class="programlisting">
                   6731: .if exists(/usr/bin/bzcat)
                   6732: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6733: .elif exists(/usr/bin/bzip2)
                   6734: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6735: .endif
1.69      rillig   6736: 
1.75      rillig   6737: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   6738: </pre>
                   6739: </div>
                   6740: </div>
1.148     asau     6741: <div class="chapter">
1.75      rillig   6742: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6743: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   6744: <div class="toc">
                   6745: <p><b>Table of Contents</b></p>
1.210     leot     6746: <dl class="toc">
1.106     rillig   6747: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   6748: <dd><dl>
1.218     rillig   6749: <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>
                   6750: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                   6751: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                   6752: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                   6753: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                   6754: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                   6755: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                   6756: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   6757: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                   6758: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   6759: <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   6760: </dl></dd>
1.218     rillig   6761: <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   6762: <dd><dl>
                   6763: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   6764: <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      6765: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig   6766: </dl></dd>
1.218     rillig   6767: <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   6768: <dd><dl>
                   6769: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   6770: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   6771: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   6772: </dl></dd>
                   6773: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   6774: <dd><dl>
                   6775: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   6776: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   6777: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      6778: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   6779: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   6780: </dl></dd>
1.218     rillig   6781: <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   6782: <dd><dl>
                   6783: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   6784: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      6785: <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   6786: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   6787: </dl></dd>
1.218     rillig   6788: <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   6789: <dd><dl>
                   6790: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   6791: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   6792: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   6793: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   6794: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   6795: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   6796: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   6797: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   6798: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   6799: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   6800: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   6801: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   6802: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   6803: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   6804: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   6805: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   6806: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   6807: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      6808:     emulation</a></span></dt>
1.106     rillig   6809: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   6810: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   6811: </dl></dd>
1.106     rillig   6812: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   6813: </dl>
                   6814: </div>
1.148     asau     6815: <div class="sect1">
1.75      rillig   6816: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6817: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.78      rillig   6818: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   6819:   different platforms. As a result, it is important to ensure,
                   6820:   where possible, that packages in pkgsrc are portable. This
                   6821:   chapter mentions some particular details you should pay
                   6822:   attention to while working on pkgsrc.</p>
1.148     asau     6823: <div class="sect2">
1.78      rillig   6824: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6825: <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   6826: </h3></div></div></div>
1.78      rillig   6827: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      6828:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  6829:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      6830:     want to use those variables in the preprocessor directives of
1.232     sevan    6831:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      6832:     <code class="literal">.for</code>), you need to include the file
                   6833:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   6834:     loads the user preferences.</p>
1.78      rillig   6835: <p>But note that some variables may not be completely defined
1.219     rillig   6836:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   6837:     included, as they may contain references to variables that are
                   6838:     not yet defined. In shell commands (the lines in
                   6839:     <code class="filename">Makefile</code> that are indented with a tab) this
                   6840:     is no problem, since variables are only expanded when they are
                   6841:     used. But in the preprocessor directives mentioned above and in
                   6842:     dependency lines (of the form <code class="literal">target:
                   6843:     dependencies</code>) the variables are expanded at load
                   6844:     time.</p>
1.148     asau     6845: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   6846: <h3 class="title">Note</h3>
1.218     rillig   6847: <p>To check whether a variable can be used at load time,
                   6848:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   6849: </div>
                   6850: </div>
1.148     asau     6851: <div class="sect2">
1.78      rillig   6852: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6853: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.88      wiz      6854: <p>Occasionally, packages require interaction from the user,
                   6855:     and this can be in a number of ways:</p>
1.148     asau     6856: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6857: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      6858:        interaction such as entering username/password or accepting a
                   6859:        license on a web page.</p></li>
1.128     wiz      6860: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      6861:        passwords.</p></li>
1.128     wiz      6862: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   6863: <li class="listitem"><p>help during the build process</p></li>
                   6864: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   6865: </ul></div>
1.218     rillig   6866: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   6867:     variable to define which stages need interaction. This should be
                   6868:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   6869: <pre class="programlisting">
1.100     rillig   6870: INTERACTIVE_STAGE=      configure install
1.222     sevan    6871: </pre>
1.88      wiz      6872: <p>The user can then decide to skip this package by setting the
1.218     rillig   6873:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   6874:     are also excluded from bulk builds.</p>
1.75      rillig   6875: </div>
1.148     asau     6876: <div class="sect2">
1.75      rillig   6877: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6878: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    6879: <p>Authors of software can choose the licence under which software
                   6880:     can be copied.  The Free Software Foundation has declared some
                   6881:     licenses "Free", and the Open Source Initiative has a definition of
                   6882:     "Open Source".</p>
                   6883: <p>By default, pkgsrc allows packages with Free or Open Source
                   6884:     licenses to be built.  To allow packages with other licenses to be
                   6885:     built as well, the pkgsrc user needs to add these licenses to the
                   6886:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   6887:     that this variable only affects which packages may be
                   6888:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   6889:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      6890: <p>One might want to only install packages with a BSD license,
1.218     rillig   6891:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    6892:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  6893:     user can override the default by setting the
                   6894:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    6895:     of "+=".  The licenses accepted by default are defined in the
                   6896:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   6897:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   6898: <p>The license tag mechanism is intended to address
1.87      wiz      6899:     copyright-related issues surrounding building, installing and
                   6900:     using a package, and not to address redistribution issues (see
                   6901:     <code class="varname">RESTRICTED</code> and
1.222     sevan    6902:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  6903:     Packages with redistribution restrictions should set these
                   6904:     tags.</p>
1.98      wiz      6905: <p>Denoting that a package may be copied according to a
                   6906:     particular license is done by placing the license in
1.87      wiz      6907:     <code class="filename">pkgsrc/licenses</code> and setting the
                   6908:     <code class="varname">LICENSE</code> variable to a string identifying the
1.232     sevan    6909:     license, e.g. in <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      6910: <pre class="programlisting">
1.100     rillig   6911: LICENSE=        xv-license
1.222     sevan    6912: </pre>
1.87      wiz      6913: <p>When trying to build, the user will get a notice that the
1.98      wiz      6914:     package is covered by a license which has not been placed in the
                   6915:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      6916: <pre class="programlisting">
1.100     rillig   6917: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   6918: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   6919: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   6920: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   6921: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   6922: *** Error code 1
1.222     sevan    6923: </pre>
1.110     hubertf  6924: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      6925:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  6926:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      6927:     convey to pkgsrc that it should not in the future fail because of
                   6928:     that license:</p>
1.78      rillig   6929: <pre class="programlisting">
1.100     rillig   6930: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    6931: </pre>
                   6932: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   6933:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   6934:     is deprecated because it does not crisply refer to a particular
                   6935:     license text.  Another problem with such usage is that it does not
                   6936:     enable a user to tell pkgsrc to proceed for a single package
                   6937:     without also telling pkgsrc to proceed for all packages with that
                   6938:     tag.</p>
                   6939: <div class="sect3">
                   6940: <div class="titlepage"><div><div><h4 class="title">
                   6941: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   6942: <p>When adding a package with a new license, the following steps
                   6943:     are required:</p>
                   6944: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6945: <li class="listitem">
1.222     sevan    6946: <p>Check whether the license qualifies as Free or Open
                   6947:     Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
                   6948:     and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
                   6949:     Open Source Initiative</a>.  If this is the case, the filename in
                   6950:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   6951:     <code class="filename">-license</code> suffix, and the license name should be
                   6952:     added to:</p>
1.154     rodent   6953: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6954: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   6955: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
                   6956: </ul></div>
                   6957: </li>
                   6958: <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>
                   6959: </ol></div>
1.222     sevan    6960: </div>
                   6961: <div class="sect3">
                   6962: <div class="titlepage"><div><div><h4 class="title">
                   6963: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      6964: <p>When the license changes (in a way other than formatting),
1.222     sevan    6965:     make sure that the new license has a different name (e.g.,
1.98      wiz      6966:     append the version number if it exists, or the date).  Just
                   6967:     because a user told pkgsrc to build programs under a previous
                   6968:     version of a license does not mean that pkgsrc should build
1.99      rillig   6969:     programs under the new licenses.  The higher-level point is that
1.98      wiz      6970:     pkgsrc does not evaluate licenses for reasonableness; the only
                   6971:     test is a mechanistic test of whether a particular text has been
1.222     sevan    6972:     approved by either of two bodies (FSF or OSI).</p>
                   6973: </div>
1.75      rillig   6974: </div>
1.148     asau     6975: <div class="sect2">
1.75      rillig   6976: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6977: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   6978: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    6979:     By declaring the restrictions, package tools can
1.98      wiz      6980:     automatically refrain from e.g. placing binary packages on FTP
                   6981:     sites.</p>
1.222     sevan    6982: <p>There are four possible restrictions, which are
1.98      wiz      6983:     the cross product of sources (distfiles) and binaries not being
                   6984:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   6985:     language in any license, and because non-Free licenses tend to be
                   6986:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    6987:     CD-ROM.
                   6988: 
                   6989:     "FTP" means making the source or binary file available over the
                   6990:     Internet at no charge.
                   6991: 
                   6992:     "CD-ROM" means making the source or binary available on some kind of
                   6993:     media, together with other source and binary packages, which is sold
                   6994:     for a distribution charge.
1.98      wiz      6995:     </p>
                   6996: <p>In order to encode these restrictions, the package system
1.87      wiz      6997:     defines five make variables that can be set to note these
                   6998:     restrictions:</p>
1.148     asau     6999: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7000: <li class="listitem">
1.75      rillig   7001: <p><code class="varname">RESTRICTED</code></p>
                   7002: <p>This variable should be set whenever a restriction
1.87      wiz      7003:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7004:        string containing the reason for the restriction.  It should
                   7005:        be understood that those wanting to understand the restriction
                   7006:        will have to read the license, and perhaps seek advice of
                   7007:        counsel.</p>
1.75      rillig   7008: </li>
1.128     wiz      7009: <li class="listitem">
1.75      rillig   7010: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7011: <p>Binaries may not be placed on CD-ROM containing other
                   7012:        binary packages, for which a distribution charge may be made.
                   7013:        In this case, set this variable to
                   7014:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7015: </li>
1.128     wiz      7016: <li class="listitem">
1.75      rillig   7017: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7018: <p>Binaries may not made available on the Internet without
                   7019:        charge.  In this case, set this variable to
                   7020:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7021:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7022: </li>
1.128     wiz      7023: <li class="listitem">
1.75      rillig   7024: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7025: <p>Distfiles may not be placed on CD-ROM, together with
                   7026:        other distfiles, for which a fee may be charged.  In this
                   7027:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7028:        </p>
1.75      rillig   7029: </li>
1.128     wiz      7030: <li class="listitem">
1.75      rillig   7031: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7032: <p>Distfiles may not made available via FTP at no charge.
                   7033:        In this case, set this variable to
                   7034:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7035:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7036: </li>
                   7037: </ul></div>
1.222     sevan    7038: <p>Please note that packages will be removed from pkgsrc when the
                   7039:     distfiles are not distributable and cannot be obtained for a period
                   7040:     of one full quarter branch. Packages with manual/interactive fetch
                   7041:     must have a maintainer and it is his/her responsibility to ensure
                   7042:     this.</p>
1.75      rillig   7043: </div>
1.148     asau     7044: <div class="sect2">
1.75      rillig   7045: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7046: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.75      rillig   7047: <p>Your package may depend on some other package being present
1.88      wiz      7048:     - and there are various ways of expressing this dependency.
                   7049:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7050:     <code class="varname">DEPENDS</code> definitions, the
                   7051:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7052:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7053:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  7054:     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   7055: <p>The basic difference between the two variables is as
1.87      wiz      7056:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7057:     that pre-requisite in the binary package so it will be pulled in
                   7058:     when the binary package is later installed, whilst the
                   7059:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7060:     dependency that is only needed for building the package.</p>
1.75      rillig   7061: <p>This means that if you only need a package present whilst
1.87      wiz      7062:     you are building, it should be noted as a
                   7063:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7064: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7065:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7066: <pre class="programlisting">
1.100     rillig   7067: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7068: </pre>
1.128     wiz      7069: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7070:     may include any of the wildcard version numbers recognized by
1.232     sevan    7071:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7072: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7073: <li class="listitem">
1.75      rillig   7074: <p>If your package needs another package's binaries or
1.160     wiz      7075:        libraries to build and run, and if that package has a
1.87      wiz      7076:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7077: <pre class="programlisting">
1.100     rillig   7078: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7079: </pre>
1.75      rillig   7080: </li>
1.128     wiz      7081: <li class="listitem">
1.160     wiz      7082: <p>If your package needs another package's binaries or
                   7083:        libraries only for building, and if that package has a
                   7084:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7085: <pre class="programlisting">
                   7086: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7087: </pre>
1.160     wiz      7088: <p>but set
                   7089:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7090:        to make it a build dependency only. This case is rather
                   7091:        rare.</p>
                   7092: </li>
                   7093: <li class="listitem">
1.132     spz      7094: <p>If your package needs binaries from another package to build,
                   7095:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75      rillig   7096: <pre class="programlisting">
1.132     spz      7097: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.222     sevan    7098: </pre>
1.75      rillig   7099: </li>
1.132     spz      7100: <li class="listitem"><p>If your package needs a library with which to link and
                   7101:        there is no <code class="filename">buildlink3.mk</code> file
                   7102:        available, create one. Using
                   7103:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7104:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7105: <li class="listitem">
1.132     spz      7106: <p>If your package needs some executable to be able to run
                   7107:        correctly and if there's no
                   7108:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7109:        using the <code class="varname">DEPENDS</code> variable. The
1.232     sevan    7110:        <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.132     spz      7111:        be able to execute the latex binary from the teTeX package
                   7112:        when it runs, and that is specified:</p>
1.75      rillig   7113: <pre class="programlisting">
1.132     spz      7114: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.222     sevan    7115: </pre>
1.132     spz      7116: </li>
                   7117: <li class="listitem">
                   7118: <p>You can use wildcards in package dependencies. Note that
                   7119:        such wildcard dependencies are retained when creating binary
                   7120:        packages. The dependency is checked when installing the binary
                   7121:        package and any package which matches the pattern will be
                   7122:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7123: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7124:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7125:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7126:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7127: <p>Wildcards can also be used to specify that a package
1.87      wiz      7128:        will only build against a certain minimum version of a
                   7129:        pre-requisite:</p>
1.75      rillig   7130: <pre class="programlisting">
1.132     spz      7131: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7132: </pre>
1.132     spz      7133: <p>This means that the package will build using version 6.0
                   7134:        of ImageMagick or newer. Such a dependency may be warranted
                   7135:        if, for example, the command line options of an executable
                   7136:        have changed.</p>
                   7137: <p>If you need to depend on minimum versions of libraries,
                   7138:        see the buildlink section of the pkgsrc guide.</p>
1.75      rillig   7139: <p>For security fixes, please update the package
1.218     rillig   7140:        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      7141:        information.</p>
1.75      rillig   7142: </li>
                   7143: </ol></div>
                   7144: <p>If your package needs files from another package to build,
1.87      wiz      7145:     add the relevant distribution files to
                   7146:     <code class="varname">DISTFILES</code>, so they will be extracted
1.232     sevan    7147:     automatically. See the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      7148:     (It relies on the jpeg sources being present in source form
                   7149:     during the build.)</p>
1.75      rillig   7150: </div>
1.148     asau     7151: <div class="sect2">
1.75      rillig   7152: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7153: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7154: <p>Your package may conflict with other packages a user might
1.87      wiz      7155:     already have installed on his system, e.g. if your package
1.88      wiz      7156:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7157:     tree or has the same <code class="varname">PKGNAME</code>.</p>
                   7158: <p>These cases are handled automatically by the packaging tools
                   7159:     at package installation time and do not need to be handled
                   7160:     manually.</p>
                   7161: <p>In case the conflicts can not be recognized automatically
                   7162:     (e.g., packages using the same config file location but no other
                   7163:     shared files), you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      7164:     space-separated list of packages (including version string) your
                   7165:     package conflicts with.</p>
1.232     sevan    7166: <p>For example, if both <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/bar/README.html" target="_top"><code class="filename">foo/bar</code></a>
                   7167:     and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
1.190     wiz      7168:     use the same config file, you would set in
                   7169:     <code class="filename">foo/bar/Makefile</code>:</p>
1.87      wiz      7170: <pre class="programlisting">
1.190     wiz      7171: CONFLICTS=      baz-[0-9]*
1.222     sevan    7172: </pre>
1.190     wiz      7173: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.75      rillig   7174: <pre class="programlisting">
1.190     wiz      7175: CONFLICTS=      bar-[0-9]*
1.222     sevan    7176: </pre>
1.75      rillig   7177: </div>
1.148     asau     7178: <div class="sect2">
1.75      rillig   7179: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7180: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7181: <p>There are several reasons why a package might be
1.88      wiz      7182:     instructed to not build under certain circumstances.  If the
1.87      wiz      7183:     package builds and runs on most platforms, the exceptions
1.193     dholland 7184:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7185:     the package builds and runs on a small handful of platforms,
                   7186:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7187:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7188:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7189:     (OS-version-platform) that can use glob-style
                   7190:     wildcards.</p>
                   7191: <p>If a package is not appropriate for some platforms (as
1.225     maya     7192:     opposed to merely broken), a different set of variables should be
1.193     dholland 7193:     used as this affects failure reporting and statistics.
                   7194:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7195:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7196:     the package is appropriate for only a small handful of platforms
                   7197:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7198:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7199:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7200:     (OS-version-platform) that can use glob-style
                   7201:     wildcards.</p>
1.88      wiz      7202: <p>Some packages are tightly bound to a specific version of an
1.232     sevan    7203:     operating system, e.g. LKMs or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      7204:     backwards compatible with other versions of the OS, and should be
                   7205:     uploaded to a version specific directory on the FTP server.  Mark
                   7206:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7207:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7208:     the package system internals, but may be used in the
                   7209:     future.</p>
1.75      rillig   7210: <p>If the package should be skipped (for example, because it
1.87      wiz      7211:     provides functionality already provided by the system), set
1.88      wiz      7212:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7213:     the package should fail because some preconditions are not met,
                   7214:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7215:     message.</p>
1.75      rillig   7216: </div>
1.148     asau     7217: <div class="sect2">
1.75      rillig   7218: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7219: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7220: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7221:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7222:     be set in the package Makefile. This will be carried into any
                   7223:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7224:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.232     sevan    7225:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7226:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7227: </div>
1.148     asau     7228: <div class="sect2">
1.75      rillig   7229: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7230: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7231: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7232:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      7233:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7234:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7235: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7236:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7237:     course not necessary if the problem is fixed by using a newer
                   7238:     release of the software), and the pattern in the
                   7239:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7240: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7241:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7242: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7243:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7244: </div>
1.148     asau     7245: <div class="sect2">
1.75      rillig   7246: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7247: <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   7248: <p>When making fixes to an existing package it can be useful
1.87      wiz      7249:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7250:     avoid conflicting with future versions by the original author, a
1.128     wiz      7251:     <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      7252:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7253:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7254:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7255: <pre class="programlisting">
1.100     rillig   7256: DISTNAME=       foo-17.42
                   7257: PKGREVISION=    9
1.222     sevan    7258: </pre>
1.75      rillig   7259: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7260:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7261:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7262:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7263:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7264: <p>When a new release of the package is released, the
1.87      wiz      7265:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7266:     minor release of the above package, things should be like:</p>
1.75      rillig   7267: <pre class="programlisting">
1.100     rillig   7268: DISTNAME=       foo-17.43
1.222     sevan    7269: </pre>
1.87      wiz      7270: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7271:     non-trivial change in the resulting binary package.  Without a
                   7272:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7273:     version installed has no way of knowing that their package is out
                   7274:     of date.  Thus, changes without increasing
                   7275:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7276:     trivial that no reasonable person would want to upgrade", and this
                   7277:     is the rough test for when increasing
                   7278:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7279:     changes that do not merit increasing
                   7280:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7281: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7282: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114     jmcneill 7283:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   7284:       or comments in Makefile.</p></li>
1.128     wiz      7285: <li class="listitem"><p>
1.100     rillig   7286:       Changing build variables if the resulting binary package is the same.</p></li>
1.128     wiz      7287: <li class="listitem"><p>
1.100     rillig   7288:       Changing <code class="filename">DESCR</code>.</p></li>
1.128     wiz      7289: <li class="listitem"><p>
1.100     rillig   7290:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   7291: </ul></div>
1.87      wiz      7292: <p>Examples of changes that do merit an increase to
                   7293:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7294: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7295: <li class="listitem"><p>
1.100     rillig   7296:       Security fixes</p></li>
1.128     wiz      7297: <li class="listitem"><p>
1.100     rillig   7298:       Changes or additions to a patch file</p></li>
1.128     wiz      7299: <li class="listitem"><p>
1.100     rillig   7300:       Changes to the <code class="filename">PLIST</code></p></li>
1.128     wiz      7301: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100     rillig   7302: </ul></div>
1.78      rillig   7303: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7304:     changes.</p>
1.75      rillig   7305: </div>
1.148     asau     7306: <div class="sect2">
1.79      rillig   7307: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7308: <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   7309: <p>When you want to replace the same text in multiple files
1.87      wiz      7310:     or when the replacement text varies, patches alone cannot help.
                   7311:     This is where the SUBST framework comes in. It provides an
                   7312:     easy-to-use interface for replacing text in files.
                   7313:     Example:</p>
                   7314: <pre class="programlisting">
1.100     rillig   7315: SUBST_CLASSES+=                 fix-paths
                   7316: SUBST_STAGE.fix-paths=          pre-configure
                   7317: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   7318: SUBST_FILES.fix-paths=          src/*.c
                   7319: SUBST_FILES.fix-paths+=         scripts/*.sh
                   7320: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   7321: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.222     sevan    7322: </pre>
1.79      rillig   7323: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      7324:     that are used to identify the different SUBST blocks that are
                   7325:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   7326:     important to always use the <code class="literal">+=</code> operator with
                   7327:     this variable. Otherwise some substitutions may be
                   7328:     skipped.</p>
1.79      rillig   7329: <p>The remaining variables of each SUBST block are
1.87      wiz      7330:     parameterized with the identifier from the first line
                   7331:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   7332:     parameters to a function call.</p>
1.79      rillig   7333: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      7334:     which the replacement will take place. All combinations of
                   7335:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   7336:     <code class="literal">post-</code> together with a phase name are
                   7337:     possible, though only few are actually used. Most commonly used
                   7338:     are <code class="literal">post-patch</code> and
                   7339:     <code class="literal">pre-configure</code>. Of these two,
                   7340:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  7341:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      7342:     have the state after applying the patches but before making any
                   7343:     other changes. This is especially useful when you are debugging
                   7344:     a package in order to create new patches for it. Similarly,
                   7345:     <code class="literal">post-build</code> is preferred over
                   7346:     <code class="literal">pre-install</code>, because the install phase should
                   7347:     generally be kept as simple as possible. When you use
                   7348:     <code class="literal">post-build</code>, you have the same files in the
                   7349:     working directory that will be installed later, so you can check
                   7350:     if the substitution has succeeded.</p>
1.79      rillig   7351: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      7352:     that is printed just before the substitution is done.</p>
1.79      rillig   7353: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      7354:     globbing patterns that specifies the files in which the
                   7355:     substitution will take place. The patterns are interpreted
                   7356:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   7357: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.232     sevan    7358:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87      wiz      7359:     command should be prefixed with <code class="literal">-e</code>, so that
                   7360:     all SUBST blocks look uniform.</p>
1.79      rillig   7361: <p>There are some more variables, but they are so seldomly
1.87      wiz      7362:     used that they are only documented in the
                   7363:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   7364: </div>
1.75      rillig   7365: </div>
1.148     asau     7366: <div class="sect1">
1.75      rillig   7367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7368: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     7369: <div class="sect2">
1.75      rillig   7370: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7371: <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   7372: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  7373:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      7374:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   7375:     with the name of each file to download as an argument, expecting
                   7376:     it to output the URL of the directory from which to download
1.232     sevan    7377:     it. <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      7378:     example of this usage.</p>
1.75      rillig   7379: <p>If the download can't be automated, because the user must
1.87      wiz      7380:     submit personal information to apply for a password, or must pay
                   7381:     for the source, or whatever, you can set
                   7382:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   7383:     displayed to the user before aborting the build. Example:</p>
                   7384: <pre class="programlisting">
1.100     rillig   7385: FETCH_MESSAGE=  "Please download the files"
                   7386: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   7387: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    7388: </pre>
1.75      rillig   7389: </div>
1.148     asau     7390: <div class="sect2">
1.75      rillig   7391: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7392: <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   7393: <p>Sometimes authors of a software package make some
1.87      wiz      7394:     modifications after the software was released, and they put up a
                   7395:     new distfile without changing the package's version number. If a
                   7396:     package is already in pkgsrc at that time, the checksum will
                   7397:     no longer match. The contents of the new distfile should be
                   7398:     compared against the old one before changing anything, to make
                   7399:     sure the distfile was really updated on purpose, and that
                   7400:     no trojan horse or so crept in.
1.97      rillig   7401:     Please mention that the distfiles were compared and what was found
1.159     rodent   7402:     in your commit message.</p>
1.220     wiz      7403: <p>Then, the correct way to work around this is to set
                   7404:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   7405:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   7406:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   7407:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   7408:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.220     wiz      7409:     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      7410:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      7411:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   7412:     be appended, like
                   7413:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.159     rodent   7414: <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>
                   7415: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      7416:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   7417:     path in the filenames.
1.159     rodent   7418:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      7419:     Furthermore, a mail to the package's authors seems appropriate
                   7420:     telling them that changing distfiles after releases without
                   7421:     changing the file names is not good practice.</p>
1.75      rillig   7422: </div>
1.199     tnn      7423: <div class="sect2">
                   7424: <div class="titlepage"><div><div><h3 class="title">
                   7425: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.200     tnn      7426: <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:
                   7427:     </p>
1.199     tnn      7428: <div class="sect3">
                   7429: <div class="titlepage"><div><div><h4 class="title">
                   7430: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
                   7431: <p>
                   7432:         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.
                   7433:       </p>
                   7434: <pre class="programlisting">
                   7435: DISTNAME=       exampleproject-1.0
1.200     tnn      7436: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7437: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7438: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      7439: EXTRACT_SUFX=   .zip
                   7440: </pre>
                   7441: </div>
                   7442: <div class="sect3">
                   7443: <div class="titlepage"><div><div><h4 class="title">
                   7444: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
                   7445: <p>
                   7446:         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.
                   7447:       </p>
                   7448: <pre class="programlisting">
                   7449: DISTNAME=       example-1.0
1.217     jnemeth  7450: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.200     tnn      7451: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7452: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    7453: </pre>
1.199     tnn      7454: </div>
                   7455: <div class="sect3">
                   7456: <div class="titlepage"><div><div><h4 class="title">
                   7457: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
                   7458: <p>
                   7459:         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.
                   7460:       </p>
                   7461: <pre class="programlisting">
                   7462: DISTNAME=       offensive-1.6
1.200     tnn      7463: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   7464: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7465: GITHUB_PROJECT= exampleproject
                   7466: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   7467: EXTRACT_SUFX=   .zip
1.222     sevan    7468: </pre>
1.199     tnn      7469: </div>
                   7470: </div>
1.75      rillig   7471: </div>
1.148     asau     7472: <div class="sect1">
1.75      rillig   7473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7474: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     7475: <div class="sect2">
1.75      rillig   7476: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7477: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   7478: <p>pkgsrc supports many different machines, with different
1.87      wiz      7479:     object formats like a.out and ELF, and varying abilities to do
                   7480:     shared library and dynamic loading at all. To accompany this,
                   7481:     varying commands and options have to be passed to the
                   7482:     compiler, linker, etc. to get the Right Thing, which can be
                   7483:     pretty annoying especially if you don't have all the machines
                   7484:     at your hand to test things.  The
1.232     sevan    7485:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128     wiz      7486:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      7487:     both static and dynamic libraries from a set of source files,
                   7488:     thus being platform-independent.</p>
                   7489: <p>Here's how to use libtool in a package in seven simple
                   7490:     steps:</p>
1.128     wiz      7491: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7492: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      7493:        Makefile.</p></li>
1.128     wiz      7494: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   7495:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      7496:        add it to the definition of <code class="varname">CC</code>, if only
                   7497:        libraries are being built in a given Makefile. This one command
                   7498:        will build both PIC and non-PIC library objects, so you need not
                   7499:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      7500: <li class="listitem">
1.75      rillig   7501: <p>For the linking of the library, remove any
1.128     wiz      7502:        <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
                   7503:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   7504: <pre class="programlisting">
1.100     rillig   7505: ${LIBTOOL} --mode=link \
                   7506:     ${CC} -o ${.TARGET:.a=.la} \
                   7507:         ${OBJS:.o=.lo} \
                   7508:         -rpath ${PREFIX}/lib \
                   7509:         -version-info major:minor
1.222     sevan    7510: </pre>
1.75      rillig   7511: <p>Note that the library is changed to have a
1.87      wiz      7512:        <code class="filename">.la</code> extension, and the objects are
                   7513:        changed to have a <code class="filename">.lo</code>
                   7514:        extension. Change <code class="varname">OBJS</code> as
                   7515:        necessary. This automatically creates all of the
                   7516:        <code class="filename">.a</code>,
                   7517:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   7518:        necessary) in the build directory. Be sure to include
1.128     wiz      7519:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      7520:        minor are zero, as libtool will otherwise strip off the
                   7521:        shared library version.</p>
1.75      rillig   7522: <p>From the libtool manual:</p>
                   7523: <pre class="programlisting">
1.100     rillig   7524: So, libtool library versions are described by three integers:
1.69      rillig   7525: 
1.100     rillig   7526: CURRENT
                   7527: The most recent interface number that this library implements.
1.69      rillig   7528: 
1.100     rillig   7529: REVISION
                   7530: The implementation number of the CURRENT interface.
1.69      rillig   7531: 
1.100     rillig   7532: AGE
                   7533: The difference between the newest and oldest interfaces that
                   7534: this library implements.  In other words, the library implements
                   7535: all the interface numbers in the range from number `CURRENT -
                   7536: AGE' to `CURRENT'.
1.1       grant    7537: 
1.100     rillig   7538: If two libraries have identical CURRENT and AGE numbers, then the
                   7539: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    7540: </pre>
1.128     wiz      7541: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      7542:        different results for a.out and ELF (excluding symlinks)
                   7543:        in only one case. An ELF library of the form
1.128     wiz      7544:        <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      7545:        will have a symlink of
1.128     wiz      7546:        <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      7547:        on an a.out platform. This is handled
                   7548:        automatically.</p>
1.128     wiz      7549: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      7550:        directory of the library being built.</p>
1.76      rillig   7551: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      7552:        <code class="filename">.la</code> file, the other files will be
                   7553:        added automatically.</p>
1.75      rillig   7554: </li>
1.128     wiz      7555: <li class="listitem">
1.76      rillig   7556: <p>When linking shared object (<code class="filename">.so</code>)
1.232     sevan    7557:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      7558:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   7559:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      7560:        tacked on.</p>
1.76      rillig   7561: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      7562:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   7563: </li>
1.128     wiz      7564: <li class="listitem">
1.75      rillig   7565: <p>When linking programs that depend on these libraries
1.87      wiz      7566:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.232     sevan    7567:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      7568:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      7569:        libraries (static or shared), but please be aware that
                   7570:        libtool will not allow you to specify a relative path in
1.128     wiz      7571:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      7572:        expects you to change that argument to be the
                   7573:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   7574: <pre class="programlisting">
1.100     rillig   7575: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    7576: </pre>
1.75      rillig   7577: <p>should be changed to:</p>
                   7578: <pre class="programlisting">
1.100     rillig   7579: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    7580: </pre>
1.75      rillig   7581: <p>and it will do the right thing with the libraries.</p>
                   7582: </li>
1.128     wiz      7583: <li class="listitem">
1.232     sevan    7584: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   7585:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      7586:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      7587:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   7588: <pre class="programlisting">
1.126     jakllsch 7589: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    7590: </pre>
1.76      rillig   7591: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      7592:        shared library, any needed symlinks, and run
1.232     sevan    7593:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   7594: </li>
1.128     wiz      7595: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      7596:        the <code class="filename">.la</code>
                   7597:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   7598: </ol></div>
                   7599: </div>
1.148     asau     7600: <div class="sect2">
1.75      rillig   7601: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7602: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   7603: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      7604:     package Makefile. This will override the package's own libtool
                   7605:     in most cases.  For older libtool using packages,  libtool is
                   7606:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  7607:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      7608:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   7609: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      7610:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      7611:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   7612:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      7613:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   7614: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      7615:     libraries built and installed, then use
                   7616:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   7617: <p>If your package makes use of the platform-independent library
1.87      wiz      7618:     for loading dynamic shared objects, that comes with libtool
                   7619:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   7620: <p>Some packages use libtool incorrectly so that the package
                   7621:     may not work or build in some circumstances. Some of the more
                   7622:     common errors are:</p>
1.148     asau     7623: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7624: <li class="listitem">
1.75      rillig   7625: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      7626:        executable or library. This in itself isn't a problem if one of two things
                   7627:        has been done:</p>
1.128     wiz      7628: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7629: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      7630:            <code class="filename">libfoo.la</code>, not
                   7631:            <code class="filename">foo.la</code></p></li>
1.128     wiz      7632: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   7633: </ol></div>
                   7634: </li>
1.128     wiz      7635: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      7636:        The function lt_dlinit() should be called and the macro
                   7637:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   7638:        executables.</p></li>
1.75      rillig   7639: </ul></div>
                   7640: </div>
1.148     asau     7641: <div class="sect2">
1.75      rillig   7642: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7643: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   7644: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      7645:     to regenerate the configure script and Makefile.in makefile
                   7646:     templates, then they should be executed in a pre-configure
                   7647:     target.</p>
1.75      rillig   7648: <p>For packages that need only autoconf:</p>
                   7649: <pre class="programlisting">
1.100     rillig   7650: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   7651: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   7652: ...
1.1       grant    7653: 
1.100     rillig   7654: pre-configure:
                   7655:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    7656: 
1.100     rillig   7657: ...
1.222     sevan    7658: </pre>
1.75      rillig   7659: <p>and for packages that need automake and autoconf:</p>
                   7660: <pre class="programlisting">
1.100     rillig   7661: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   7662: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   7663: ...
                   7664: 
                   7665: pre-configure:
                   7666:         set -e; cd ${WRKSRC}; \
                   7667:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    7668: 
1.100     rillig   7669: ...
1.222     sevan    7670: </pre>
1.75      rillig   7671: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      7672:     require GNU Make.</p>
1.75      rillig   7673: <p>There are times when the configure process makes
1.87      wiz      7674:     additional changes to the generated files, which then causes
                   7675:     the build process to try to re-execute the automake sequence.
                   7676:     This is prevented by touching various files in the configure
                   7677:     stage. If this causes problems with your package you can set
                   7678:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   7679:     Makefile.</p>
1.75      rillig   7680: </div>
                   7681: </div>
1.148     asau     7682: <div class="sect1">
1.75      rillig   7683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7684: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148     asau     7685: <div class="sect2">
1.87      wiz      7686: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7687: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      7688: <p>Compilers for the C, C++, and Fortran languages comes with
                   7689:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   7690:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  7691:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      7692: <p>To declare which language's compiler a package needs, set
                   7693:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      7694:     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
                   7695:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   7696:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      7697:     written in C++, usually need a C compiler for the configure
                   7698:     phase.</p>
                   7699: </div>
1.148     asau     7700: <div class="sect2">
1.87      wiz      7701: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7702: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      7703: <p>If a program is written in Java, use the Java framework in
                   7704:     pkgsrc.  The package must include
                   7705:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   7706:     provides the following variables:</p>
1.148     asau     7707: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7708: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      7709:       dependency on the JDK is added.  If
1.128     wiz      7710:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      7711:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      7712:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      7713:       JDK.</p></li>
1.128     wiz      7714: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      7715:       a package needs a Java2 implementation.  The supported values
1.128     wiz      7716:       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
                   7717:       <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
                   7718:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   7719:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      7720:       above. This variable is not set by default.</p></li>
1.130     wiz      7721: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   7722:       automatically set to the runtime location of the used Java
                   7723:       implementation dependency. It may be used to set
                   7724:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   7725:       needs this variable to be defined.
                   7726:       </p></li>
1.87      wiz      7727: </ul></div>
                   7728: </div>
1.148     asau     7729: <div class="sect2">
1.87      wiz      7730: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7731: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      7732: <p>If your package contains interpreted perl scripts, add
1.128     wiz      7733:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      7734:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   7735:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   7736:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      7737:     that you want adjusted. Every occurrence of
                   7738:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   7739:     replaced with the full path to the perl executable.</p>
1.87      wiz      7740: <p>If a particular version of perl is needed, set the
                   7741:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      7742:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.110     hubertf  7743: <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      7744:     about handling perl modules.</p>
                   7745: </div>
1.148     asau     7746: <div class="sect2">
1.87      wiz      7747: <div class="titlepage"><div><div><h3 class="title">
1.147     wiz      7748: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
                   7749: <p><code class="varname">REPLACE_SH</code>,
                   7750:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   7751:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   7752:     hash bangs in files. Please use the appropriate one, prefering
                   7753:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      7754:     Each should contain a list of scripts, relative to
                   7755:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   7756:     occurrence of the matching shell in a she-bang line will be
                   7757:     replaced with the full path to the shell executable.
1.147     wiz      7758:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   7759:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   7760: </div>
1.148     asau     7761: <div class="sect2">
1.147     wiz      7762: <div class="titlepage"><div><div><h3 class="title">
                   7763: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      7764: <p>Currently, there is no special handling for other languages
                   7765:     in pkgsrc.  If a compiler package provides a
                   7766:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   7767:     just add a (build) dependency on the appropriate compiler
                   7768:     package.</p>
                   7769: </div>
                   7770: </div>
1.148     asau     7771: <div class="sect1">
1.87      wiz      7772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7773: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   7774: <p>The most common failures when building a package are that
                   7775:        some platforms do not provide certain header files, functions or
                   7776:        libraries, or they provide the functions in a library that the
                   7777:        original package author didn't know. To work around this, you
                   7778:        can rewrite the source code in most cases so that it does not
                   7779:        use the missing functions or provides a replacement function.</p>
1.148     asau     7780: <div class="sect2">
1.77      rillig   7781: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7782: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   7783: <p>If a package already comes with a GNU configure script, the
                   7784:        preferred way to fix the build failure is to change the
                   7785:        configure script, not the code. In the other cases, you can
                   7786:        utilize the C preprocessor, which defines certain macros
                   7787:        depending on the operating system and hardware architecture it
                   7788:        compiles for. These macros can be queried using for example
                   7789:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   7790:        system, hardware architecture and compiler has its own macro.
                   7791:        For example, if the macros <code class="varname">__GNUC__</code>,
                   7792:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   7793:        are all defined, you know that you are using NetBSD on an i386
                   7794:        compatible CPU, and your compiler is GCC.</p>
                   7795: <p>The list of the following macros for hardware and
                   7796:        operating system depends on the compiler that is used. For
                   7797:        example, if you want to conditionally compile code on Solaris,
                   7798:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   7799:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     7800: <div class="sect3">
1.75      rillig   7801: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7802: <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   7803: <p>To distinguish between 4.4 BSD-derived systems and the
                   7804:         rest of the world, you should use the following code.</p>
                   7805: <pre class="programlisting">
1.100     rillig   7806: #include &lt;sys/param.h&gt;
                   7807: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   7808: /* BSD-specific code goes here */
                   7809: #else
                   7810: /* non-BSD-specific code goes here */
                   7811: #endif
1.75      rillig   7812: </pre>
1.77      rillig   7813: <p>If this distinction is not fine enough, you can also test
                   7814:        for the following macros.</p>
1.75      rillig   7815: <pre class="programlisting">
1.151     obache   7816: Cygwin      __CYGWIN__
                   7817: DragonFly   __DragonFly__
1.100     rillig   7818: FreeBSD     __FreeBSD__
1.151     obache   7819: Haiku       __HAIKU__
1.100     rillig   7820: Interix     __INTERIX
                   7821: IRIX        __sgi (TODO: get a definite source for this)
                   7822: Linux       linux, __linux, __linux__
1.193     dholland 7823: Mac OS X    __APPLE__
1.151     obache   7824: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   7825: Minix3      __minix
1.100     rillig   7826: NetBSD      __NetBSD__
                   7827: OpenBSD     __OpenBSD__
                   7828: Solaris     sun, __sun
1.75      rillig   7829: </pre>
                   7830: </div>
1.148     asau     7831: <div class="sect3">
1.75      rillig   7832: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7833: <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   7834: <pre class="programlisting">
1.100     rillig   7835: i386        i386, __i386, __i386__
                   7836: MIPS        __mips
                   7837: SPARC       sparc, __sparc
1.75      rillig   7838: </pre>
                   7839: </div>
1.148     asau     7840: <div class="sect3">
1.75      rillig   7841: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7842: <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   7843: <pre class="programlisting">
1.100     rillig   7844: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   7845: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   7846: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   7847: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   7848: </pre>
                   7849: </div>
                   7850: </div>
1.148     asau     7851: <div class="sect2">
1.78      rillig   7852: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7853: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   7854: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      7855:         combinations of compiler version and architecture and almost
                   7856:         always relation to optimisation being enabled.  Common symptoms
                   7857:         are gcc internal errors or never finishing compiling a
1.78      rillig   7858:        file.</p>
                   7859: <p>Typically, a workaround involves testing the
                   7860:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   7861:         optimisation for that combination of file,
1.198     tnn      7862:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   7863: <p>This used to be a big problem in the past, but is rarely
                   7864:        needed now as compiler technology has matured. If you still need
                   7865:        to add a compiler specific workaround, please do so in the file
                   7866:        <code class="filename">hacks.mk</code> and describe the symptom and
                   7867:        compiler version as detailed as possible.</p>
1.78      rillig   7868: </div>
1.148     asau     7869: <div class="sect2">
1.78      rillig   7870: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz      7871: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   7872: </h3></div></div></div>
1.92      rillig   7873: <p>This error message often means that a package did not
1.78      rillig   7874:        link to a shared library it needs. The following functions are
                   7875:        known to cause this error message over and over.</p>
                   7876: <div class="informaltable">
1.216     tnn      7877: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   7878: <colgroup>
                   7879: <col>
                   7880: <col>
                   7881: <col>
                   7882: </colgroup>
                   7883: <thead><tr>
                   7884: <th>Function</th>
                   7885: <th>Library</th>
                   7886: <th>Affected platforms</th>
                   7887: </tr></thead>
                   7888: <tbody>
                   7889: <tr>
                   7890: <td>accept, bind, connect</td>
                   7891: <td>-lsocket</td>
                   7892: <td>Solaris</td>
                   7893: </tr>
                   7894: <tr>
                   7895: <td>crypt</td>
                   7896: <td>-lcrypt</td>
                   7897: <td>DragonFly, NetBSD</td>
                   7898: </tr>
                   7899: <tr>
                   7900: <td>dlopen, dlsym</td>
                   7901: <td>-ldl</td>
                   7902: <td>Linux</td>
                   7903: </tr>
                   7904: <tr>
                   7905: <td>gethost*</td>
                   7906: <td>-lnsl</td>
                   7907: <td>Solaris</td>
                   7908: </tr>
                   7909: <tr>
                   7910: <td>inet_aton</td>
                   7911: <td>-lresolv</td>
                   7912: <td>Solaris</td>
                   7913: </tr>
                   7914: <tr>
                   7915: <td>nanosleep, sem_*, timer_*</td>
                   7916: <td>-lrt</td>
                   7917: <td>Solaris</td>
                   7918: </tr>
                   7919: <tr>
                   7920: <td>openpty</td>
                   7921: <td>-lutil</td>
                   7922: <td>Linux</td>
                   7923: </tr>
                   7924: </tbody>
                   7925: </table>
                   7926: </div>
                   7927: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      7928:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   7929:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  7930:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      7931:     bmake</strong></span>.</p>
1.148     asau     7932: <div class="sect3">
1.92      rillig   7933: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7934: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   7935: <p>When you are using the SunPro compiler, there is another
                   7936: possibility. That compiler cannot handle the following code:</p>
                   7937: <pre class="programlisting">
1.100     rillig   7938: extern int extern_func(int);
1.93      rillig   7939: 
1.100     rillig   7940: static inline int
                   7941: inline_func(int x)
                   7942: {
1.92      rillig   7943:         return extern_func(x);
1.100     rillig   7944: }
1.93      rillig   7945: 
1.100     rillig   7946: int main(void)
                   7947: {
1.92      rillig   7948:         return 0;
1.100     rillig   7949: }
1.92      rillig   7950: </pre>
                   7951: <p>It generates the code for <code class="function">inline_func</code> even if
                   7952: that function is never used. This code then refers to
                   7953: <code class="function">extern_func</code>, which can usually not be resolved. To
                   7954: solve this problem you can try to tell the package to disable inlining
                   7955: of functions.</p>
                   7956: </div>
1.87      wiz      7957: </div>
1.148     asau     7958: <div class="sect2">
1.87      wiz      7959: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7960: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      7961: <p>Sometimes packages fail to build because the compiler runs
                   7962:     into an operating system specific soft limit.  With the
                   7963:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      7964:     to unlimit the resources.  Currently, the allowed values are any combination of
                   7965:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   7966:     <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      7967:     Setting this variable is similar to running the shell builtin
1.110     hubertf  7968:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      7969:     segment size or maximum stack size of a process, respectively, to
                   7970:     their hard limits.</p>
1.78      rillig   7971: </div>
1.75      rillig   7972: </div>
1.148     asau     7973: <div class="sect1">
1.75      rillig   7974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7975: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     7976: <div class="sect2">
1.75      rillig   7977: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7978: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  7979: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      7980:     with some operating systems cannot create more than one
                   7981:     directory at a time. As such, you should call
                   7982:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   7983: <pre class="programlisting">
1.100     rillig   7984: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   7985: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    7986: </pre>
1.128     wiz      7987: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   7988:     dir2</code></span>&#8221;</span> to the
1.87      wiz      7989:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   7990:     automatically do the right thing.</p>
1.75      rillig   7991: </div>
1.148     asau     7992: <div class="sect2">
1.75      rillig   7993: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7994: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      7995: <p>In general, documentation should be installed into
1.87      wiz      7996:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   7997:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   7998:     includes the version number of the package).</p>
1.84      wiz      7999: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8000:     directory where HTML documentation is installed with the
1.128     wiz      8001:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      8002:     is needed because otherwise the documentation ends up in
                   8003:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8004:     places.</p>
                   8005: <p>An exception to the above is that library API documentation
1.232     sevan    8006:     generated with the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      8007:     browsers (devhelp) should be left at their default location, which
                   8008:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8009:     documentation can be recognized from files ending in
                   8010:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8011:     (It is also acceptable to install such files in
                   8012:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8013:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8014:     <code class="filename">.devhelp*</code> file must be directly in that
                   8015:     directory then, no additional subdirectory level is allowed in
                   8016:     this case. This is usually achieved by using
1.128     wiz      8017:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      8018:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8019:     though.)</p>
1.75      rillig   8020: </div>
1.148     asau     8021: <div class="sect2">
1.75      rillig   8022: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8023: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8024: <p>Certain packages, most of them in the games category, install
1.87      wiz      8025:     a score file that allows all users on the system to record their
                   8026:     highscores.  In order for this to work, the binaries need to be
                   8027:     installed setgid and the score files owned by the appropriate
1.142     wiz      8028:     group and/or owner (traditionally the "games" user/group).  Set
                   8029:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      8030:     following variables, documented in more detail in
                   8031:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      8032:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8033:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     8034:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8035:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8036:     <code class="varname">GAMEDATA_PERMS</code> and
                   8037:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8038: <p>An example that illustrates some of the variables described above is
                   8039:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8040:     used to properly set directory permissions of the directory where the
                   8041:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8042:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8043:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8044:     binary:</p>
                   8045: <pre class="programlisting">
1.223     rillig   8046: USE_GAMESGROUP=         yes
1.210     leot     8047: 
1.223     rillig   8048: BUILD_DEFS+=            VARBASE
1.210     leot     8049: 
1.223     rillig   8050: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8051: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8052: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    8053: </pre>
1.210     leot     8054: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8055:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8056:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8057:     needed to be accessed by setgid games and
                   8058:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 8059: <p>A package should therefore never hard code file ownership or
1.210     leot     8060:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8061:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8062:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8063:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   8064: </div>
1.148     asau     8065: <div class="sect2">
1.75      rillig   8066: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8067: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8068: <p><code class="varname">DESTDIR</code> support means that a package
                   8069:     installs into a staging directory, not the final location of the
                   8070:     files. Then a binary package is created which can be used for
                   8071:     installation as usual. There are two ways: Either the package must
1.128     wiz      8072:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8073:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     8074: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8075: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     8076:       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>.
                   8077:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      8078:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8079:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 8080:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8081:       the inclusion.</p></li>
1.128     wiz      8082: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      8083:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      8084: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      8085:       automatically. Many manual rules and pre/post-install often are
                   8086:       incorrect; fix them.</p></li>
1.128     wiz      8087: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     8088:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      8089: <li class="listitem"><p>In general, packages should support
1.103     wiz      8090:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8091:       DESTDIR.</p></li>
                   8092: </ul></div>
                   8093: </div>
1.148     asau     8094: <div class="sect2">
1.103     wiz      8095: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8096: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8097: <p>Your package may also contain scripts with hardcoded paths to
                   8098:       other interpreters besides (or as well as) perl.  To correct the
                   8099:       full pathname to the script interpreter, you need to set the
                   8100:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8101:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8102: <pre class="programlisting">
1.100     rillig   8103: REPLACE_INTERPRETER+=   tcl
                   8104: REPLACE.tcl.old=        .*/bin/tclsh
                   8105: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8106: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8107: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    8108: </pre>
1.148     asau     8109: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8110: <h3 class="title">Note</h3>
                   8111: <p>Before March 2006, these variables were called
1.87      wiz      8112:     <code class="varname">_REPLACE.*</code> and
                   8113:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8114: </div>
                   8115: </div>
1.148     asau     8116: <div class="sect2">
1.75      rillig   8117: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8118: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8119: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8120:     the Makefile fragment
                   8121:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8122:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8123:     configuration for such modules as well as various hooks to tune
                   8124:     this configuration.  See comments in this file for
                   8125:     details.</p>
1.75      rillig   8126: <p>Perl5 modules will install into different places depending
1.87      wiz      8127:     on the version of perl used during the build process.  To
                   8128:     address this, pkgsrc will append lines to the
                   8129:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8130:     the installed <code class="filename">.packlist</code> file generated by
                   8131:     most perl5 modules.  This is invoked by defining
                   8132:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      8133:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8134:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8135:     e.g.:</p>
1.75      rillig   8136: <pre class="programlisting">
1.153     wiz      8137: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    8138: </pre>
1.153     wiz      8139: <p>The perl5 config variables
                   8140:     <code class="varname">installarchlib</code>,
                   8141:     <code class="varname">installscript</code>,
                   8142:     <code class="varname">installvendorbin</code>,
                   8143:     <code class="varname">installvendorscript</code>,
                   8144:     <code class="varname">installvendorarch</code>,
                   8145:     <code class="varname">installvendorlib</code>,
                   8146:     <code class="varname">installvendorman1dir</code>, and
                   8147:     <code class="varname">installvendorman3dir</code> represent those
                   8148:     locations in which components of perl5 modules may be installed,
                   8149:     provided as variable with uppercase and prefixed with
                   8150:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8151:     and may be used by perl5 packages that don't have a packlist.
                   8152:     These variables are also substituted for in the
                   8153:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8154:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   8155: </div>
1.148     asau     8156: <div class="sect2">
1.75      rillig   8157: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8158: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8159: <p>Some packages install info files or use the
1.128     wiz      8160:     <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      8161:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8162:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8163:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8164:     handle registration of the info files in the Info directory
1.128     wiz      8165:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      8166:     files registration is either provided by the system, or by a
                   8167:     special purpose package automatically added as dependency if
                   8168:     needed.</p>
1.75      rillig   8169: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8170:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8171:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      8172:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   8173: <p>The info files for the package should be listed in the
1.87      wiz      8174:     package <code class="filename">PLIST</code>; however any split info files
                   8175:     need not be listed.</p>
1.128     wiz      8176: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8177:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      8178:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      8179:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      8180:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8181:     variable in the package <code class="filename">Makefile</code>. By
                   8182:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  8183:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      8184:     does not match the required minimum, a build dependency on the
1.232     sevan    8185:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      8186:     be added automatically.</p>
1.75      rillig   8187: <p>The build and installation process of the software provided
1.87      wiz      8188:     by the package should not use the
1.110     hubertf  8189:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      8190:     info files is the task of the package
                   8191:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  8192:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   8193: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  8194:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8195:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      8196:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  8197: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      8198:     no effect except the logging of a message. The script overriding
1.110     hubertf  8199:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      8200:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  8201:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8202: </div>
1.148     asau     8203: <div class="sect2">
1.75      rillig   8204: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8205: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8206: <p>All packages that install manual pages should install them
1.87      wiz      8207:     into the same directory, so that there is one common place to look
                   8208:     for them. In pkgsrc, this place is
                   8209:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8210:     should be used in packages. The default for
                   8211:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      8212:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8213:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     8214: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8215: <h3 class="title">Note</h3>
1.87      wiz      8216: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8217:     is far from complete.</p>
1.75      rillig   8218: </div>
1.81      rillig   8219: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8220:     <code class="filename">man/</code> as the top level directory for the man
                   8221:     page file entries, and the pkgsrc framework will convert as
                   8222:     needed. In all other places, the correct
                   8223:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8224: <p>Packages that are
                   8225:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      8226:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      8227:     <code class="filename">./configure</code>
                   8228:     --mandir switch to set where the man pages should be installed.
                   8229:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8230:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8231: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8232:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      8233:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      8234:     Or if the <code class="filename">./configure</code> script uses
                   8235:     a non-standard use of --mandir, you can set
                   8236:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  8237: <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      8238:     information on installation of compressed manual pages.</p>
1.75      rillig   8239: </div>
1.148     asau     8240: <div class="sect2">
1.75      rillig   8241: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   8242: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      8243: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   8244:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      8245:     you need to take some extra steps to make sure they get registered
                   8246:     in the database:</p>
1.128     wiz      8247: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8248: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      8249:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   8250:        takes care of rebuilding the GConf database at installation and
1.87      wiz      8251:        deinstallation time, and tells the package where to install
1.107     rillig   8252:        GConf data files using some standard configure arguments.  It
1.87      wiz      8253:        also disallows any access to the database directly from the
                   8254:        package.</p></li>
1.128     wiz      8255: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      8256:        <code class="filename">.schemas</code> files under
                   8257:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8258:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8259:        need to manually patch the package.</p></li>
1.128     wiz      8260: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8261:        directory, as they will be handled automatically.  See
1.194     bsiegert 8262:        <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      8263: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      8264:        your <code class="filename">Makefile</code> with a list of all
                   8265:        <code class="filename">.schemas</code> files installed by the package, if
                   8266:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      8267: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      8268:        your <code class="filename">Makefile</code> with a
                   8269:        list of all <code class="filename">.entries</code> files installed by the
                   8270:        package, if any. Names must not contain any directories in
                   8271:        them.</p></li>
1.75      rillig   8272: </ol></div>
                   8273: </div>
1.148     asau     8274: <div class="sect2">
1.75      rillig   8275: <div class="titlepage"><div><div><h3 class="title">
1.119     mishka   8276: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      8277: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   8278:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      8279:     get registered in the database:</p>
1.128     wiz      8280: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8281: <li class="listitem"><p>Include
1.119     mishka   8282:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   8283:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      8284:        takes care of rebuilding the scrollkeeper database at
                   8285:        installation and deinstallation time, and disallows any access
                   8286:        to it directly from the package.</p></li>
1.128     wiz      8287: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8288:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8289:        will be handled automatically.</p></li>
1.128     wiz      8290: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   8291:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   8292:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   8293: </ol></div>
                   8294: </div>
1.148     asau     8295: <div class="sect2">
1.75      rillig   8296: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8297: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   8298: <p>If a package installs font files, you will need to rebuild
1.87      wiz      8299:     the fonts database in the directory where they get installed at
                   8300:     installation and deinstallation time.  This can be automatically
                   8301:     done by using the pkginstall framework.</p>
1.75      rillig   8302: <p>You can list the directories where fonts are installed in the
1.87      wiz      8303:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8304:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      8305:     <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      8306:     Also make sure that the database file
                   8307:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   8308: <p>Note that you should not create new directories for fonts;
1.87      wiz      8309:     instead use the standard ones to avoid that the user needs to
                   8310:     manually configure his X server to find them.</p>
1.75      rillig   8311: </div>
1.148     asau     8312: <div class="sect2">
1.75      rillig   8313: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8314: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   8315: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      8316:     take some extra steps to get them registered in the GTK2 database
                   8317:     properly:</p>
1.128     wiz      8318: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8319: <li class="listitem"><p>Include
1.87      wiz      8320:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8321:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8322:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      8323: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      8324:       your package installs GTK2 immodules.</p></li>
1.128     wiz      8325: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      8326:       GTK2 loaders.</p></li>
1.128     wiz      8327: <li class="listitem">
1.87      wiz      8328: <p>Patch the package to not touch any of the GTK2
                   8329:       databases directly.  These are:</p>
1.148     asau     8330: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8331: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8332: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   8333: </ul></div>
                   8334: </li>
1.128     wiz      8335: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      8336:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8337:       directory, as they will be handled automatically.</p></li>
1.75      rillig   8338: </ol></div>
                   8339: </div>
1.148     asau     8340: <div class="sect2">
1.75      rillig   8341: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8342: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   8343: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      8344:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8345:     etc.), you need to take some extra steps:</p>
1.128     wiz      8346: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8347: <li class="listitem"><p>Include
1.87      wiz      8348:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8349:        your <code class="filename">Makefile</code>, which takes care of
                   8350:        registering those files in system-wide catalogs at
                   8351:        installation and deinstallation time.</p></li>
1.128     wiz      8352: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      8353:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      8354: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      8355:        any XML catalogs installed by the package.</p></li>
1.128     wiz      8356: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      8357:        to be added to the SGML catalog.  These come in groups of
                   8358:        three strings; see xmlcatmgr(1) for more information
                   8359:        (specifically, arguments recognized by the 'add' action).
                   8360:        Note that you will normally not use this variable.</p></li>
1.128     wiz      8361: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      8362:        to be added to the XML catalog.  These come in groups of three
                   8363:        strings; see xmlcatmgr(1) for more information (specifically,
                   8364:        arguments recognized by the 'add' action).  Note that you will
                   8365:        normally not use this variable.</p></li>
1.75      rillig   8366: </ol></div>
                   8367: </div>
1.148     asau     8368: <div class="sect2">
1.75      rillig   8369: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8370: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   8371: <p>If a package provides extensions to the MIME database by
1.87      wiz      8372:     installing <code class="filename">.xml</code> files inside
                   8373:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8374:     need to take some extra steps to ensure that the database is kept
                   8375:     consistent with respect to these new files:</p>
1.128     wiz      8376: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8377: <li class="listitem"><p>Include
1.87      wiz      8378:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   8379:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   8380:        this same directory, which is reserved for inclusion from
                   8381:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   8382:        care of rebuilding the MIME database at installation and
                   8383:        deinstallation time, and disallows any access to it directly
                   8384:        from the package.</p></li>
1.128     wiz      8385: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8386:        <code class="filename">share/mime</code> directory,
                   8387:        <span class="emphasis"><em>except</em></span> for files saved under
                   8388:        <code class="filename">share/mime/packages</code>.  The former are
                   8389:        handled automatically by
                   8390:        the update-mime-database program, but the latter are
                   8391:        package-dependent and must be removed by the package that
                   8392:        installed them in the first place.</p></li>
1.128     wiz      8393: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      8394:        from the PLIST.  They will be handled by the shared-mime-info
                   8395:        package.</p></li>
1.75      rillig   8396: </ol></div>
                   8397: </div>
1.148     asau     8398: <div class="sect2">
1.75      rillig   8399: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8400: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   8401: <p>If a package uses intltool during its build, add
                   8402:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      8403:     which forces it to use the intltool package provided by pkgsrc,
                   8404:     instead of the one bundled with the distribution file.</p>
1.75      rillig   8405: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      8406:     latest available version; this way, the package benefits of any
                   8407:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   8408: </div>
1.148     asau     8409: <div class="sect2">
1.75      rillig   8410: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8411: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   8412: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      8413:     the startup directory by default, but you can enable it, by adding
                   8414:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  8415:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      8416:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   8417:     it will automatically remove the scripts when the package is
                   8418:     deinstalled.</p>
1.75      rillig   8419: </div>
1.148     asau     8420: <div class="sect2">
1.75      rillig   8421: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8422: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   8423: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      8424:     the <code class="filename">ls-R</code> database of the tree needs to be
                   8425:     updated.</p>
1.148     asau     8426: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8427: <h3 class="title">Note</h3>
1.125     wiz      8428: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      8429:     packages should install files
1.125     wiz      8430:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8431:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   8432: </div>
1.128     wiz      8433: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8434: <li class="listitem"><p>Include
1.125     wiz      8435:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      8436:       takes care of rebuilding the <code class="filename">ls-R</code>
                   8437:       database at installation and deinstallation time.</p></li>
1.128     wiz      8438: <li class="listitem">
1.75      rillig   8439: <p>If your package installs files into a texmf
1.87      wiz      8440:       tree other than the one
1.125     wiz      8441:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8442:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      8443:       trees that need database update.</p>
1.75      rillig   8444: <p>If your package also installs font map files that need
1.110     hubertf  8445:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 8446:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      8447:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   8448:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  8449:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      8450:       be run automatically at installation/deinstallation to
                   8451:       enable/disable font map files for TeX output
                   8452:       drivers.</p>
1.75      rillig   8453: </li>
1.128     wiz      8454: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      8455:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 8456:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   8457: </ol></div>
                   8458: </div>
1.148     asau     8459: <div class="sect2">
1.85      jmmv     8460: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8461: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      8462:     emulation</h3></div></div></div>
                   8463: <p>There are some packages that provide libraries and
                   8464:     executables for running binaries from a one operating system
                   8465:     on a different one (if the latter supports it).  One example
                   8466:     is running Linux binaries on NetBSD.</p>
1.232     sevan    8467: <p>The <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      8468:     helps in extracting and packaging Linux rpm packages.</p>
                   8469: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  8470:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      8471:     if all libraries for each installed executable can be found by
                   8472:     the dynamic linker.  Since the standard dynamic linker is run,
                   8473:     this fails for emulation packages, because the libraries used
                   8474:     by the emulation are not in the standard directories.</p>
                   8475: </div>
1.148     asau     8476: <div class="sect2">
1.87      wiz      8477: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8478: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     8479: <p>If a package installs images under the
1.87      wiz      8480:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   8481:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   8482:     database, you need to take some extra steps to make sure that the
                   8483:     shared theme directory is handled appropriately and that the cache
                   8484:     database is rebuilt:</p>
1.128     wiz      8485: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8486: <li class="listitem"><p>Include
1.87      wiz      8487:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128     wiz      8488: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87      wiz      8489:        entry that refers to the theme cache.</p></li>
1.128     wiz      8490: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85      jmmv     8491:          directories from the <code class="filename">share/icons/hicolor</code>
                   8492:          hierarchy because they will be handled automatically.</p></li>
                   8493: </ol></div>
                   8494: <p>The best way to verify that the PLIST is correct with
                   8495:       respect to the last two points is to regenerate it using
1.110     hubertf  8496:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     8497: </div>
1.148     asau     8498: <div class="sect2">
1.85      jmmv     8499: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8500: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     8501: <p>If a package installs <code class="filename">.desktop</code> files
                   8502:       under <code class="filename">share/applications</code> and these include
1.159     rodent   8503:       MIME information (MimeType key), you need to take extra steps to
                   8504:       ensure that they are registered into the MIME database:</p>
1.128     wiz      8505: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8506: <li class="listitem"><p>Include
1.85      jmmv     8507:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128     wiz      8508: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85      jmmv     8509:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   8510:          It will be handled automatically.</p></li>
                   8511: </ol></div>
                   8512: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  8513:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     8514:       print-PLIST</strong></span>.</p>
1.75      rillig   8515: </div>
                   8516: </div>
1.148     asau     8517: <div class="sect1">
1.87      wiz      8518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8519: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      8520: <p>In some cases one does not have the time to solve a problem
1.125     wiz      8521:   immediately. In this case, one can plainly mark a package as broken.  For
                   8522:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   8523:   reason why the package is broken (similar to the
                   8524:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   8525:   the package will immediately be shown this message, and the build
                   8526:   will not be even tried.</p>
                   8527: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87      wiz      8528:   intervals.</p>
                   8529: </div>
1.75      rillig   8530: </div>
1.148     asau     8531: <div class="chapter">
1.75      rillig   8532: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   8533: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      8534: <p>To check out all the gotchas when building a package, here are
                   8535:   the steps that I do in order to get a package working.  Please note
                   8536:   this is basically the same as what was explained in the previous
                   8537:   sections, only with some debugging aids.</p>
1.148     asau     8538: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8539: <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>
                   8540: <li class="listitem">
1.232     sevan    8541: <p>Install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88      wiz      8542:       create a directory for a new package, change into it, then run
1.110     hubertf  8543:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   8544: <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>
                   8545: <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>
                   8546: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   8547: </li>
1.128     wiz      8548: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   8549: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   8550: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   8551: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      8552:       configure step to the package's
                   8553:       <code class="filename">Makefile</code>.</p></li>
1.128     wiz      8554: <li class="listitem">
1.75      rillig   8555: <p>Make the package compile, doing multiple rounds of</p>
                   8556: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   8557: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   8558: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   8559: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   8560: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   8561: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   8562: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      8563: <p>Doing this step as non-root user will ensure that no files
                   8564:       are modified that shouldn't be, especially during the build
1.110     hubertf  8565:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   8566:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.232     sevan    8567:       from the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88      wiz      8568:       package.</p>
1.75      rillig   8569: </li>
1.128     wiz      8570: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   8571:       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>
                   8572: <li class="listitem">
1.76      rillig   8573: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   8574: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8575: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   8576: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   8577: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8578: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      8579: <p>You usually need to be <code class="username">root</code> to do
                   8580:       this.  Look if there are any files left:</p>
1.75      rillig   8581: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8582: <p>If this reveals any files that are missing in
1.88      wiz      8583:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   8584: </li>
1.128     wiz      8585: <li class="listitem">
1.88      wiz      8586: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   8587:       package again and make a binary package:</p>
1.75      rillig   8588: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   8589: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   8590: </li>
1.128     wiz      8591: <li class="listitem">
1.75      rillig   8592: <p>Delete the installed package:</p>
1.88      wiz      8593: <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   8594: </li>
1.128     wiz      8595: <li class="listitem">
1.110     hubertf  8596: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      8597:       command, which shouldn't find anything now:</p>
1.75      rillig   8598: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8599: </li>
1.128     wiz      8600: <li class="listitem">
1.75      rillig   8601: <p>Reinstall the binary package:</p>
1.93      rillig   8602: <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   8603: </li>
1.128     wiz      8604: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   8605: <li class="listitem">
1.232     sevan    8606: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88      wiz      8607:       reports:</p>
1.75      rillig   8608: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   8609: </li>
1.128     wiz      8610: <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   8611: </ul></div>
                   8612: </div>
1.148     asau     8613: <div class="chapter">
1.75      rillig   8614: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   8615: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   8616: <div class="toc">
                   8617: <p><b>Table of Contents</b></p>
1.210     leot     8618: <dl class="toc">
1.106     rillig   8619: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   8620: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   8621: <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      8622: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig   8623: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     8624: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   8625: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   8626: </dl>
                   8627: </div>
1.148     asau     8628: <div class="sect1">
1.75      rillig   8629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8630: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   8631: <p>Our policy is that we accept binaries only from pkgsrc
                   8632:        developers to guarantee that the packages don't contain any
                   8633:        trojan horses etc. This is not to annoy anyone but rather to
                   8634:        protect our users! You're still free to put up your home-made
                   8635:        binary packages and tell the world where to get them. NetBSD
                   8636:        developers doing bulk builds and wanting to upload them please
1.174     asau     8637:        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
                   8638: builds)</i></a>.</p>
1.75      rillig   8639: </div>
1.148     asau     8640: <div class="sect1">
1.75      rillig   8641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8642: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   8643: <p>First, check that your package is complete, compiles and
1.110     hubertf  8644:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.232     sevan    8645:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   8646:        archive that contains all files that make up the package.
1.87      wiz      8647:        Finally, send this package to the pkgsrc bug tracking system,
1.232     sevan    8648:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      8649:        that, go to the web page
1.110     hubertf  8650:        <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      8651:        which contains some instructions and a link to a form where you
                   8652:        can submit packages.  The
1.232     sevan    8653:        <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124     snj      8654:        also available as a substitute for either of the above two tools.
                   8655:        </p>
1.87      wiz      8656: <p>In the form of the problem report, the category should be
1.128     wiz      8657:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      8658:        and version number, and the description field should contain a
                   8659:        short description of your package (contents of the COMMENT
                   8660:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      8661:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   8662: <p>If you want to submit several packages, please send a
                   8663:        separate PR for each one, it's easier for us to track things
                   8664:        that way.</p>
                   8665: <p>Alternatively, you can also import new packages into
1.128     wiz      8666:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.215     wiz      8667:        homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.75      rillig   8668:        for details.</p>
                   8669: </div>
1.148     asau     8670: <div class="sect1">
1.75      rillig   8671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8672: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   8673: <p>Please note all package additions, updates, moves, and
1.93      rillig   8674:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   8675:        important to keep this file up to date and conforming to the
                   8676:        existing format, because it will be used by scripts to
1.110     hubertf  8677:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   8678:        sites. Additionally, check the
1.76      rillig   8679:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   8680:        for the package you updated or removed, in case it was mentioned
                   8681:        there.</p>
                   8682: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   8683:        bumped, the change should appear in
1.93      rillig   8684:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   8685:        related or otherwise relevant. Mass bumps that result from a
                   8686:        dependency being updated should not be mentioned. In all other
                   8687:        cases it's the developer's decision.</p>
                   8688: <p>There is a make target that helps in creating proper
1.110     hubertf  8689:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   8690:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   8691:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   8692:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   8693:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  8694:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   8695:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   8696:   For new packages, or package moves or removals, set the
                   8697:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   8698:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  8699:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      8700:   not the same as your NetBSD login name. The target also automatically
                   8701:   removes possibly existing entries for the package in the
                   8702:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     8703:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 8704:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      8705:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   8706:   makes the cvs commands use the main repository.
                   8707:   </p>
1.75      rillig   8708: </div>
1.148     asau     8709: <div class="sect1">
1.75      rillig   8710: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140     wiz      8711: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      8712: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      8713:   access to the pkgsrc repository.</p>
                   8714: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   8715: Start by adding the directory and then files in the directory. Don't
                   8716: forget to add the new package to the category's
                   8717: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   8718: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   8719: <pre class="programlisting">
                   8720: <code class="prompt">$</code> cd .../pkgsrc/category
                   8721: <code class="prompt">$</code> cvs add pkgname
                   8722: <code class="prompt">$</code> cd pkgname
                   8723: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   8724: <code class="prompt">$</code> cvs add patches/p*
                   8725: <code class="prompt">$</code> cvs status | less
1.141     wiz      8726: <code class="prompt">$</code> cvs commit
1.140     wiz      8727: <code class="prompt">$</code> cd ..
                   8728: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      8729: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     8730: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  8731: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      8732: </pre>
1.87      wiz      8733: <p>The commit message of the initial import should include part of the
1.76      rillig   8734:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      8735:   what the package is/does.</p>
1.140     wiz      8736: <p>Also mention the new package in
                   8737: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   8738: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   8739: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   8740: </div>
1.148     asau     8741: <div class="sect1">
1.75      rillig   8742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8743: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      8744: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   8745:   changes between old and new versions into the commit log when updating
1.87      wiz      8746:   a package. There are various reasons for this:</p>
1.148     asau     8747: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8748: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      8749:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      8750: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      8751:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      8752: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   8753:   repository is very useful for people who read the pkgsrc-changes mailing
                   8754:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      8755:   the package.</p></li>
1.75      rillig   8756: </ul></div>
1.87      wiz      8757: <p>Please also recognize that, just because a new version of a package
1.75      rillig   8758:   has been released, it should not automatically be upgraded in the CVS
                   8759:   repository.  We prefer to be conservative in the packages that are
                   8760:   included in pkgsrc - development or beta packages are not really the
                   8761:   best thing for most places in which pkgsrc is used. Please use your
                   8762:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      8763:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   8764: </div>
1.148     asau     8765: <div class="sect1">
1.75      rillig   8766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122     reed     8767: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
                   8768: <p>Renaming packages is not recommended.</p>
                   8769: <p>When renaming packages, be sure to fix any references to old name
                   8770:   in other Makefiles, options, buildlink files, etc.</p>
                   8771: <p>Also When renaming a package, please define
                   8772:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   8773:   pattern(s) of the previous package name.
                   8774:   This may be repeated for multiple renames.
                   8775:   The new package would be an exact replacement.
                   8776: </p>
1.128     wiz      8777: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     8778:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   8779:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   8780:   not be an exact replacement but is a suggestion for the replaced
                   8781:   functionality.</p>
                   8782: </div>
1.148     asau     8783: <div class="sect1">
1.122     reed     8784: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   8785: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
                   8786: <p>It is preferred that packages are not renamed or moved, but if needed
                   8787:   please follow these steps.
                   8788: </p>
1.128     wiz      8789: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8790: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   8791: <li class="listitem">
1.75      rillig   8792: <p>Remove all CVS dirs.</p>
1.87      wiz      8793: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   8794: <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      8795: <p>and use that for further work.</p>
1.75      rillig   8796: </li>
1.128     wiz      8797: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   8798: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   8799: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   8800: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     8801: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   8802: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   8803: for doing an update using pkgsrc building; for example, it can
1.232     sevan    8804: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     8805: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   8806: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   8807: it may have multiple matches, so the tool should also check on the
                   8808: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   8809: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   8810: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      8811: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   8812: place.</p></li>
1.128     wiz      8813: <li class="listitem">
1.75      rillig   8814: <p>Check if any package depends on it:
                   8815: </p>
                   8816: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   8817: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   8818: </li>
1.128     wiz      8819: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   8820: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   8821: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   8822: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   8823: <li class="listitem">
1.75      rillig   8824: <p>Commit the changed and removed files:</p>
                   8825: <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      8826: <p>(and any packages from step 5, of course).</p>
1.75      rillig   8827: </li>
                   8828: </ol></div>
                   8829: </div>
                   8830: </div>
1.148     asau     8831: <div class="chapter">
1.75      rillig   8832: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   8833: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   8834: <p>This section contains the answers to questions that may
                   8835:        arise when you are writing a package. If you don't find your
                   8836:        question answered here, first have a look in the other chapters,
                   8837:        and if you still don't have the answer, ask on the
                   8838:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     8839: <div class="qandaset">
1.236   ! wiz      8840: <a name="idm86457232"></a><dl>
1.106     rillig   8841: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   8842:        MAKEFLAGS, .MAKEFLAGS and
                   8843:        MAKE_FLAGS?</a>
                   8844: </dt>
1.106     rillig   8845: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   8846:        MAKE, GMAKE and
                   8847:        MAKE_PROGRAM?</a>
                   8848: </dt>
1.106     rillig   8849: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   8850:        CC, PKG_CC and
                   8851:        PKGSRC_COMPILER?</a>
                   8852: </dt>
1.106     rillig   8853: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   8854:        BUILDLINK_LDFLAGS,
                   8855:        BUILDLINK_LDADD and
                   8856:        BUILDLINK_LIBS?</a>
                   8857: </dt>
1.106     rillig   8858: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   8859:        VARNAME=BUILDLINK_PREFIX.foo
                   8860:        say it's empty?</a>
                   8861: </dt>
1.106     rillig   8862: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   8863:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   8864:        don't understand the := inside
                   8865:        it.</a>
                   8866: </dt>
1.106     rillig   8867: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   8868:        developers?</a>
                   8869: </dt>
1.106     rillig   8870: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   8871:        documentation?</a>
                   8872: </dt>
1.106     rillig   8873: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   8874: do?</a>
                   8875: </dt>
1.75      rillig   8876: </dl>
1.148     asau     8877: <table border="0" style="width: 100%;">
                   8878: <colgroup>
1.75      rillig   8879: <col align="left" width="1%">
1.128     wiz      8880: <col>
1.148     asau     8881: </colgroup>
1.75      rillig   8882: <tbody>
1.148     asau     8883: <tr class="question">
1.75      rillig   8884: <td align="left" valign="top">
1.236   ! wiz      8885: <a name="devfaq.makeflags"></a><a name="idm86456848"></a><p><b>22.1.</b></p>
1.75      rillig   8886: </td>
                   8887: <td align="left" valign="top"><p>What is the difference between
                   8888:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   8889:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   8890: </tr>
                   8891: <tr class="answer">
1.91      rillig   8892: <td align="left" valign="top"></td>
1.75      rillig   8893: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.232     sevan    8894:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   8895:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   8896:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   8897:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   8898: </tr>
1.148     asau     8899: <tr class="question">
1.75      rillig   8900: <td align="left" valign="top">
1.236   ! wiz      8901: <a name="devfaq.make"></a><a name="idm86452880"></a><p><b>22.2.</b></p>
1.75      rillig   8902: </td>
                   8903: <td align="left" valign="top"><p>What is the difference between
                   8904:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   8905:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   8906: </tr>
                   8907: <tr class="answer">
1.91      rillig   8908: <td align="left" valign="top"></td>
1.75      rillig   8909: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.232     sevan    8910:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   8911:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   8912:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   8913:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   8914:        Make program that is used for building the
                   8915:        package.</p></td>
                   8916: </tr>
1.148     asau     8917: <tr class="question">
1.75      rillig   8918: <td align="left" valign="top">
1.236   ! wiz      8919: <a name="devfaq.cc"></a><a name="idm86448400"></a><p><b>22.3.</b></p>
1.75      rillig   8920: </td>
                   8921: <td align="left" valign="top"><p>What is the difference between
                   8922:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   8923:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   8924: </tr>
                   8925: <tr class="answer">
1.91      rillig   8926: <td align="left" valign="top"></td>
1.75      rillig   8927: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   8928:        compiler, which can be configured by the pkgsrc user.
                   8929:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   8930:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   8931:        path to a compiler, but the type of compiler that should be
1.76      rillig   8932:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   8933:        information about the latter variable.</p></td>
                   8934: </tr>
1.148     asau     8935: <tr class="question">
1.75      rillig   8936: <td align="left" valign="top">
1.236   ! wiz      8937: <a name="devfaq.bl3flags"></a><a name="idm86444304"></a><p><b>22.4.</b></p>
1.75      rillig   8938: </td>
                   8939: <td align="left" valign="top"><p>What is the difference between
                   8940:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   8941:        <code class="varname">BUILDLINK_LDADD</code> and
                   8942:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   8943: </tr>
                   8944: <tr class="answer">
1.91      rillig   8945: <td align="left" valign="top"></td>
1.75      rillig   8946: <td align="left" valign="top"><p>[FIXME]</p></td>
                   8947: </tr>
1.148     asau     8948: <tr class="question">
1.75      rillig   8949: <td align="left" valign="top">
1.236   ! wiz      8950: <a name="devfaq.bl3prefix"></a><a name="idm86425616"></a><p><b>22.5.</b></p>
1.75      rillig   8951: </td>
1.110     hubertf  8952: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   8953:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   8954:        say it's empty?</p></td>
                   8955: </tr>
                   8956: <tr class="answer">
1.91      rillig   8957: <td align="left" valign="top"></td>
1.75      rillig   8958: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      8959:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   8960:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  8961:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   8962:        command.</p></td>
                   8963: </tr>
1.148     asau     8964: <tr class="question">
1.78      rillig   8965: <td align="left" valign="top">
1.236   ! wiz      8966: <a name="devfaq.master_sites"></a><a name="idm86422544"></a><p><b>22.6.</b></p>
1.78      rillig   8967: </td>
                   8968: <td align="left" valign="top"><p>What does
1.220     wiz      8969:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   8970:        don't understand the <code class="code">:=</code> inside
1.78      rillig   8971:        it.</p></td>
                   8972: </tr>
                   8973: <tr class="answer">
1.91      rillig   8974: <td align="left" valign="top"></td>
1.220     wiz      8975: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   8976:        assignment operator, although it looks like it.
1.78      rillig   8977:        Instead, it is a degenerate form of
1.220     wiz      8978:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.232     sevan    8979:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      8980:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   8981:        case of <code class="varname">MASTER_SITE_*</code>,
                   8982:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   8983:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      8984:        <code class="code">package/</code>. That's where the
                   8985:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   8986:        together.</p></td>
                   8987: </tr>
1.148     asau     8988: <tr class="question">
1.78      rillig   8989: <td align="left" valign="top">
1.236   ! wiz      8990: <a name="devfaq.mailinglists"></a><a name="idm86415632"></a><p><b>22.7.</b></p>
1.78      rillig   8991: </td>
                   8992: <td align="left" valign="top"><p>Which mailing lists are there for package
                   8993:        developers?</p></td>
                   8994: </tr>
                   8995: <tr class="answer">
1.91      rillig   8996: <td align="left" valign="top"></td>
1.148     asau     8997: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110     hubertf  8998: <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   8999: <dd><p>This is a list for technical discussions related
                   9000:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9001:        pkgsrc infrastructure, proposed new features, questions related
                   9002:        to porting pkgsrc to a new platform, advice for maintaining a
                   9003:        package, patches that affect many packages, help requests moved
                   9004:        from pkgsrc-users when an infrastructure bug is found,
                   9005:        etc.</p></dd>
1.110     hubertf  9006: <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   9007: <dd><p>All bug reports in category "pkg" sent with
1.232     sevan    9008:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   9009:        directly; use one of the other mailing
                   9010:        lists.</p></dd>
                   9011: </dl></div></td>
                   9012: </tr>
1.148     asau     9013: <tr class="question">
1.80      rillig   9014: <td align="left" valign="top">
1.236   ! wiz      9015: <a name="devfaq.documentation"></a><a name="idm86411920"></a><p><b>22.8.</b></p>
1.80      rillig   9016: </td>
                   9017: <td align="left" valign="top"><p>Where is the pkgsrc
                   9018:        documentation?</p></td>
                   9019: </tr>
                   9020: <tr class="answer">
1.91      rillig   9021: <td align="left" valign="top"></td>
1.80      rillig   9022: <td align="left" valign="top">
                   9023: <p>There are many places where you can find
                   9024:        documentation about pkgsrc:</p>
1.148     asau     9025: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9026: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   9027:        of chapters that explain large parts of pkgsrc, but some
                   9028:        chapters tend to be outdated. Which ones they are is hard to
                   9029:        say.</p></li>
1.128     wiz      9030: <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   9031:        about certain features, announcements of new parts of the pkgsrc
                   9032:        infrastructure and sometimes even announcements that a certain
                   9033:        feature has been marked as obsolete. The benefit here is that
                   9034:        each message has a date appended to it.</p></li>
1.128     wiz      9035: <li class="listitem"><p>Many of the files in the
1.80      rillig   9036:        <code class="filename">mk/</code> directory start with a comment that
                   9037:        describes the purpose of the file and how it can be used by the
1.92      rillig   9038:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9039:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9040:        help</strong></span>.</p></li>
1.128     wiz      9041: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   9042:        information, but they tend to be highly abbreviated, especially
                   9043:        for actions that occur often. Some contain a detailed
                   9044:        description of what has changed, but they are geared towards the
                   9045:        other pkgsrc developers, not towards an average pkgsrc user.
                   9046:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9047:        don't know what has been before, these messages may not be worth
                   9048:        too much to you.</p></li>
1.128     wiz      9049: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9050:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   9051:        mind of the developer who wrote the code. To get this
1.110     hubertf  9052:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9053:        to see who has written it and ask on the
                   9054:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9055:        find your questions later (see above). To be sure that the
                   9056:        developer in charge reads the mail, you may CC him or
                   9057:        her.</p></li>
                   9058: </ul></div>
                   9059: </td>
                   9060: </tr>
1.148     asau     9061: <tr class="question">
1.92      rillig   9062: <td align="left" valign="top">
1.236   ! wiz      9063: <a name="devfaq.too-much-time"></a><a name="idm86397200"></a><p><b>22.9.</b></p>
1.92      rillig   9064: </td>
                   9065: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9066: do?</p></td>
                   9067: </tr>
                   9068: <tr class="answer">
                   9069: <td align="left" valign="top"></td>
                   9070: <td align="left" valign="top">
1.93      rillig   9071: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9072: anyway.</p>
1.148     asau     9073: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9074: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.232     sevan    9075:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package).  It
1.92      rillig   9076:     will tell you about newer versions of installed packages that are
                   9077:     available, but not yet updated in pkgsrc.</p></li>
1.128     wiz      9078: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126     jakllsch 9079:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   9080:     cleanups and enhancements for pkgsrc that would be nice to
                   9081:     have.</p></li>
1.128     wiz      9082: <li class="listitem"><p>Review packages for which review was requested on
1.180     wiz      9083:     the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92      rillig   9084:     mailing list.</p></li>
                   9085: </ul></div>
                   9086: </td>
                   9087: </tr>
1.75      rillig   9088: </tbody>
                   9089: </table>
                   9090: </div>
                   9091: </div>
1.148     asau     9092: <div class="chapter">
1.85      jmmv     9093: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9094: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9095: <div class="toc">
                   9096: <p><b>Table of Contents</b></p>
1.210     leot     9097: <dl class="toc">
1.106     rillig   9098: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9099: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9100: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9101: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     9102: </dl>
                   9103: </div>
1.110     hubertf  9104: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9105: site</a>:</p>
                   9106: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9107:   environment, an intuitive and attractive desktop for users, and the
                   9108:   GNOME development platform, an extensive framework for building
                   9109:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9110: <p>pkgsrc provides a seamless way to automatically build and install
                   9111: a complete GNOME environment <span class="emphasis"><em>under many different
                   9112: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9113: the most advanced build and packaging systems for GNOME due to its
                   9114: included technologies buildlink3, the wrappers and tools framework and
                   9115: automatic configuration file management.  Lots of efforts are put into
                   9116: achieving a completely clean deinstallation of installed software
                   9117: components.</p>
1.110     hubertf  9118: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9119: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9120: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9121: pkgsrc as its preferred packaging system, contributing lots of
                   9122: portability fixes to make GNOME build and install under it.</p>
                   9123: <p>This chapter is aimed at pkgsrc developers and other people
                   9124: interested in helping our GNOME porting and packaging efforts.  It
                   9125: provides instructions on how to manage the existing packages and some
                   9126: important information regarding their internals.</p>
1.148     asau     9127: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85      jmmv     9128: <h3 class="title">We need your help!</h3>
                   9129: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9130:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9131:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9132:   work</a> list!  There is still a long way to go to get a
                   9133:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9134:   achieve it!</p>
                   9135: </div>
1.148     asau     9136: <div class="sect1">
1.85      jmmv     9137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9138: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     9139: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148     asau     9140: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.232     sevan    9141: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.85      jmmv     9142:     the core GNOME desktop environment.  It only includes the necessary
                   9143:     bits to get it to boot correctly, although it may lack important
                   9144:     functionality for daily operation.  The idea behind this package is
                   9145:     to let end users build their own configurations on top of this one,
                   9146:     first installing this meta package to achieve a functional setup and
                   9147:     then adding individual applications.</p></li>
1.232     sevan    9148: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.85      jmmv     9149:     complete installation of the GNOME platform and desktop as defined
                   9150:     by the GNOME project; this is based on the components distributed in
                   9151:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9152:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9153:     official FTP server.  Developer-only tools found in those
                   9154:     directories are not installed unless required by some other
                   9155:     component to work properly.  Similarly, packages from the bindings
                   9156:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9157:     in unless required as a dependency for an end-user component.  This
1.232     sevan    9158:     package "extends" <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
                   9159: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.85      jmmv     9160:     Installs all the tools required to build a GNOME component when
                   9161:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9162:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9163: </ul></div>
                   9164: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9165: sorted in a way that eases updates: a package may depend on other
                   9166: packages listed before it but not on any listed after it.  It is very
                   9167: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9168: change it to alphabetical sorting!</em></span></p>
                   9169: </div>
1.148     asau     9170: <div class="sect1">
1.85      jmmv     9171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9172: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9173: <p>Almost all GNOME applications are written in C and use a common
                   9174: set of tools as their build system.  Things get different with the new
                   9175: bindings to other languages (such as Python), but the following will
                   9176: give you a general idea on the minimum required tools:</p>
1.148     asau     9177: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9178: <li class="listitem">
1.85      jmmv     9179: <p>Almost all GNOME applications use the GNU Autotools as their
                   9180:     build system.  As a general rule you will need to tell this to your
                   9181:     package:</p>
1.100     rillig   9182: <pre class="programlisting">
                   9183: GNU_CONFIGURE=yes
1.85      jmmv     9184: USE_LIBTOOL=yes
1.100     rillig   9185: USE_TOOLS+=gmake
                   9186: </pre>
1.85      jmmv     9187: </li>
1.128     wiz      9188: <li class="listitem">
1.85      jmmv     9189: <p>If the package uses pkg-config to detect dependencies, add this
                   9190:     tool to the list of required utilities:</p>
1.222     sevan    9191: <pre class="programlisting">
                   9192: USE_TOOLS+=pkg-config
                   9193: </pre>
1.232     sevan    9194: <p>Also use <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85      jmmv     9195:     the end of the build process to ensure that you did not miss to
                   9196:     specify any dependency in your package and that the version
                   9197:     requirements are all correct.</p>
                   9198: </li>
1.128     wiz      9199: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93      rillig   9200:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9201:     to handle dependencies and to force the package to use the latest
                   9202:     available version.</p></li>
1.128     wiz      9203: <li class="listitem">
1.85      jmmv     9204: <p>If the package uses gtk-doc (a documentation generation
                   9205:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9206:     tool is rather big and the distfile should come with pregenerated
                   9207:     documentation anyway; if it does not, it is a bug that you ought to
                   9208:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9209:     the default):</p>
1.222     sevan    9210: <pre class="programlisting">
                   9211: CONFIGURE_ARGS+=--disable-gtk-doc
                   9212: </pre>
1.89      rillig   9213: <p>The default location of installed HTML files
                   9214:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9215:     and should not be changed unless the package insists on installing
                   9216:     them somewhere else.  Otherwise programs as
1.110     hubertf  9217:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   9218:     do that with an entry similar to:</p>
1.222     sevan    9219: <pre class="programlisting">
                   9220: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9221: </pre>
1.85      jmmv     9222: </li>
                   9223: </ul></div>
                   9224: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9225: files under the installation prefix to maintain databases.  In this
                   9226: context, shared means that those exact same directories and files are
                   9227: used among several different packages, leading to conflicts in the
                   9228: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9229: handle the most common cases, so you have to forget about using
                   9230: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9231: omitting shared files from them.  If you find yourself doing those,
                   9232: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9233: <p>The following table lists the common situations that result in
                   9234: using shared directories or files.  For each of them, the appropriate
                   9235: solution is given.  After applying the solution be sure to
                   9236: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  9237: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     9238: <div class="table">
1.106     rillig   9239: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.216     tnn      9240: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9241: <colgroup>
                   9242: <col>
                   9243: <col>
                   9244: </colgroup>
                   9245: <thead><tr>
                   9246: <th>If the package...</th>
                   9247: <th>Then...</th>
                   9248: </tr></thead>
                   9249: <tbody>
                   9250: <tr>
                   9251: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119     mishka   9252: <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     9253: </tr>
                   9254: <tr>
                   9255: <td>Installs icons under the
                   9256:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9257:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  9258: <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     9259: </tr>
                   9260: <tr>
                   9261: <td>Installs files under
                   9262:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  9263: <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     9264: </tr>
                   9265: <tr>
                   9266: <td>Installs <code class="filename">.desktop</code> files under
                   9267:         <code class="filename">share/applications</code> and these include MIME
                   9268:         information.</td>
1.110     hubertf  9269: <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     9270: </tr>
                   9271: </tbody>
1.91      rillig   9272: </table></div>
1.85      jmmv     9273: </div>
1.91      rillig   9274: <br class="table-break">
1.85      jmmv     9275: </div>
1.148     asau     9276: <div class="sect1">
1.85      jmmv     9277: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9278: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9279: <p>When seeing GNOME as a whole, there are two kinds of
                   9280: updates:</p>
1.148     asau     9281: <div class="variablelist"><dl class="variablelist">
1.85      jmmv     9282: <dt><span class="term">Major update</span></dt>
                   9283: <dd>
                   9284: <p>Given that there is still a very long way for GNOME 3 (if it
                   9285:       ever appears), we consider a major update one that goes from a
                   9286:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9287:       where <code class="literal">Y</code> is even and greater than
                   9288:       <code class="literal">X</code>.  These are hard to achieve because they
                   9289:       introduce lots of changes in the components' code and almost all
                   9290:       GNOME distfiles are updated to newer versions.  Some of them can
                   9291:       even break API and ABI compatibility with the previous major
                   9292:       version series.  As a result, the update needs to be done all at
                   9293:       once to minimize breakage.</p>
                   9294: <p>A major update typically consists of around 80 package
                   9295:       updates and the addition of some new ones.</p>
                   9296: </dd>
                   9297: <dt><span class="term">Minor update</span></dt>
                   9298: <dd>
                   9299: <p>We consider a minor update one that goes from a
                   9300:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9301:       one where <code class="literal">Y</code> is greater than
                   9302:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9303:       not update all GNOME components, can be done in an incremental way
                   9304:       and do not break API nor ABI compatibility.</p>
                   9305: <p>A minor update typically consists of around 50 package
                   9306:       updates, although the numbers here may vary a lot.</p>
                   9307: </dd>
                   9308: </dl></div>
                   9309: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9310: release (either major or minor), the following steps should be
                   9311: followed:</p>
1.128     wiz      9312: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9313: <li class="listitem">
1.85      jmmv     9314: <p>Get a list of all the tarballs that form the new release by
                   9315:     using the following commands.  These will leave the full list of the
1.120     snj      9316:     components' distfiles into the <code class="filename">list.txt</code>
1.85      jmmv     9317:     file:</p>
1.88      wiz      9318: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9319:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9320:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9321: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9322:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9323:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9324: </li>
1.128     wiz      9325: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85      jmmv     9326:     bump their version to the release you are updating them to.  The
                   9327:     three meta packages should be always consistent with versioning.
                   9328:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9329:     in them.</p></li>
1.128     wiz      9330: <li class="listitem">
1.85      jmmv     9331: <p>For each meta package, update all its
                   9332:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9333:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9334:     newer version (even if found in the FTP) because the meta packages
                   9335:     are supposed to list the exact versions that form a specific GNOME
                   9336:     release.  Exceptions are permitted here if a newer version solves a
                   9337:     serious issue in the overall desktop experience; these typically
                   9338:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9339:     from the developers.</p>
                   9340: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9341:     should be updated to the latest version available (if found in
                   9342:     pkgsrc).  This is the case, for example, of the dependencies on the
1.232     sevan    9343:     GNU Autotools in the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.85      jmmv     9344: </li>
1.128     wiz      9345: <li class="listitem">
1.85      jmmv     9346: <p>Generate a patch from the modified meta packages and extract the
                   9347:     list of "new" lines.  This will provide you an outline on what
                   9348:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   9349: <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     9350: </li>
1.128     wiz      9351: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85      jmmv     9352:     installed packages and start over from scratch at this point.</p></li>
1.128     wiz      9353: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85      jmmv     9354:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9355:     it in order.  For major desktop updates none of these should be
1.93      rillig   9356:     committed until the entire set is completed because there are chances
1.85      jmmv     9357:     of breaking not-yet-updated packages.</p></li>
1.128     wiz      9358: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85      jmmv     9359:     the tree one by one with appropriate log messages.  At the end,
                   9360:     commit the three meta package updates and all the corresponding
                   9361:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9362:     <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>
                   9363: </ol></div>
                   9364: </div>
1.148     asau     9365: <div class="sect1">
1.85      jmmv     9366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9367: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     9368: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9369: packages.  Please, it is very important that you always, always,
                   9370: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  9371: 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     9372: their attention on portability issues and to ensure that future versions
                   9373: can be built out-of-the box on NetBSD.  The less custom patches in
                   9374: pkgsrc, the easier further updates are.  Those developers in charge of
                   9375: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  9376: <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     9377: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9378: of them do.  Do not be short on your reports: always provide detailed
                   9379: explanations of the current failure, how it can be improved to achieve
                   9380: maximum portability and, if at all possible, provide a patch against CVS
                   9381: head.  The more verbose you are, the higher chances of your patch being
                   9382: accepted.</p>
                   9383: <p>Also, please avoid using preprocessor magic to fix portability
                   9384: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9385: GNOME to their operating system, the official GNOME sources are now
                   9386: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9387: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  9388: 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     9389: details.</p>
                   9390: </div>
                   9391: </div>
1.75      rillig   9392: </div>
1.148     asau     9393: <div class="part">
1.75      rillig   9394: <div class="titlepage"><div><div><h1 class="title">
                   9395: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     9396: <div class="partintro">
1.75      rillig   9397: <div></div>
                   9398: <p>This part of the guide deals with everything
                   9399:        from the infrastructure that is behind the interfaces described
                   9400:        in the developer's guide. A casual package maintainer should not
                   9401:        need anything from this part.</p>
                   9402: <div class="toc">
                   9403: <p><b>Table of Contents</b></p>
1.210     leot     9404: <dl class="toc">
1.106     rillig   9405: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   9406: <dd><dl>
1.106     rillig   9407: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   9408: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   9409: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   9410: <dd><dl>
1.106     rillig   9411: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   9412: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   9413: </dl></dd>
1.106     rillig   9414: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   9415: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9416: <dd><dl>
1.106     rillig   9417: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   9418: <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   9419: </dl></dd>
1.106     rillig   9420: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   9421: <dd><dl>
1.128     wiz      9422: <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>
                   9423: <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   9424: </dl></dd>
                   9425: </dl></dd>
1.106     rillig   9426: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   9427: <dd><dl>
1.219     rillig   9428: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
                   9429: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75      rillig   9430: <dd><dl>
1.219     rillig   9431: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
                   9432: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75      rillig   9433: </dl></dd>
                   9434: </dl></dd>
1.106     rillig   9435: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.219     rillig   9436: <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   9437: </dl>
                   9438: </div>
                   9439: </div>
1.148     asau     9440: <div class="chapter">
1.75      rillig   9441: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9442: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   9443: <div class="toc">
                   9444: <p><b>Table of Contents</b></p>
1.210     leot     9445: <dl class="toc">
1.106     rillig   9446: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   9447: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   9448: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   9449: <dd><dl>
1.106     rillig   9450: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   9451: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   9452: </dl></dd>
1.106     rillig   9453: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   9454: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9455: <dd><dl>
1.106     rillig   9456: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   9457: <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   9458: </dl></dd>
1.106     rillig   9459: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   9460: <dd><dl>
1.128     wiz      9461: <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>
                   9462: <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   9463: </dl></dd>
                   9464: </dl>
                   9465: </div>
                   9466: <p>The pkgsrc infrastructure consists of many small Makefile
                   9467:        fragments. Each such fragment needs a properly specified
                   9468:        interface. This chapter explains how such an interface looks
                   9469:        like.</p>
1.148     asau     9470: <div class="sect1">
1.75      rillig   9471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9472: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   9473: <p>Whenever a variable is defined in the pkgsrc
                   9474:        infrastructure, the location and the way of definition provide
                   9475:        much information about the intended use of that variable.
                   9476:        Additionally, more documentation may be found in a header
                   9477:        comment or in this pkgsrc guide.</p>
                   9478: <p>A special file is
                   9479:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   9480:        variables that are intended to be user-defined. They are either
                   9481:        defined using the <code class="literal">?=</code> operator or they are
                   9482:        left undefined because defining them to anything would
1.128     wiz      9483:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   9484:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   9485:        file.</p>
                   9486: <p>Outside this file, the following conventions apply:
                   9487:        Variables that are defined using the <code class="literal">?=</code>
                   9488:        operator may be overridden by a package.</p>
                   9489: <p>Variables that are defined using the <code class="literal">=</code>
                   9490:        operator may be used read-only at run-time.</p>
                   9491: <p>Variables whose name starts with an underscore must not be
                   9492:        accessed outside the pkgsrc infrastructure at all. They may
                   9493:        change without further notice.</p>
1.148     asau     9494: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   9495: <h3 class="title">Note</h3>
                   9496: <p>These conventions are currently not applied
                   9497:        consistently to the complete pkgsrc
                   9498:        infrastructure.</p>
                   9499: </div>
                   9500: </div>
1.148     asau     9501: <div class="sect1">
1.81      rillig   9502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9503: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   9504: <p>All variables that contain lists of things should default
                   9505:        to being empty. Two examples that do not follow this rule are
                   9506:        <code class="varname">USE_LANGUAGES</code> and
                   9507:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   9508:        modified using the <code class="literal">+=</code> operator in package
                   9509:        <code class="filename">Makefile</code>s (or other files included by
                   9510:        them), since there is no guarantee whether the variable is
                   9511:        already set or not, and what its value is. In the case of
1.128     wiz      9512:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   9513:        the default value and just define it as in the following
                   9514:        example.</p>
                   9515: <pre class="programlisting">
1.100     rillig   9516: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   9517: </pre>
                   9518: <p>Because of the selection of this default value, the same
                   9519:        value appears in many package Makefiles. Similarly for
                   9520:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      9521:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   9522:        doesn't stand out. Nevertheless it is mentioned in many
                   9523:        files.</p>
                   9524: </div>
1.148     asau     9525: <div class="sect1">
1.81      rillig   9526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9527: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148     asau     9528: <div class="sect2">
1.75      rillig   9529: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9530: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   9531: <p>Variable evaluation takes place either at load time or at
                   9532:        runtime, depending on the context in which they occur. The
                   9533:        contexts where variables are evaluated at load time are:</p>
1.148     asau     9534: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9535: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   9536:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      9537: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   9538:        <code class="literal">.for</code>,</p></li>
1.128     wiz      9539: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   9540: </ul></div>
                   9541: <p>A special exception are references to the iteration
                   9542:        variables of <code class="literal">.for</code> loops, which are expanded
                   9543:        inline, no matter in which context they appear.</p>
                   9544: <p>As the values of variables may change during load time,
                   9545:        care must be taken not to evaluate them by accident. Typical
                   9546:        examples for variables that should not be evaluated at load time
                   9547:        are <code class="varname">DEPENDS</code> and
                   9548:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   9549:        clear, here is an example:</p>
                   9550: <pre class="programlisting">
1.100     rillig   9551: CONFIGURE_ARGS=         # none
                   9552: CFLAGS=                 -O
                   9553: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    9554: 
1.100     rillig   9555: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    9556: 
1.100     rillig   9557: CFLAGS+=                -Wall
1.222     sevan    9558: </pre>
1.75      rillig   9559: <p>This code shows how the use of the <code class="literal">:=</code>
                   9560:        operator can quickly lead to unexpected results. The first
                   9561:        paragraph is fairly common code. The second paragraph evaluates
                   9562:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   9563:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   9564:        <code class="literal">-Wall</code> is appended to the
                   9565:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   9566:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   9567:        paragraphs from above typically occur in completely unrelated
                   9568:        files.</p>
                   9569: </div>
1.148     asau     9570: <div class="sect2">
1.75      rillig   9571: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9572: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   9573: <p>After all the files have been loaded, the values of the
                   9574:        variables cannot be changed anymore. Variables that are used in
                   9575:        the shell commands are expanded at this point.</p>
                   9576: </div>
                   9577: </div>
1.148     asau     9578: <div class="sect1">
1.75      rillig   9579: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9580: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   9581: <p>There are many ways in which the definition and use of a
1.218     rillig   9582:        variable can be restricted in order to detect bugs and violations
                   9583:        of the (mostly unwritten) policies. A package can be checked with
                   9584:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   9585:        rules.</p>
1.78      rillig   9586: </div>
1.148     asau     9587: <div class="sect1">
1.78      rillig   9588: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9589: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   9590: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   9591:        of the following classes. Cases where a file falls into more
                   9592:        than one class should be avoided as it often leads to subtle
                   9593:        bugs.</p>
1.148     asau     9594: <div class="sect2">
1.75      rillig   9595: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9596: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   9597: <p>In a traditional imperative programming language some of
1.76      rillig   9598:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 9599:        procedures. They take some input parameters and&mdash;after
                   9600:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   9601:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   9602:        care must be taken not to use parameter names that have already
                   9603:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   9604:        bad choice for a parameter name.</p>
                   9605: <p>Procedures are completely evaluated at preprocessing time.
                   9606:        That is, when calling a procedure all input parameters must be
                   9607:        completely resolvable. For example,
                   9608:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   9609:        parameter since it is very likely that further text will be
                   9610:        added after calling the procedure, which would effectively apply
                   9611:        the procedure to only a part of the variable. Also, references
1.218     rillig   9612:        to other variables will be modified after calling the
1.75      rillig   9613:        procedure.</p>
                   9614: <p>A procedure can declare its output parameters either as
                   9615:        suitable for use in preprocessing directives or as only
                   9616:        available at runtime. The latter alternative is for variables
                   9617:        that contain references to other runtime variables.</p>
                   9618: <p>Procedures shall be written such that it is possible to
                   9619:        call the procedure more than once. That is, the file must not
                   9620:        contain multiple-inclusion guards.</p>
                   9621: <p>Examples for procedures are
1.76      rillig   9622:        <code class="filename">mk/bsd.options.mk</code> and
                   9623:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   9624:        that the parameters are evaluated at load time, they should be
                   9625:        assigned using the <code class="literal">:=</code> operator, which should
                   9626:        be used only for this purpose.</p>
                   9627: </div>
1.148     asau     9628: <div class="sect2">
1.75      rillig   9629: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9630: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   9631: <p>Action files take some input parameters and may define
                   9632:        runtime variables. They shall not define loadtime variables.
                   9633:        There are action files that are included implicitly by the
                   9634:        pkgsrc infrastructure, while other must be included
                   9635:        explicitly.</p>
                   9636: <p>An example for action files is
1.76      rillig   9637:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   9638: </div>
                   9639: </div>
1.148     asau     9640: <div class="sect1">
1.81      rillig   9641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9642: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   9643: <p>Package <code class="filename">Makefile</code>s usually consist of
                   9644:        a set of variable definitions, and include the file
                   9645:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   9646:        Before that, they may also include various other
                   9647:        <code class="filename">*.mk</code> files if they need to query the
                   9648:        availability of certain features like the type of compiler or
                   9649:        the X11 implementation. Due to the heavy use of preprocessor
                   9650:        directives like <code class="literal">.if</code> and
                   9651:        <code class="literal">.for</code>, the order in which the files are loaded
                   9652:        matters.</p>
                   9653: <p>This section describes at which point the various files
                   9654:        are loaded and gives reasons for that order.</p>
1.148     asau     9655: <div class="sect2">
1.81      rillig   9656: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9657: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   9658: </h3></div></div></div>
                   9659: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   9660:        is to define some essential variables like
                   9661:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   9662:        <code class="varname">MACHINE_ARCH</code>.</p>
                   9663: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  9664:        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   9665:        After that, those variables
1.81      rillig   9666:        that have not been overridden by the user are loaded from
                   9667:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   9668: <p>After the user settings, the system settings and platform
                   9669:        settings are loaded, which may override the user
                   9670:        settings.</p>
                   9671: <p>Then, the tool definitions are loaded. The tool wrappers
                   9672:        are not yet in effect. This only happens when building a
                   9673:        package, so the proper variables must be used instead of the
                   9674:        direct tool names.</p>
                   9675: <p>As the last steps, some essential variables from the
                   9676:        wrapper and the package system flavor are loaded, as well as the
                   9677:        variables that have been cached in earlier phases of a package
                   9678:        build.</p>
                   9679: </div>
1.148     asau     9680: <div class="sect2">
1.81      rillig   9681: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9682: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   9683: </h3></div></div></div>
1.81      rillig   9684: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   9685: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   9686:        loaded, which fill default values for those variables that have
1.93      rillig   9687:        not been defined by the package. These variables may later
1.81      rillig   9688:        be used even in unrelated files.</p>
                   9689: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   9690:        provides the target <code class="literal">error-check</code> that is added
                   9691:        as a special dependency to all other targets that use
                   9692:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   9693:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   9694: <p>Then, the package-specific hacks from
                   9695:        <code class="filename">hacks.mk</code> are included.</p>
                   9696: <p>Then, various other files follow. Most of them don't have
                   9697:        any dependencies on what they need to have included before or
                   9698:        after them, though some do.</p>
                   9699: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   9700:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   9701:        restricts the use of these variables to all the files that have
                   9702:        been included before. Appearances in later files will be
                   9703:        silently ignored.</p>
                   9704: <p>Then, the files for the main targets are included, in the
                   9705:        order of later execution, though the actual order should not
                   9706:        matter.</p>
                   9707: <p>At last, some more files are included that don't set any
                   9708:        interesting variables but rather just define make targets to be
                   9709:        executed.</p>
                   9710: </div>
                   9711: </div>
1.75      rillig   9712: </div>
1.148     asau     9713: <div class="chapter">
1.75      rillig   9714: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9715: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   9716: <div class="toc">
                   9717: <p><b>Table of Contents</b></p>
1.210     leot     9718: <dl class="toc">
1.219     rillig   9719: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
                   9720: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75      rillig   9721: <dd><dl>
1.219     rillig   9722: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
                   9723: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75      rillig   9724: </dl></dd>
                   9725: </dl>
                   9726: </div>
                   9727: <p>The pkgsrc infrastructure consists of a large codebase,
                   9728:        and there are many corners where every little bit of a file is
                   9729:        well thought out, making pkgsrc likely to fail as soon as
                   9730:        anything is changed near those parts. To prevent most changes
                   9731:        from breaking anything, a suite of regression tests should go
                   9732:        along with every important part of the pkgsrc infrastructure.
                   9733:        This chapter describes how regression tests work in pkgsrc and
                   9734:        how you can add new tests.</p>
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.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.232     sevan    9738: <p>You first need to install the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  9739:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   9740:        can simply run that command, which will run all tests in the
1.76      rillig   9741:        <code class="filename">regress</code> category.</p>
1.75      rillig   9742: </div>
1.148     asau     9743: <div class="sect1">
1.75      rillig   9744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219     rillig   9745: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.76      rillig   9746: <p>Every directory in the <code class="filename">regress</code>
                   9747:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   9748:        is considered a regression test. This file is a shell program
1.110     hubertf  9749:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   9750:        The following functions can be overridden to suit your
                   9751:        needs.</p>
1.148     asau     9752: <div class="sect2">
1.75      rillig   9753: <div class="titlepage"><div><div><h3 class="title">
1.219     rillig   9754: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   9755: <p>These functions do not take any parameters. Although they
                   9756:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
                   9757:        first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
                   9758:        question</a> for details.</p>
1.148     asau     9759: <div class="variablelist"><dl class="variablelist">
1.218     rillig   9760: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   9761: <dd><p>This function prepares the environment for the
                   9762:        test. By default it does nothing.</p></dd>
1.218     rillig   9763: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   9764: <dd>
                   9765: <p>This function runs the actual test. By default,
1.75      rillig   9766:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   9767:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   9768:        error messages into the file
1.218     rillig   9769:        <code class="varname">TEST_OUTFILE</code>.</p>
                   9770: <p>When defining this function, make sure that all output that
                   9771:        needs to be checked is written to the correct output file.
                   9772:        Example:</p>
                   9773: <pre class="programlisting">
                   9774: do_test() {
1.223     rillig   9775:         echo "Example output"
1.218     rillig   9776: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   9777: </pre>
                   9778: </dd>
                   9779: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   9780: <dd>
                   9781: <p>This function is run after the test and is
1.75      rillig   9782:        typically used to compare the actual output from the one that is
                   9783:        expected. It can make use of the various helper functions from
1.218     rillig   9784:        the next section. Example:</p>
                   9785: <pre class="programlisting">
                   9786: check_result() {
1.223     rillig   9787:         exit_status 0
                   9788:         output_require "Example"
                   9789:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   9790:         output_prohibit "no such file or directory"
1.218     rillig   9791: }
                   9792: </pre>
                   9793: </dd>
                   9794: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   9795: <dd><p>This function cleans everything up after the
                   9796:        test has been run. By default it does nothing.</p></dd>
                   9797: </dl></div>
                   9798: </div>
1.148     asau     9799: <div class="sect2">
1.75      rillig   9800: <div class="titlepage"><div><div><h3 class="title">
1.219     rillig   9801: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.148     asau     9802: <div class="variablelist"><dl class="variablelist">
1.218     rillig   9803: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   9804: <dd><p>This function compares the exitcode of the
1.218     rillig   9805:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   9806:        If they differ, the test will fail.</p></dd>
1.218     rillig   9807: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   9808: <dd>
                   9809: <p>This function checks for each of its parameters
                   9810:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   9811:        extended regular expression. If it does not, the test will
1.218     rillig   9812:        fail. Example:</p>
                   9813: <pre class="programlisting">
1.219     rillig   9814: output_require "looks fine"
                   9815: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   9816: </pre>
                   9817: </dd>
1.75      rillig   9818: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   9819: <dd><p>This function checks for each of its parameters
1.110     hubertf  9820:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   9821:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   9822:        If any of the regular expressions matches, the test will
                   9823:        fail.</p></dd>
                   9824: </dl></div>
                   9825: </div>
                   9826: </div>
                   9827: </div>
1.148     asau     9828: <div class="chapter">
1.75      rillig   9829: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9830: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   9831: <div class="toc">
                   9832: <p><b>Table of Contents</b></p>
1.219     rillig   9833: <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   9834: </div>
                   9835: <p>The pkgsrc system has already been ported to many
                   9836:        operating systems, hardware architectures and compilers. This
                   9837:        chapter explains the necessary steps to make pkgsrc even more
                   9838:        portable.</p>
1.148     asau     9839: <div class="sect1">
1.75      rillig   9840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9841: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   9842: <p>To port pkgsrc to a new operating system (called
                   9843:        <code class="literal">MyOS</code> in this example), you need to touch the
                   9844:        following files:</p>
1.148     asau     9845: <div class="variablelist"><dl class="variablelist">
1.93      rillig   9846: <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   9847: <dd><p>This file contains some basic definitions, for
                   9848:        example the name of the C
                   9849:        compiler.</p></dd>
1.76      rillig   9850: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   9851: <dd><p>Insert code that defines the variables
                   9852:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   9853:        <code class="varname">LOWER_OS_VERSION</code>,
                   9854:        <code class="varname">LOWER_VENDOR</code>,
                   9855:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   9856:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   9857:        appear in this file.</p></dd>
1.93      rillig   9858: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   9859: <dd><p>This file contains the platform-specific
                   9860:        definitions that are used by pkgsrc. Start by copying one of the
                   9861:        other files and edit it to your
                   9862:        needs.</p></dd>
1.93      rillig   9863: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   9864: <dd><p>This file defines the paths to all the tools
                   9865:        that are needed by one or the other package in pkgsrc, as well
                   9866:        as by pkgsrc itself. Find out where these tools are on your
                   9867:        platform and add them.</p></dd>
                   9868: </dl></div>
                   9869: <p>Now, you should be able to build some basic packages, like
1.232     sevan    9870:        <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   9871: </div>
                   9872: </div>
                   9873: </div>
1.148     asau     9874: <div class="appendix">
                   9875: <div class="titlepage"><div><div><h1 class="title">
                   9876: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   9877: <div class="toc">
                   9878: <p><b>Table of Contents</b></p>
1.210     leot     9879: <dl class="toc">
1.75      rillig   9880: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   9881: <dd><dl>
                   9882: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   9883: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   9884: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz      9885: <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   9886: </dl></dd>
                   9887: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   9888: </dl>
                   9889: </div>
                   9890: <p>We checked to find a piece of software that wasn't in the packages
                   9891:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  9892:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   9893:     present in the tree is beyond us, but it's useful for the purposes of
                   9894:     this exercise.</p>
1.148     asau     9895: <div class="sect1">
1.75      rillig   9896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9897: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     9898: <div class="sect2">
1.75      rillig   9899: <div class="titlepage"><div><div><h3 class="title">
                   9900: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   9901: <pre class="programlisting">
1.100     rillig   9902: # $NetBSD$
                   9903: #
1.1       grant    9904: 
1.100     rillig   9905: DISTNAME=       bison-1.25
                   9906: CATEGORIES=     devel
                   9907: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    9908: 
1.136     dholland 9909: MAINTAINER=     pkgsrc-users@NetBSD.org
1.100     rillig   9910: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   9911: COMMENT=        GNU yacc clone
1.1       grant    9912: 
1.100     rillig   9913: GNU_CONFIGURE=  yes
1.152     wiz      9914: INFO_FILES=     yes
1.1       grant    9915: 
1.100     rillig   9916: .include "../../mk/bsd.pkg.mk"
1.1       grant    9917: </pre>
1.75      rillig   9918: </div>
1.148     asau     9919: <div class="sect2">
1.75      rillig   9920: <div class="titlepage"><div><div><h3 class="title">
                   9921: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   9922: <pre class="programlisting">
1.100     rillig   9923: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.232     sevan    9924: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-7.0.2"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   9925: of the NetBSD source tree is beyond me.
1.1       grant    9926: </pre>
1.75      rillig   9927: </div>
1.148     asau     9928: <div class="sect2">
1.75      rillig   9929: <div class="titlepage"><div><div><h3 class="title">
                   9930: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   9931: <pre class="programlisting">
1.100     rillig   9932: @comment $NetBSD$
                   9933: bin/bison
                   9934: man/man1/bison.1.gz
                   9935: share/bison.simple
                   9936: share/bison.hairy
1.1       grant    9937: </pre>
1.75      rillig   9938: </div>
1.148     asau     9939: <div class="sect2">
1.75      rillig   9940: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  9941: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   9942: </h3></div></div></div>
1.75      rillig   9943: <p>The NetBSD package system comes with
1.232     sevan    9944:         <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   9945:        which helps to check the contents of these
                   9946:        files. After installation it is quite easy to use, just change to the
                   9947:        directory of the package you wish to examine and execute
1.110     hubertf  9948:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   9949: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   9950: looks fine.</pre>
                   9951: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  9952:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   9953:        -Wall</strong></span> for a very thorough check.</p>
                   9954: </div>
                   9955: </div>
1.148     asau     9956: <div class="sect1">
1.75      rillig   9957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9958: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   9959: <p>Create the directory where the package lives,
                   9960:       plus any auxiliary directories:</p>
                   9961: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   9962: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   9963: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   9964: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   9965: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  9966:       <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   9967:       then continue with fetching the distfile:</p>
                   9968: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    9969: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   9970: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   9971: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   9972: ftp: Error retrieving file: 500 Internal error
                   9973: 
                   9974: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   9975: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   9976: ftp: Error retrieving file: 500 Internal error
                   9977: 
                   9978: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   9979: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   9980: Successfully retrieved file.</pre>
                   9981: <p>Generate the checksum of the distfile into
1.76      rillig   9982:       <code class="filename">distinfo</code>:</p>
1.88      wiz      9983: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   9984: <p>Now compile:</p>
                   9985: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    9986: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   9987: ===&gt;  Extracting for bison-1.25
                   9988: ===&gt;  Patching for bison-1.25
                   9989: ===&gt;   Ignoring empty patch directory
                   9990: ===&gt;  Configuring for bison-1.25
                   9991: creating cache ./config.cache
                   9992: checking for gcc... cc
                   9993: checking whether we are using GNU C... yes
                   9994: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   9995: checking how to run the C preprocessor... cc -E
                   9996: checking for minix/config.h... no
                   9997: checking for POSIXized ISC... no
                   9998: checking whether cross-compiling... no
                   9999: checking for ANSI C header files... yes
                   10000: checking for string.h... yes
                   10001: checking for stdlib.h... yes
                   10002: checking for memory.h... yes
                   10003: checking for working const... yes
                   10004: checking for working alloca.h... no
                   10005: checking for alloca... yes
                   10006: checking for strerror... yes
                   10007: updating cache ./config.cache
                   10008: creating ./config.status
                   10009: creating Makefile
                   10010: ===&gt;  Building for bison-1.25
                   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 LR0.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 allocate.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 closure.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 conflicts.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 derives.c
1.68      rillig   10016: 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    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 getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.c
                   10024: 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
                   10025: 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
                   10026: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g reduce.c
                   10027: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g symtab.c
                   10028: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g warshall.c
                   10029: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g version.c
                   10030: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt.c
                   10031: 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
                   10032: 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
                   10033: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10034: rm -f bison.s1
1.75      rillig   10035: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10036: <p>Everything seems OK, so install the files:</p>
                   10037: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10038: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10039: ===&gt;  Installing for bison-1.25
                   10040: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10041: rm -f /usr/pkg/bin/bison
                   10042: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10043: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10044: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10045: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10046: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10047: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10048: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10049: ===&gt;  Registering installation for bison-1.25</pre>
                   10050: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10051:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10052:       binary package, do this now:</p>
                   10053: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10054: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10055: ===&gt;  Building package for bison-1.25
                   10056: Creating package bison-1.25.tgz
                   10057: Registering depends:.
1.75      rillig   10058: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10059: <p>Now that you don't need the source and object files
                   10060:       any more, clean up:</p>
                   10061: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10062: ===&gt;  Cleaning for bison-1.25</pre>
                   10063: </div>
                   10064: </div>
1.148     asau     10065: <div class="appendix">
                   10066: <div class="titlepage"><div><div><h1 class="title">
                   10067: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   10068: <div class="toc">
                   10069: <p><b>Table of Contents</b></p>
1.210     leot     10070: <dl class="toc">
1.75      rillig   10071: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10072: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10073: </dl>
                   10074: </div>
1.148     asau     10075: <div class="sect1">
1.75      rillig   10076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10077: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10078: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10079: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10080: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10081: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10082: =&gt; [172219 bytes]
                   10083: Connected to ftp.plig.net.
                   10084: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10085: 331 Guest login ok, send your complete e-mail address as password.
                   10086: 230-You are user #5 of 500 simultaneous users allowed.
                   10087: 230-
1.68      rillig   10088: 230-  ___ _             _ _
                   10089: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10090: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10091: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10092: 230-         |_|   |_|     |___|         |___|
                   10093: 230-
                   10094: 230-** Welcome to ftp.plig.org **
                   10095: 230-
                   10096: 230-Please note that all transfers from this FTP site are logged. If you
                   10097: 230-do not like this, please disconnect now.
                   10098: 230-
1.120     snj      10099: 230-This archive is available via
1.1       grant    10100: 230-
                   10101: 230-HTTP:  http://ftp.plig.org/
                   10102: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10103: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10104: 230-
                   10105: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10106: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10107: 230-
                   10108: 230-
                   10109: 230 Logged in anonymously.
                   10110: Remote system type is UNIX.
                   10111: Using binary mode to transfer files.
                   10112: 200 Type okay.
                   10113: 250 "/pub" is new cwd.
                   10114: 250-"/pub/figlet" is new cwd.
                   10115: 250-
                   10116: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10117: 250-
1.75      rillig   10118: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10119: 250-
                   10120: 250-The official FIGlet web page is:
1.75      rillig   10121: 250-   http://www.figlet.org/
1.1       grant    10122: 250-
                   10123: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10124: 250-contribute a font or something else, you can email us.
1.68      rillig   10125: 250
1.1       grant    10126: 250 "/pub/figlet/program" is new cwd.
                   10127: 250 "/pub/figlet/program/unix" is new cwd.
                   10128: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10129: 502 Unimplemented command.
                   10130: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10131: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10132: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10133: 226 Transfer completed.
                   10134: 172219 bytes received in 00:02 (75.99 KB/s)
                   10135: 221 Goodbye.
                   10136: =&gt; Checksum OK for figlet221.tar.gz.
                   10137: ===&gt; Extracting for figlet-2.2.1nb2
                   10138: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10139: ===&gt; Patching for figlet-2.2.1nb2
                   10140: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10141: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10142: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10143: ===&gt; Configuring for figlet-2.2.1nb2
                   10144: ===&gt; Building for figlet-2.2.1nb2
                   10145: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10146: chmod a+x figlet
                   10147: gcc -O2 -o chkfont chkfont.c
                   10148: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10149: <code class="prompt">#</code>
1.75      rillig   10150: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10151: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10152: ===&gt; Installing for figlet-2.2.1nb2
                   10153: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10154: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10155: mkdir -p /usr/pkg/share/figlet
                   10156: cp figlet /usr/pkg/bin
                   10157: cp chkfont /usr/pkg/bin
                   10158: chmod 555 figlist showfigfonts
                   10159: cp figlist /usr/pkg/bin
                   10160: cp showfigfonts /usr/pkg/bin
                   10161: cp fonts/*.flf /usr/pkg/share/figlet
                   10162: cp fonts/*.flc /usr/pkg/share/figlet
                   10163: cp figlet.6 /usr/pkg/man/man6
                   10164: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10165: <code class="prompt">#</code></pre>
                   10166: </div>
1.148     asau     10167: <div class="sect1">
1.75      rillig   10168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10169: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10170: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10171: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10172: ===&gt; Packaging figlet-2.2.1nb2
                   10173: ===&gt; Building binary package for figlet-2.2.1nb2
                   10174: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10175: Using SrcDir value of /usr/pkg
1.68      rillig   10176: Registering depends:.
1.75      rillig   10177: <code class="prompt">#</code></pre>
                   10178: </div>
                   10179: </div>
1.148     asau     10180: <div class="appendix">
                   10181: <div class="titlepage"><div><div><h1 class="title">
                   10182: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   10183: <div class="toc">
                   10184: <p><b>Table of Contents</b></p>
1.210     leot     10185: <dl class="toc">
1.128     wiz      10186: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10187: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10188: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10189: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10190: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                   10191: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10192: source packages</a></span></dt>
                   10193: </dl>
                   10194: </div>
                   10195: <p>As in other big projects, the directory layout of pkgsrc
                   10196:        is quite complex for newbies. This chapter explains where you
                   10197:        find things on the FTP server. The base directory on
1.110     hubertf  10198:        <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   10199:        On other servers it may be different, but inside this directory,
                   10200:        everything should look the same, no matter on which server you
                   10201:        are. This directory contains some subdirectories, which are
                   10202:        explained below.</p>
1.148     asau     10203: <div class="sect1">
1.76      rillig   10204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10205: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   10206: <p>The directory <code class="filename">distfiles</code> contains lots
                   10207:        of archive files from all pkgsrc packages, which are mirrored
                   10208:        here. The subdirectories are called after their package names
                   10209:        and are used when the distributed files have names that don't
                   10210:        explicitly contain a version number or are otherwise too generic
                   10211:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10212: </div>
1.148     asau     10213: <div class="sect1">
1.76      rillig   10214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10215: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   10216: <p>This directory contains things that individual pkgsrc
                   10217:        developers find worth publishing.</p>
                   10218: </div>
1.148     asau     10219: <div class="sect1">
1.76      rillig   10220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10221: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   10222: <p>This directory contains binary packages for the various
                   10223:        platforms that are supported by pkgsrc.
                   10224:        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     10225: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10226: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   10227:        operating system for which the packages have been built. The
1.110     hubertf  10228:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   10229:        command, so it may differ from the one you are used to
                   10230:        hear.</p></li>
1.128     wiz      10231: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   10232:        architecture of the platform for which the packages have been
1.110     hubertf  10233:        built. It also includes the <code class="varname">ABI</code> (Application
                   10234:        Binary Interface) for platforms that have several of
                   10235:        them.</p></li>
1.128     wiz      10236: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   10237:        the operating system. For version numbers that change often (for
                   10238:        example NetBSD-current), the often-changing part should be
                   10239:        replaced with an <code class="literal">x</code>, for example
                   10240:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      10241: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 10242:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   10243:        for a stable branch, or <code class="literal">head</code> for packages
                   10244:        built from the HEAD branch. The latter should only be used when
                   10245:        the packages are updated on a regular basis. Otherwise the date
                   10246:        from checking out pkgsrc should be appended, for example
                   10247:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   10248: </ul></div>
                   10249: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10250:        can quickly click through the directories on the
                   10251:        server and find the best binary packages for their machines. Since they
                   10252:        usually know the operating system and the hardware architecture, OPSYS
                   10253:        and ARCH are placed first. After these choices, they can select the
                   10254:        best combination of OSVERSION and TAG together, since it is usually the
                   10255:        case that packages stay compatible between different version of the
                   10256:        operating system.</p>
                   10257: <p>In each of these directories, there is a
                   10258:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   10259:        <code class="filename">All</code> which contains all binary packages.
                   10260:        Besides that, there are various category directories that
                   10261:        contain symbolic links to the real binary packages.</p>
                   10262: </div>
1.148     asau     10263: <div class="sect1">
1.76      rillig   10264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10265: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   10266: <p>Here are the reports from bulk builds, for those who want
                   10267:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      10268:        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   10269: </div>
1.148     asau     10270: <div class="sect1">
1.108     rillig   10271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10272: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
                   10273: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10274: source packages</h2></div></div></div>
1.128     wiz      10275: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   10276:        that is the files that define how to create binary packages from
                   10277:        source archives.</p>
                   10278: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10279:        snapshot of the CVS repository, which is updated regularly. The
                   10280:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10281:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   10282: <p>In the directories for the quarterly branches, there is an
                   10283:        additional file called
1.126     jakllsch 10284:        <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   10285:        which contains the state of pkgsrc when it was branched.</p>
                   10286: </div>
1.75      rillig   10287: </div>
1.148     asau     10288: <div class="appendix">
                   10289: <div class="titlepage"><div><div><h1 class="title">
                   10290: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   10291: <div class="toc">
                   10292: <p><b>Table of Contents</b></p>
1.210     leot     10293: <dl class="toc">
1.79      rillig   10294: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   10295: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10296: </dl>
                   10297: </div>
1.79      rillig   10298: <p>This section contains information on editing the pkgsrc
                   10299:        guide itself.</p>
1.148     asau     10300: <div class="sect1">
1.75      rillig   10301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   10302: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10303: <p>The pkgsrc guide's source code is stored in
                   10304:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10305:        are created from it:</p>
1.148     asau     10306: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10307: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   10308: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   10309: <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>
                   10310: <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   10311:        The PDF version of the pkgsrc guide.</p></li>
1.128     wiz      10312: <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   10313:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   10314: </ul></div>
                   10315: </div>
1.148     asau     10316: <div class="sect1">
1.75      rillig   10317: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10318: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   10319: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      10320: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     10321: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      10322:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   10323:        documentation) installed. These are automatically installed when
1.232     sevan    10324:        you install the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148     asau     10325: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   10326:        right directory. All further steps will take place
                   10327:        here.</p></li>
1.148     asau     10328: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   10329:        <code class="filename">files/</code>.</p></li>
1.148     asau     10330: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   10331:        guide for valid XML and to build the final output files. If you
                   10332:        get any errors at this stage, you can just edit the files, as
                   10333:        there are only symbolic links in the working directory, pointing
                   10334:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     10335: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   10336:        commit)</strong></span></p></li>
1.148     asau     10337: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   10338:        regenerate the output files with the proper RCS
                   10339:        Ids.</p></li>
1.148     asau     10340: <li class="step">
1.110     hubertf  10341: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   10342:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   10343:        <code class="filename">htdocs</code>.</p>
1.148     asau     10344: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   10345: <h3 class="title">Note</h3>
                   10346: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  10347:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   10348:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   10349:        directory.</p>
                   10350: </div>
                   10351: </li>
1.79      rillig   10352: </ol></div>
1.75      rillig   10353: </div>
                   10354: </div>
                   10355: </div></body>
1.1       grant    10356: </html>

CVSweb <webmaster@jp.NetBSD.org>