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

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.259     jnemeth    33: <div><p class="copyright">Copyright © 1994-2019 The NetBSD Foundation, Inc</p></div>
                     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.33 2019/01/01 02:50:23 jnemeth Exp $</p></div>
1.148     asau       35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
1.210     leot       48: <dl class="toc">
1.75      rillig     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
1.157     asau       67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz        68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig     69: </dl></dd>
                     70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     71: <dd><dl>
                     72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     74: </dl></dd>
                     75: </dl></dd>
                     76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     77: <dd><dl>
1.82      rillig     78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
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.245     wiz       163: <dt><span class="sect2"><a href="#creating.python-module">10.1.2. Python modules and programs</a></span></dt>
1.91      rillig    164: </dl></dd>
1.106     rillig    165: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    166: <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>
                    167: </dl></dd>
                    168: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    169: <dd><dl>
1.128     wiz       170: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                    171: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219     rillig    172: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig    173: <dd><dl>
                    174: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    175: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    176: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    177: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    178: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    179: </dl></dd>
                    180: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    181: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    182: <dd><dl>
                    183: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    184: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    185: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    186: </dl></dd>
1.128     wiz       187: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                    188: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    189: </dl></dd>
1.128     wiz       190: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    191: <dd><dl>
                    192: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz       193: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig    194: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    195: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    196: <dd><dl>
                    197: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228     yyamano   198: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220     wiz       199: <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>
                    200: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig    201: </dl></dd>
                    202: </dl></dd>
                    203: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    204: <dd><dl>
                    205: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz       206: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    207: <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    208: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    209: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz       210: <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    211: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz       212: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                    213: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106     rillig    214: </dl></dd>
                    215: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    216: <dd><dl>
                    217: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz       218: <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    219: <dd><dl>
                    220: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz       221: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                    222:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    223:       and
                    224:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    225:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    226: </dl></dd>
1.128     wiz       227: <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    228: <dd><dl>
1.128     wiz       229: <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    230: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    231: </dl></dd>
                    232: </dl></dd>
                    233: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    234: <dd><dl>
                    235: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    236: <dd><dl>
                    237: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    238: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    239: </dl></dd>
                    240: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    241: <dd><dl>
1.128     wiz       242: <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    243: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    244: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    245: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    246: </dl></dd>
                    247: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    248: <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>
                    249: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    250: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    251: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    252: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    253: <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>
                    254: </dl></dd>
                    255: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    256: <dd><dl>
                    257: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz       258: <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    259: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig    260: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    261: </dl></dd>
                    262: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    263: <dd><dl>
                    264: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    265: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    266: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    267: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz       268: <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    269: <dd><dl>
                    270: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    271: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    272: </dl></dd>
1.128     wiz       273: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    274: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    275: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    276: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    277: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    278: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    279: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    280: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    281: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    282: <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    283: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    285: </dl></dd>
                    286: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    287: <dd><dl>
                    288: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    289: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    290: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    291: </dl></dd>
                    292: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    293: <dd><dl>
                    294: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    295: <dd><dl>
1.218     rillig    296: <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>
                    297: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                    298: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                    299: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                    300: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                    301: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                    302: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                    303: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    304: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                    305: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    306: <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    307: </dl></dd>
1.218     rillig    308: <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    309: <dd><dl>
                    310: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    311: <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       312: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig    313: </dl></dd>
1.218     rillig    314: <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    315: <dd><dl>
                    316: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    317: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    318: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    319: </dl></dd>
                    320: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    321: <dd><dl>
                    322: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    323: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    324: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz       325: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                    326: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig    327: </dl></dd>
1.218     rillig    328: <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    329: <dd><dl>
                    330: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    331: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz       332: <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    333: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    334: </dl></dd>
1.218     rillig    335: <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    336: <dd><dl>
                    337: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    338: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    339: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    340: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    341: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    342: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    343: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    344: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig    345: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka    346: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig    347: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    348: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    349: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    350: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    351: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    352: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    353: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    354: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz       355:     emulation</a></span></dt>
1.106     rillig    356: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    357: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    358: </dl></dd>
1.106     rillig    359: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig    360: </dl></dd>
1.106     rillig    361: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    362: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig    363: <dd><dl>
1.106     rillig    364: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    365: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    366: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.243     wiz       367: <dt><span class="sect1"><a href="#commit-messages">21.4. Commit Messages</a></span></dt>
                    368: <dt><span class="sect1"><a href="#committing-importing">21.5. Committing: Adding a package to CVS</a></span></dt>
                    369: <dt><span class="sect1"><a href="#updating-package">21.6. Updating a package to a newer version</a></span></dt>
                    370: <dt><span class="sect1"><a href="#renaming-package">21.7. Renaming a package in pkgsrc</a></span></dt>
                    371: <dt><span class="sect1"><a href="#moving-package">21.8. 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>,
1.261     leot      440: <code class="filename">stable</code>,
1.128     wiz       441: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    442: source packages</a></span></dt>
                    443: </dl></dd>
1.75      rillig    444: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    445: <dd><dl>
1.79      rillig    446: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    447: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    448: </dl></dd>
                    449: </dl>
                    450: </div>
1.82      rillig    451: <div class="list-of-tables">
                    452: <p><b>List of Tables</b></p>
                    453: <dl>
                    454: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    455: </dt>
1.106     rillig    456: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      457: </dt>
1.106     rillig    458: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      459: </dt>
1.82      rillig    460: </dl>
                    461: </div>
1.148     asau      462: <div class="chapter">
                    463: <div class="titlepage"><div><div><h1 class="title">
                    464: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    465: <div class="toc">
                    466: <p><b>Table of Contents</b></p>
1.210     leot      467: <dl class="toc">
1.75      rillig    468: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    469: <dd><dl>
                    470: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    471: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    472: </dl></dd>
1.75      rillig    473: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    474: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       475: <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    476: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    477: </dl>
                    478: </div>
1.148     asau      479: <div class="sect1">
1.75      rillig    480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    481: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    482: <p>There is a lot of software freely available for Unix-based
                    483: systems, which is usually available in form of the source code. Before
                    484: such software can be used, it needs to be configured to the local
                    485: system, compiled and installed, and this is exactly what The NetBSD
                    486: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    487: to handle binary packages, so that not every user has to build the
                    488: packages for himself, which is a time-costly task.</p>
1.75      rillig    489: <p>pkgsrc currently contains several thousand packages,
                    490:       including:</p>
1.148     asau      491: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot      492: <li class="listitem"><p><a href="https://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    493:          web server</p></li>
1.250     leot      494: <li class="listitem"><p><a href="https://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    495:          web browser</p></li>
1.250     leot      496: <li class="listitem"><p><a href="https://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    497:          Desktop Environment</p></li>
1.250     leot      498: <li class="listitem"><p><a href="https://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    499:          Desktop Environment</p></li>
                    500: </ul></div>
1.219     rillig    501: <p>&#8230; just to name a few.</p>
1.75      rillig    502: <p>pkgsrc has built-in support for handling varying dependencies,
                    503:       such as pthreads and X11, and extended features such as IPv6 support on
                    504:       a range of platforms.</p>
1.148     asau      505: <div class="sect2">
1.82      rillig    506: <div class="titlepage"><div><div><h3 class="title">
                    507: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    508: <p>
                    509: pkgsrc provides the following key features:
                    510: </p>
1.148     asau      511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       512: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    513:   and installation of binary packages. The source and latest
                    514:   patches are retrieved from a master or mirror download site, checksum
                    515:   verified, then built on your system. Support for binary-only
                    516:   distributions is available for both native platforms and NetBSD
                    517:   emulated platforms.</p></li>
1.128     wiz       518: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    519:   including binaries, libraries, man pages and other
                    520:   documentation.</p></li>
1.214     sevan     521: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    522:   performing updates, to ensure required packages are installed. The
                    523:   configuration files of various packages are handled automatically during
                    524:   updates, so local changes are preserved.</p></li>
1.128     wiz       525: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    526:   consists of highly portable code. This allows the greatest speed of
1.132     spz       527:   development when porting to a new platform. This portability also
1.82      rillig    528:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    529:   platforms</em></span>.</p></li>
1.128     wiz       530: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    531:   international encryption requirements and build-time options for a
                    532:   large number of packages are all set in a simple, central
                    533:   configuration file.</p></li>
1.128     wiz       534: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    535:   freely available under a BSD license, so you may extend and adapt
                    536:   pkgsrc to your needs. Support for local packages and patches is
                    537:   available right out of the box, so you can configure it specifically
                    538:   for your environment.</p></li>
                    539: </ul></div>
1.91      rillig    540: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      541: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       542: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.126     jakllsch  543: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    544: them and to complain about them rather than to just install the package
                    545: and hope that it works. There are numerous checks in pkgsrc that try to
1.250     leot      546: find such bugs: Static analysis tools (<a href="https://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    547: of shell scripts), and post-installation checks (installed files,
                    548: references to shared libraries, script interpreters).</p></li>
1.128     wiz       549: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  550: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    551: pkgsrc has been ported to many operating systems. Care is taken that
                    552: packages behave the same on all platforms.</p></li>
                    553: </ul></div>
1.82      rillig    554: </div>
1.148     asau      555: <div class="sect2">
1.82      rillig    556: <div class="titlepage"><div><div><h3 class="title">
                    557: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    558: <p>pkgsrc consists of both a source distribution and a binary
                    559: distribution for these operating systems. After retrieving the required
                    560: source or binaries, you can be up and running with pkgsrc in just
                    561: minutes!</p>
1.75      rillig    562: <p>pkgsrc was derived from FreeBSD's ports system, and
                    563:       initially developed for NetBSD only. Since then, pkgsrc has
                    564:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    565: <div class="table">
                    566: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       567: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    568: <colgroup>
                    569: <col>
                    570: <col>
1.202     sevan     571: <col>
1.82      rillig    572: </colgroup>
                    573: <thead><tr>
                    574: <th>Platform</th>
                    575: <th>Date Support Added</th>
1.202     sevan     576: <th>Notes</th>
1.82      rillig    577: </tr></thead>
                    578: <tbody>
                    579: <tr>
1.110     hubertf   580: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    581: <td align="center">Aug 1997</td>
1.202     sevan     582: <td class="auto-generated"> </td>
1.82      rillig    583: </tr>
                    584: <tr>
1.110     hubertf   585: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    586: <td align="center">Mar 1999</td>
1.203     sevan     587: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.82      rillig    588: </tr>
                    589: <tr>
1.110     hubertf   590: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    591: <td align="center">Jun 1999</td>
1.203     sevan     592: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.82      rillig    593: </tr>
                    594: <tr>
                    595: <td>
1.230     sevan     596:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    597:         </td>
                    598: <td align="center">Oct 2001</td>
1.203     sevan     599: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.82      rillig    600: </tr>
                    601: <tr>
1.110     hubertf   602: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    603: <td align="center">Nov 2002</td>
1.203     sevan     604: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.82      rillig    605: </tr>
                    606: <tr>
1.110     hubertf   607: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    608: <td align="center">Nov 2002</td>
1.203     sevan     609: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.82      rillig    610: </tr>
                    611: <tr>
1.110     hubertf   612: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    613: <td align="center">Dec 2002</td>
1.202     sevan     614: <td>
1.203     sevan     615:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    616:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.202     sevan     617:        </td>
1.82      rillig    618: </tr>
                    619: <tr>
                    620: <td>BSD/OS</td>
                    621: <td align="center">Dec 2003</td>
1.202     sevan     622: <td class="auto-generated"> </td>
1.82      rillig    623: </tr>
                    624: <tr>
1.110     hubertf   625: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    626: <td align="center">Dec 2003</td>
1.203     sevan     627: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.82      rillig    628: </tr>
                    629: <tr>
                    630: <td>
1.110     hubertf   631:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    632:           (Microsoft Windows Services for Unix)
                    633:         </td>
                    634: <td align="center">Mar 2004</td>
1.203     sevan     635: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.82      rillig    636: </tr>
                    637: <tr>
1.110     hubertf   638: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    639: <td align="center">Oct 2004</td>
1.202     sevan     640: <td class="auto-generated"> </td>
1.82      rillig    641: </tr>
                    642: <tr>
1.110     hubertf   643: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    644: <td align="center">Nov 2004</td>
1.203     sevan     645: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.82      rillig    646: </tr>
1.98      wiz       647: <tr>
1.110     hubertf   648: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       649: <td align="center">Apr 2007</td>
1.203     sevan     650: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.98      wiz       651: </tr>
1.128     wiz       652: <tr>
                    653: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    654: <td align="center">Sep 2010</td>
1.203     sevan     655: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.128     wiz       656: </tr>
1.151     obache    657: <tr>
                    658: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  659: <td align="center">Jan 2011</td>
1.202     sevan     660: <td class="auto-generated"> </td>
1.151     obache    661: </tr>
                    662: <tr>
                    663: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
                    664: <td align="center">Nov 2011</td>
1.203     sevan     665: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.151     obache    666: </tr>
                    667: <tr>
                    668: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
                    669: <td align="center">Mar 2013</td>
1.203     sevan     670: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.151     obache    671: </tr>
1.166     jnemeth   672: <tr>
                    673: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
                    674: <td align="center">Jul 2013</td>
1.203     sevan     675: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.166     jnemeth   676: </tr>
1.214     sevan     677: <tr>
                    678: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
                    679: <td align="center">Jun 2014</td>
                    680: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
                    681: </tr>
1.82      rillig    682: </tbody>
1.91      rillig    683: </table></div>
1.82      rillig    684: </div>
1.91      rillig    685: <br class="table-break">
1.82      rillig    686: </div>
1.75      rillig    687: </div>
1.148     asau      688: <div class="sect1">
1.75      rillig    689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    690: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    691: <p>This document is divided into three parts. The first,
1.110     hubertf   692:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    693:        describes how one can use one of the packages in the Package
                    694:        Collection, either by installing a precompiled binary package,
1.93      rillig    695:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   696:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75      rillig    697:        package so it can be easily built by other NetBSD users without
                    698:        knowing about the package's building details. The third part,
1.110     hubertf   699:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    700:        is intended for those who want to understand how pkgsrc is
                    701:        implemented.</p>
                    702: <p>This document is available in various formats:
1.110     hubertf   703:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75      rillig    704: </div>
1.148     asau      705: <div class="sect1">
1.75      rillig    706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    707: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       708: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    709:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    710:       terminology used within this document.</p>
1.148     asau      711: <div class="variablelist"><dl class="variablelist">
1.75      rillig    712: <dt><span class="term">Package</span></dt>
                    713: <dd><p>A set of files and building instructions
                    714:            that describe what's necessary
                    715:            to build a certain piece of software using
                    716:             pkgsrc. Packages are traditionally stored under
1.236     wiz       717:            <code class="filename">/usr/pkgsrc</code>,
                    718:            but may be stored in any location,
                    719:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75      rillig    720: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       721: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       722:          is part of the NetBSD operating system and can be bootstrapped
                    723:          to run on non-NetBSD operating systems as well.  It handles
                    724:          building (compiling), installing, and removing of
                    725:          packages.</p></dd>
1.75      rillig    726: <dt><span class="term">Distfile</span></dt>
                    727: <dd><p>This term describes the file or files that are
                    728:            provided by the author of the piece of software to
                    729:            distribute his work. All the changes necessary to build on
                    730:            NetBSD are reflected in the corresponding package. Usually
                    731:            the distfile is in the form of a compressed tar-archive,
                    732:            but other types are possible, too. Distfiles are usually
                    733:            stored below
1.76      rillig    734:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    735: <dt><span class="term">Port</span></dt>
                    736: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    737:            for what we call a package.
1.128     wiz       738:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    739:            architecture.</p></dd>
                    740: <dt><span class="term">Precompiled/binary package</span></dt>
                    741: <dd>
                    742: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    743:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    744:            file so it can be installed on machines of the same
                    745:            machine architecture without the need to
                    746:            recompile. Packages are usually generated in
1.76      rillig    747:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       748:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       749: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    750:            especially in the context of precompiled packages.</p>
                    751: </dd>
                    752: <dt><span class="term">Program</span></dt>
1.88      wiz       753: <dd><p>The piece of software to be installed which will be
                    754:          constructed from all the files in the distfile by the
                    755:          actions defined in the corresponding package.</p></dd>
1.75      rillig    756: </dl></div>
1.148     asau      757: <div class="sect2">
1.75      rillig    758: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       759: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      760: <div class="variablelist"><dl class="variablelist">
1.75      rillig    761: <dt><span class="term">pkgsrc users</span></dt>
                    762: <dd>
                    763: <p>The
                    764:        pkgsrc users are people who use the packages provided by pkgsrc.
                    765:        Typically they are system administrators. The people using the
1.128     wiz       766:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    767:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    768: <p>There are two kinds of pkgsrc users: Some only want to
                    769:        install pre-built binary packages. Others build the pkgsrc
                    770:        packages from source, either for installing them directly or for
1.110     hubertf   771:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.75      rillig    772:        documentation.</p>
                    773: </dd>
                    774: <dt><span class="term">package maintainers</span></dt>
                    775: <dd><p>A
1.110     hubertf   776:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.75      rillig    777: <dt><span class="term">infrastructure developers</span></dt>
                    778: <dd><p>These people are involved in all those files
1.76      rillig    779:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   780:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.75      rillig    781:        too.</p></dd>
                    782: </dl></div>
                    783: </div>
                    784: </div>
1.148     asau      785: <div class="sect1">
1.75      rillig    786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    787: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    788: <p>When giving examples for commands, shell prompts are used to
                    789:       show if the command should/can be issued as root, or if
1.128     wiz       790:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.226     sevan     791:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    792:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    793:       bourne shell and derivatives.</p>
1.75      rillig    794: </div>
                    795: </div>
1.148     asau      796: <div class="part">
1.75      rillig    797: <div class="titlepage"><div><div><h1 class="title">
                    798: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    799: <div class="toc">
                    800: <p><b>Table of Contents</b></p>
1.210     leot      801: <dl class="toc">
1.75      rillig    802: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    803: <dd><dl>
                    804: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    805: <dd><dl>
1.157     asau      806: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       807: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    808: </dl></dd>
                    809: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    810: <dd><dl>
                    811: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    812: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    813: </dl></dd>
                    814: </dl></dd>
                    815: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    816: <dd><dl>
1.82      rillig    817: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    818: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    819: </dl></dd>
                    820: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    821: <dd><dl>
                    822: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    823: <dd><dl>
                    824: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    825: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    826: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    827: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    828: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    829: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    830: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75      rillig    831: </dl></dd>
                    832: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    833: <dd><dl>
                    834: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    835: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    836: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    837: </dl></dd>
                    838: </dl></dd>
                    839: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    840: <dd><dl>
                    841: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    842: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    843: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       844: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       845: <dd><dl>
1.103     wiz       846: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz       847: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    848: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       849: </dl></dd>
1.103     wiz       850: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    851: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    852: </dl></dd>
                    853: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    854: <dd><dl>
                    855: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    856: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    857: </dl></dd>
                    858: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    859: builds)</a></span></dt>
1.75      rillig    860: <dd><dl>
1.180     wiz       861: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                    862: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                    863: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                    864: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau      865: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    866: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig    867: </dl></dd>
                    868: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    869: <dd><dl>
1.128     wiz       870: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    871: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106     rillig    872: </dl></dd>
                    873: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    874: <dd><dl>
                    875: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194     bsiegert  876: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                    877: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                    878: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    879: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    880: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                    881: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                    882: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                    883: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    884: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       885: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert  886: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                    887: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    888: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    889: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    890: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    891: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    892: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    893: </dl></dd>
                    894: </dl>
                    895: </div>
1.148     asau      896: <div class="chapter">
1.75      rillig    897: <div class="titlepage"><div><div><h2 class="title">
                    898: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    899: <div class="toc">
                    900: <p><b>Table of Contents</b></p>
1.210     leot      901: <dl class="toc">
1.75      rillig    902: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    903: <dd><dl>
1.157     asau      904: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       905: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    906: </dl></dd>
                    907: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    908: <dd><dl>
                    909: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    910: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    911: </dl></dd>
                    912: </dl>
                    913: </div>
1.91      rillig    914: <p>Before you download and extract the files, you need to decide
                    915: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    916: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    917: free to install the sources and binary packages wherever you want in
                    918: your filesystem, provided that the pathname does not contain white-space
                    919: or other characters that are interpreted specially by the shell and some
                    920: other programs. A safe bet is to use only letters, digits, underscores
                    921: and dashes.</p>
1.148     asau      922: <div class="sect1">
1.75      rillig    923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    924: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    925: <p>Before you download any pkgsrc files, you should decide
                    926:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    927:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    928:        quarterly basis from the current branch and only gets modified
                    929:        for security updates. The names of the stable branches are built
                    930:        from the year and the quarter, for example
1.258     leot      931:        <code class="literal">2018Q4</code>.</p>
1.75      rillig    932: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz       933:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    934:        Both ways are described here.</p>
1.157     asau      935: <p>Note that tar archive contains CVS working copy.
                    936:        Thus you can switch to using CVS at any later time.</p>
1.148     asau      937: <div class="sect2">
1.75      rillig    938: <div class="titlepage"><div><div><h3 class="title">
1.157     asau      939: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75      rillig    940: <p>The primary download location for all pkgsrc files is
1.157     asau      941:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
                    942:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    943:        (it points to the same location).
                    944:        There are a number of subdirectories for different purposes,
                    945:        which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
                    946: <p>The tar archive for the current branch is in the directory
                    947:        <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.230     sevan     948:        It is autogenerated weekly.</p>
1.157     asau      949: <p>To save download time we provide bzip2- and
                    950:        xz-compressed archives which are published at
                    951:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
                    952:        and
                    953:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
                    954:        respectively.
                    955:        </p>
                    956: <p>You can fetch the same files using FTP.</p>
1.258     leot      957: <p>The tar file for the stable branch 2018Q4 is in the
                    958:        directory <code class="filename">pkgsrc-2018Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249     leot      959: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112     weinem    960: <pre class="screen">
1.258     leot      961: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q4/pkgsrc.tar.gz</code></strong></pre>
1.188     snj       962: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau      963:        or your web browser.</p>
1.112     weinem    964: <p>Then, extract it with:</p>
1.188     snj       965: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem    966: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    967:        in <code class="filename">/usr/</code> and all the package source will be 
                    968:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    969: <p>To download pkgsrc-current, run:</p>
                    970: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75      rillig    971: </div>
1.148     asau      972: <div class="sect2">
1.75      rillig    973: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz       974: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                    975: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.258     leot      976: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2018Q4 -P pkgsrc</code></strong>
1.128     wiz       977: </pre>
                    978: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                    979:        in your <code class="filename">/usr/</code> directory and all the package source 
                    980:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    981: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz       982: <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     983: </pre>
1.188     snj       984: <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       985: <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       986: <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       987: </pre>
                    988: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                    989:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                    990:        or better globally in <code class="filename">/etc/profile</code>:</p>
                    991: <pre class="programlisting">
                    992: # set CVS remote shell command
                    993: CVS_RSH=ssh
                    994: export CVS_RSH
                    995: </pre>
                    996: <p>By default, CVS doesn't do things like most people would expect it to do.
                    997:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                    998:        in your home directory and saving the following lines to it.
                    999:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1000:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1001: <pre class="programlisting">
                   1002: # recommended CVS configuration file from the pkgsrc guide
1.146     wiz      1003: cvs -q -z2
1.101     rillig   1004: checkout -P
1.103     wiz      1005: update -dP
                   1006: diff -upN
1.101     rillig   1007: rdiff -u
1.128     wiz      1008: release -d
1.101     rillig   1009: </pre>
1.75      rillig   1010: </div>
                   1011: </div>
1.148     asau     1012: <div class="sect1">
1.75      rillig   1013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1014: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1015: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1016:        (which also works if you have first installed it via a tar
                   1017:        file). It saves bandwidth and hard disk activity, compared to
                   1018:        downloading the tar file again.</p>
1.148     asau     1019: <div class="sect2">
1.75      rillig   1020: <div class="titlepage"><div><div><h3 class="title">
                   1021: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148     asau     1022: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1023: <h3 class="title">Warning</h3>
1.77      rillig   1024: <p>When updating from a tar file, you first need to
                   1025:        completely remove the old pkgsrc directory. Otherwise those
                   1026:        files that have been removed from pkgsrc in the mean time will
                   1027:        not be removed on your local disk, resulting in inconsistencies.
                   1028:        When removing the old files, any changes that you have done to
                   1029:        the pkgsrc files will be lost after updating. Therefore updating
                   1030:        via CVS is strongly recommended.</p>
1.75      rillig   1031: </div>
1.82      rillig   1032: <p>Note that by default the distfiles and the binary packages
                   1033:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1034:        before updating. You can also configure pkgsrc to store distfiles
                   1035:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1036:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1037:        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   1038: <p>To update pkgsrc from a tar file, download the tar file as
                   1039:        explained above. Then, make sure that you have not made any
                   1040:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1041:        directory and extract the new tar file. Done.</p>
                   1042: </div>
1.148     asau     1043: <div class="sect2">
1.75      rillig   1044: <div class="titlepage"><div><div><h3 class="title">
                   1045: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132     spz      1046: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1047: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1048: </pre>
                   1049: <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>
                   1050: <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>
                   1051: </pre>
1.148     asau     1052: <div class="sect3">
1.75      rillig   1053: <div class="titlepage"><div><div><h4 class="title">
                   1054: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1055: <p>When updating pkgsrc, the CVS program keeps track of the
                   1056:        branch you selected. But if you, for whatever reason, want to
                   1057:        switch from the stable branch to the current one, you can do it
1.128     wiz      1058:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1059:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1060:        back to the stable branch, add the
1.258     leot     1061:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2018Q4</span>&#8221;</span> option.</p>
1.75      rillig   1062: </div>
1.148     asau     1063: <div class="sect3">
1.75      rillig   1064: <div class="titlepage"><div><div><h4 class="title">
                   1065: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1066: <p>When you update pkgsrc, the CVS program will only touch
                   1067:        those files that are registered in the CVS repository. That
                   1068:        means that any packages that you created on your own will stay
                   1069:        unmodified. If you change files that are managed by CVS, later
                   1070:        updates will try to merge your changes with those that have been
                   1071:        done by others. See the CVS manual, chapter
1.128     wiz      1072:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1073: </div>
                   1074: </div>
                   1075: </div>
                   1076: </div>
1.148     asau     1077: <div class="chapter">
1.75      rillig   1078: <div class="titlepage"><div><div><h2 class="title">
                   1079: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1080: <div class="toc">
                   1081: <p><b>Table of Contents</b></p>
1.210     leot     1082: <dl class="toc">
1.82      rillig   1083: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1084: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1085: </dl>
                   1086: </div>
1.148     asau     1087: <div class="sect1">
1.75      rillig   1088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1089: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1090: <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   1091: </div>
1.148     asau     1092: <div class="sect1">
1.82      rillig   1093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1094: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1095: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1096:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1097:     to privileged one all programs are installed under one particular user
1.149     asau     1098:     and cannot utilise privileged operations (packages don't create
                   1099:     special users and all special file permissions like setuid are ignored).
                   1100:     </p>
1.82      rillig   1101: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1102: <pre class="screen">
1.167     asau     1103: <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   1104: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1105: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1106:     </pre>
1.149     asau     1107: <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>
                   1108: <p>By default, in privileged mode pkgsrc uses
                   1109:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1110:     where programs will be installed in,
1.230     sevan    1111:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1112:     directory where pkgsrc will do its internal bookkeeping,
                   1113:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1114:     where packages install their persistent data.
                   1115:     In unprivileged mode pkgsrc uses
                   1116:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1117:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1118:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1119:     </p>
                   1120: <p>You can change default layout using command-line arguments.
                   1121:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1122:     </p>
1.148     asau     1123: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1124: <h3 class="title">Note</h3>
1.110     hubertf  1125: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1126:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1127:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1128:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1129: </div>
1.149     asau     1130: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1131: <h3 class="title">Note</h3>
                   1132: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1133:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1134:       corresponding to the installation you're working with to build
                   1135:       and install packages.
                   1136:       </p>
                   1137: </div>
1.75      rillig   1138: </div>
                   1139: </div>
1.148     asau     1140: <div class="chapter">
1.75      rillig   1141: <div class="titlepage"><div><div><h2 class="title">
                   1142: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1143: <div class="toc">
                   1144: <p><b>Table of Contents</b></p>
1.210     leot     1145: <dl class="toc">
1.75      rillig   1146: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1147: <dd><dl>
                   1148: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1149: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1150: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1151: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1152: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1153: <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>
                   1154: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75      rillig   1155: </dl></dd>
                   1156: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1157: <dd><dl>
                   1158: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1159: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1160: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1161: </dl></dd>
                   1162: </dl>
                   1163: </div>
                   1164: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1165: is to only install the package tools and to use binary packages
1.128     wiz      1166: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1167: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1168: of pkgsrc, too. Then you are able to build your own packages,
                   1169: and you can still use binary packages from someone else.</p>
1.148     asau     1170: <div class="sect1">
1.75      rillig   1171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1172: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1173: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1174:   server and its mirrors, there are collections of binary packages,
                   1175:   ready to be installed. These binary packages have been built using the
                   1176:   default settings for the directories, that is:</p>
1.148     asau     1177: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1178: <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>
                   1179: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1180: <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   1181: </ul></div>
                   1182: <p>If you cannot use these directories for whatever reasons (maybe
                   1183:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1184:   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     1185: <div class="sect2">
1.75      rillig   1186: <div class="titlepage"><div><div><h3 class="title">
                   1187: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1188: <p>To install binary packages, you first need to know from where
                   1189:     to get them. The first place where you should look is on the main
1.110     hubertf  1190:     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   1191: <p>This directory contains binary packages for multiple
                   1192:     platforms. First, select your operating system. (Ignore the
                   1193:     directories with version numbers attached to it, they just exist for
                   1194:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1195:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1196: <p>In this directory, you often find a file called
                   1197:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1198:     management tools. If the file is missing, it is likely that your
                   1199:     operating system already provides those tools. Download the file and
                   1200:     extract it in the <code class="filename">/</code> directory. It will create
                   1201:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1202:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1203: </div>
1.148     asau     1204: <div class="sect2">
1.75      rillig   1205: <div class="titlepage"><div><div><h3 class="title">
                   1206: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1207: <p>In the directory from the last section, there is a
1.196     wiz      1208:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1209:     binary packages that are available for the platform, excluding those
                   1210:     that may not be distributed via FTP or CDROM (depending on which
1.128     wiz      1211:     medium you are using).</p>
1.109     rillig   1212: <p>To install packages directly from an FTP or HTTP server, run
                   1213:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1214:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1215: <pre class="screen">
                   1216: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.196     wiz      1217: <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   1218: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1219: </pre>
                   1220: <p>Instead of URLs, you can also use local paths, for example if
                   1221:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1222:     repository. If you want to install packages from multiple sources,
                   1223:     you can separate them by a semicolon in
                   1224:     <code class="varname">PKG_PATH</code>.</p>
                   1225: <p>After these preparations, installing a package is very
                   1226:     easy:</p>
                   1227: <pre class="screen">
1.230     sevan    1228: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
                   1229: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.109     rillig   1230: </pre>
1.75      rillig   1231: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1232:     package in question will be installed, too, assuming they are
                   1233:     present where you install from.</p>
1.128     wiz      1234: <p>Adding packages might install vulnerable packages.
                   1235:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
                   1236:     regularly, especially after installing new packages, and verify
                   1237:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1238: <p>After you've installed packages, be sure to have
1.88      wiz      1239:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1240:     <code class="varname">PATH</code> so you can actually start the just
                   1241:     installed program.</p>
1.75      rillig   1242: </div>
1.148     asau     1243: <div class="sect2">
1.75      rillig   1244: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1245: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1246: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1247:     installed from source code or from a binary package. The
1.110     hubertf  1248:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1249:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1250:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1251:     name can be given with or without version number. Wildcards can
                   1252:     also be used to deinstall a set of packages, for example
                   1253:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1254:     so that the shell does not expand them before
                   1255:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1256: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1257:     removes all the packages that require the package in question
                   1258:     and then removes the package itself. For example:
1.82      rillig   1259: 
1.88      wiz      1260:     </p>
1.82      rillig   1261: <pre class="screen">
1.88      wiz      1262: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1263:     </pre>
1.82      rillig   1264: <p>
                   1265: 
1.88      wiz      1266:     will remove jpeg and all the packages that used it; this allows
                   1267:     upgrading the jpeg package.</p>
1.82      rillig   1268: </div>
1.148     asau     1269: <div class="sect2">
1.82      rillig   1270: <div class="titlepage"><div><div><h3 class="title">
                   1271: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1272: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1273:     installed packages or binary package files.</p>
1.82      rillig   1274: </div>
1.148     asau     1275: <div class="sect2">
1.82      rillig   1276: <div class="titlepage"><div><div><h3 class="title">
                   1277: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1278: <p>
1.88      wiz      1279:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1280:       known security vulnerabilities to packages which are (or have been)
                   1281:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1282:       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      1283:     </p>
1.82      rillig   1284: <p>
1.125     wiz      1285:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1286:       this list can be downloaded
                   1287:       automatically, and a security audit of all packages installed on a system
                   1288:       can take place.
                   1289:     </p>
1.82      rillig   1290: <p>
1.125     wiz      1291:       There are two components to auditing.  The first
                   1292:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1293:       is for downloading
1.88      wiz      1294:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1295:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1296:       installed packages are vulnerable.  If a package is vulnerable, you
                   1297:       will see output similar to the following:
                   1298:     </p>
1.82      rillig   1299: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1300:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1301: <p>
1.125     wiz      1302:       You may wish to have the
1.110     hubertf  1303:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1304:       file downloaded daily so that
                   1305:       it remains current.  This may be done by adding an appropriate entry
1.257     leot     1306:       to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1307:       </p>
                   1308: <pre class="screen">
1.233     sevan    1309: # Download vulnerabilities file
1.230     sevan    1310: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1311: # Audit the installed packages and email results to root
                   1312: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1313:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1314:       </pre>
                   1315: <p>
1.230     sevan    1316:       will update the vulnerability list every day at 3AM, followed by an audit
                   1317:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1318: 
1.230     sevan    1319:       On NetBSD this may be accomplished instead by adding the following
                   1320:       line to <code class="filename">/etc/daily.conf</code>:
                   1321:       </p>
                   1322: <pre class="screen">
                   1323: fetch_pkg_vulnerabilities=YES
                   1324:       </pre>
                   1325: <p>
                   1326:       to fetch the vulnerability list from the daily security script. The system
                   1327:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1328:       desired (not required), by adding the following line to
1.230     sevan    1329: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1330:       </p>
                   1331: <pre class="screen">
1.230     sevan    1332: check_pkg_vulnerabilities=YES
1.125     wiz      1333:       </pre>
                   1334: <p>
1.257     leot     1335:       see <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-8.0"><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-8.0"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1336:     </p>
1.82      rillig   1337: </div>
1.148     asau     1338: <div class="sect2">
1.82      rillig   1339: <div class="titlepage"><div><div><h3 class="title">
                   1340: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1341: <p>
1.250     leot     1342:       Install <a href="https://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      1343:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.88      wiz      1344:       argument to check if your packages are up-to-date, e.g.
                   1345:     </p>
                   1346: <pre class="screen">
                   1347: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1348: ...
1.88      wiz      1349: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1350:     </pre>
1.110     hubertf  1351: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1352:     package on your system and rebuild any dependencies.
                   1353:     </p>
1.82      rillig   1354: </div>
1.148     asau     1355: <div class="sect2">
1.82      rillig   1356: <div class="titlepage"><div><div><h3 class="title">
                   1357: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1358: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1359:     administrative functions on the package system.</p>
1.82      rillig   1360: </div>
1.75      rillig   1361: </div>
1.148     asau     1362: <div class="sect1">
1.75      rillig   1363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1364: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1365: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1366:   directory now contains a set of packages, organized into
                   1367:   categories. You can browse the online index of packages, or run
1.110     hubertf  1368:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1369:   directory to build local <code class="filename">README.html</code> files for
1.250     leot     1370:   all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1371: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1372:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1373:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1374:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1375:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1376:   system (inside a chroot is an exception). </p>
                   1377: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1378:   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      1379:   instructions how to create your own packages.</p>
1.148     asau     1380: <div class="sect2">
1.75      rillig   1381: <div class="titlepage"><div><div><h3 class="title">
                   1382: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1383: <p>To build packages from source, you need a working C
1.88      wiz      1384:     compiler. On NetBSD, you need to install the
1.128     wiz      1385:     <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      1386:     sets. If you want to build X11-related packages, the
1.128     wiz      1387:     <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      1388:     sets are required, too.</p>
1.75      rillig   1389: </div>
1.148     asau     1390: <div class="sect2">
1.75      rillig   1391: <div class="titlepage"><div><div><h3 class="title">
                   1392: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1393: <p>The first step for building a package is downloading the
1.88      wiz      1394:     distfiles (i.e. the unmodified source). If they have not yet been
                   1395:     downloaded, pkgsrc will fetch them automatically.</p>
                   1396: <p>If you have all files that you need in the
                   1397:     <code class="filename">distfiles</code> directory,
                   1398:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1399:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1400:     </p>
1.82      rillig   1401: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1402: <p>
1.110     hubertf  1403:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1404: <p>By default a list of distribution sites will be randomly
                   1405:     intermixed to prevent huge load on servers which holding popular
                   1406:     packages (for example, SourceForge.net mirrors). Thus, every
                   1407:     time when you need to fetch yet another distfile all the mirrors
                   1408:     will be tried in new (random) order. You can turn this feature
                   1409:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1410:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1411: <p>You can overwrite some of the major distribution sites to
                   1412:     fit to sites that are close to your own.  By setting one or two
                   1413:     variables you can modify the order in which the master sites are
                   1414:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1415:     delimited list of domain suffixes.
                   1416:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1417:     contains a whitespace delimited list of regular expressions.  It
                   1418:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1419:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1420:     some examples.  This may save some of your bandwidth and
                   1421:     time.</p>
1.75      rillig   1422: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1423:     if you want to keep the settings, by editing the
1.110     hubertf  1424:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1425:     and adding the definitions there.</p>
1.82      rillig   1426: <p>
1.88      wiz      1427:       If a package depends on many other packages (such as
1.250     leot     1428:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.88      wiz      1429:       alternate between periods of
                   1430:       downloading source, and compiling. To ensure you have all the source
                   1431:       downloaded initially you can run the command:
                   1432:       </p>
1.82      rillig   1433: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1434: <p>
1.88      wiz      1435:       which will output and run a set of shell commands to fetch the
                   1436:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1437:       also choose to download the files manually.
                   1438:     </p>
1.75      rillig   1439: </div>
1.148     asau     1440: <div class="sect2">
1.75      rillig   1441: <div class="titlepage"><div><div><h3 class="title">
                   1442: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1443: <p>
1.88      wiz      1444:       Once the software has downloaded, any patches will be applied, then it
                   1445:       will be compiled for you. This may take some time depending on your
                   1446:       computer, and how many other packages the software depends on and their
                   1447:       compile time.
                   1448:     </p>
1.148     asau     1449: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1450: <h3 class="title">Note</h3>
                   1451: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1452:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1453:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1454: </div>
1.87      wiz      1455: <p>For example, type</p>
1.88      wiz      1456: <pre class="screen">
                   1457: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1458: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1459:     </pre>
1.75      rillig   1460: <p>at the shell prompt to build the various components of the
1.88      wiz      1461:     package.</p>
1.82      rillig   1462: <p>The next stage is to actually install the newly compiled
1.88      wiz      1463:     program onto your system. Do this by entering:
1.82      rillig   1464: 
1.88      wiz      1465:     </p>
1.82      rillig   1466: <pre class="screen">
1.88      wiz      1467: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1468:     </pre>
1.82      rillig   1469: <p>
                   1470: 
1.88      wiz      1471:     while you are still in the directory for whatever package you
                   1472:     are installing.</p>
1.82      rillig   1473: <p>Installing the package on your system may require you to
1.88      wiz      1474:     be root.  However, pkgsrc has a
                   1475:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1476:     to only become root for the actual installation step.</p>
1.82      rillig   1477: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1478:     You can now enter:
1.82      rillig   1479: 
1.88      wiz      1480:     </p>
1.82      rillig   1481: <pre class="screen">
1.88      wiz      1482: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1483:     </pre>
1.82      rillig   1484: <p>
                   1485: 
1.88      wiz      1486:     to remove the compiled files in the work directory, as you shouldn't need
                   1487:     them any more. If other packages were also added to your system
                   1488:     (dependencies) to allow your program to compile, you can tidy these up
                   1489:     also with the command:</p>
1.82      rillig   1490: <pre class="screen">
1.88      wiz      1491: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1492:     </pre>
1.75      rillig   1493: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  1494:     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      1495: <p>The program is installed under the default root of the
                   1496:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1497:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1498:     variable in your environment, and it will use that value as the
                   1499:     root of your packages tree. So, to use
                   1500:     <code class="filename">/usr/local</code>, set
                   1501:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1502:     Please note that you should use a directory which is dedicated to
                   1503:     packages and not shared with other programs (i.e., do not try and
                   1504:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1505:     to add any of your own files or directories (such as
                   1506:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1507:     <code class="filename">pkgsrc/</code>) below the
                   1508:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1509:     conflicts between programs and other files installed by the
                   1510:     package system and whatever else may have been installed
                   1511:     there.</p>
1.110     hubertf  1512: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1513:     alter some configuration options at build time.  Have a look at
                   1514:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1515:     of what will be set there by default.  Environment variables such
                   1516:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1517:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1518:     set them each time you want to use pkgsrc.</p>
1.128     wiz      1519: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1520:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      1521:     or being installed. This may be for debugging purposes, or out of
                   1522:     simple curiosity. A number of utility values have been added to
                   1523:     help with this.</p>
1.128     wiz      1524: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1525: <li class="listitem">
1.257     leot     1526: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      1527:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1528:        information will be displayed. For example,</p>
1.75      rillig   1529: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1530: <p>will show all the commands that are invoked, up to and
1.128     wiz      1531:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   1532: </li>
1.128     wiz      1533: <li class="listitem">
1.257     leot     1534: <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-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1535:        definition, then the <code class="varname">VARNAME</code> definition
                   1536:        should be used, in conjunction with the show-var
1.257     leot     1537:        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-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1538:        variable <code class="varname">LOCALBASE</code>:</p>
                   1539: <pre class="screen">
                   1540: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1541: /usr/pkg
                   1542: <code class="prompt">%</code>
1.88      wiz      1543:        </pre>
1.75      rillig   1544: </li>
                   1545: </ol></div>
                   1546: <p>If you want to install a binary package that you've either
1.88      wiz      1547:     created yourself (see next section), that you put into
                   1548:     pkgsrc/packages manually or that is located on a remote FTP
                   1549:     server, you can use the "bin-install" target. This target will
1.257     leot     1550:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  1551:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1552:     sites searched is kept in the variable
                   1553:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.257     leot     1554:     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-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      1555:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1556:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1557:     details.</p>
                   1558: <p>A final word of warning: If you set up a system that has a
                   1559:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1560:     set that before any packages are installed, as you cannot use
                   1561:     several directories for the same purpose. Doing so will result in
                   1562:     pkgsrc not being able to properly detect your installed packages,
                   1563:     and fail miserably. Note also that precompiled binary packages are
                   1564:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1565:     <code class="filename">/usr/pkg</code>, and that you should
                   1566:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1567:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1568: </div>
                   1569: </div>
                   1570: </div>
1.148     asau     1571: <div class="chapter">
1.75      rillig   1572: <div class="titlepage"><div><div><h2 class="title">
                   1573: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   1574: <div class="toc">
                   1575: <p><b>Table of Contents</b></p>
1.210     leot     1576: <dl class="toc">
1.75      rillig   1577: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   1578: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   1579: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      1580: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      1581: <dd><dl>
1.103     wiz      1582: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz      1583: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1584: <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      1585: </dl></dd>
1.103     wiz      1586: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   1587: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   1588: </dl>
                   1589: </div>
1.104     rillig   1590: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1591: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1592: that file depends on the installation. On NetBSD, when you use
1.257     leot     1593: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   1594: <code class="filename">/etc/</code>. In all other cases the default location is
                   1595: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1596: bootstrap program to install the binary packages.</p>
                   1597: <p>The format of the configuration file is that of the usual
                   1598: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1599: is done by setting variables in this file. Note that you can define all
                   1600: kinds of variables, and no special error checking (for example for
1.223     rillig   1601: spelling mistakes) takes place.</p>
1.148     asau     1602: <div class="sect1">
1.75      rillig   1603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1604: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.223     rillig   1605: <p>The following variables apply to all
1.89      rillig   1606:     pkgsrc packages. A complete list of the variables that can be
                   1607:     configured by the user is available in
                   1608:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1609:     comments that describe each variable's intent.</p>
1.148     asau     1610: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1611: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1612:            packages will be installed. The default is
1.76      rillig   1613:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1614:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1615: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1616:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   1617:            installed. The default is
1.76      rillig   1618:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1619: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1620:            X11 is installed on the system. The default is
1.194     bsiegert 1621:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1622: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1623:            downloaded copies of the original source distributions used
                   1624:            for building pkgsrc packages. The default is
1.76      rillig   1625:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1626: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1627:            database about installed packages is stored.  The default is
1.230     sevan    1628:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1629: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1630:            If set, override the packages'
                   1631:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1632: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1633:            Backup location(s) for distribution files and patch files
                   1634:            if not found locally or in
1.76      rillig   1635:            <code class="filename">${MASTER_SITES}</code> or
                   1636:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1637:            The defaults is
                   1638:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1639: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1640:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1641:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      1642:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1643:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1644: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1645:            List of acceptable licenses. License names are case-sensitive.
                   1646:            Whenever you try to build a package whose license is not in this
                   1647:            list, you will get an error message. If the license condition is
                   1648:            simple enough, the error message will include specific
                   1649:            instructions on how to change this variable.</p></li>
1.75      rillig   1650: </ul></div>
                   1651: </div>
1.148     asau     1652: <div class="sect1">
1.75      rillig   1653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1654: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1655: <p>
1.75      rillig   1656:       </p>
1.148     asau     1657: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1658: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1659:            directory for the binary packages. The default is
1.76      rillig   1660:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1661: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1662:            The top level directory where, if defined, the separate
                   1663:            working directories will get created, and symbolically
1.76      rillig   1664:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1665:            This is useful for building packages on several
1.76      rillig   1666:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1667:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1668:            is local to every architecture. (It should be noted that
                   1669:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1670:            &mdash; it is an internal definition which refers to the
1.75      rillig   1671:            root of the pkgsrc tree. It is possible to have many
                   1672:            pkgsrc tree instances.)</p></li>
1.128     wiz      1673: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1674:            Directory for local patches that aren't part of pkgsrc.
1.219     rillig   1675:            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   1676:            information.</p></li>
1.128     wiz      1677: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1678:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1679:            BSD-style Makefile. If this is not set,
                   1680:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1681:            <code class="filename">/dev/null</code> to avoid picking up
                   1682:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75      rillig   1683: </ul></div>
                   1684: </div>
1.148     asau     1685: <div class="sect1">
1.75      rillig   1686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   1687: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.256     maya     1688: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
                   1689:                 By default, binary packages of built packages are
1.263   ! leot     1690:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256     maya     1691:                this variable to "no" prevents this.</p></li></ul></div>
1.217     jnemeth  1692: <p>Packages have to support installation into a
1.103     wiz      1693:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1694:     to be built, before the actual filesystem is touched. DESTDIR
                   1695:     support exists in two variations:</p>
1.148     asau     1696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1697: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1698:       installation and packaging is still run as root.</p></li>
                   1699: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1700:       build, installation and packaging as normal user. Root
                   1701:       privileges are only needed to add packages.</p></li>
                   1702: </ul></div>
1.103     wiz      1703: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1704:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1705: <p>Considering the <code class="filename">foo/bar</code> package,
                   1706:     DESTDIR full support can be tested using the following commands
                   1707: 
                   1708: </p>
                   1709: <pre class="programlisting">
                   1710: <code class="prompt">$</code> id
                   1711: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1712: <code class="prompt">$</code> mkdir $HOME/packages
                   1713: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1714: </pre>
                   1715: <p>
                   1716: 
                   1717:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1718:     should be needed
                   1719: 
                   1720: </p>
                   1721: <pre class="programlisting">
1.174     asau     1722: <code class="prompt">$</code> make stage-install
1.118     imil     1723: </pre>
                   1724: <p>
                   1725: 
                   1726:     Create a package without root privileges
                   1727: 
                   1728: </p>
                   1729: <pre class="programlisting">
1.174     asau     1730: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1731: </pre>
                   1732: <p>
                   1733: 
                   1734:     For the following command, you must be able to gain root
1.257     leot     1735:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     1736: 
                   1737: </p>
                   1738: <pre class="programlisting">
1.174     asau     1739: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1740: </pre>
                   1741: <p>
                   1742: 
                   1743:     Then, as a simple user
                   1744: 
                   1745: </p>
                   1746: <pre class="programlisting">
                   1747: <code class="prompt">$</code> make clean
                   1748: </pre>
                   1749: <p>
                   1750: 
                   1751:     </p>
1.103     wiz      1752: </div>
1.148     asau     1753: <div class="sect1">
1.103     wiz      1754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1755: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1756: <div class="sect2">
1.78      rillig   1757: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      1758: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1759: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1760:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1761: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1762: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1763: <dd>
                   1764: <p>This is a list of values specifying the chain of
                   1765:          compilers to invoke when building packages.  Valid values
                   1766:          are:</p>
1.148     asau     1767: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1768: <li class="listitem"><p><code class="varname">ccc</code>:
                   1769:            Compaq C Compilers (Tru64)</p></li>
                   1770: <li class="listitem"><p><code class="varname">ccache</code>:
                   1771:            compiler cache (chainable)</p></li>
                   1772: <li class="listitem"><p><code class="varname">clang</code>:
                   1773:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1774: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1775:            distributed C/C++ (chainable)</p></li>
1.174     asau     1776: <li class="listitem"><p><code class="varname">f2c</code>:
                   1777:            Fortran 77 to C compiler (chainable)</p></li>
                   1778: <li class="listitem"><p><code class="varname">icc</code>:
                   1779:            Intel C++ Compiler (Linux)</p></li>
                   1780: <li class="listitem"><p><code class="varname">ido</code>:
                   1781:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1782: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1783:            GNU C/C++ Compiler</p></li>
1.174     asau     1784: <li class="listitem"><p><code class="varname">hp</code>:
                   1785:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1786: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1787:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1788: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1789:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1790: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1791:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1792: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1793:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1794: </ul></div>
                   1795: <p>The default is
1.128     wiz      1796:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   1797:          <code class="varname">ccache</code> and/or
                   1798:          <code class="varname">distcc</code> with an appropriate
                   1799:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      1800:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 1801:          variable should always be terminated with a value for
                   1802:          a real compiler.  Note that only one real compiler
1.128     wiz      1803:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 1804:          is not allowed).</p>
1.89      rillig   1805: </dd>
                   1806: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1807: <dd><p>This specifies the minimum version of GCC to use
                   1808:          when building packages.  If the system GCC doesn't
                   1809:          satisfy this requirement, then pkgsrc will build and
                   1810:          install one of the GCC packages to use instead.</p></dd>
1.225     maya     1811: <dt><span class="term"><code class="varname">PYTHON_DEFAULT_VERSION</code>:</span></dt>
                   1812: <dd><p>Specifies which version of python to use when several
                   1813:          options are available.</p></dd>
                   1814: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
                   1815: <dd><p>Specifies the fortran compiler to use.
                   1816:          The default is <code class="varname">g95</code>, and
                   1817:          <code class="varname">gfortran</code> is an alternative.</p></dd>
                   1818: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1819: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1820:          <code class="varname">gfortran</code> is used, this option specifies which
                   1821:          version to use.</p></dd>
1.89      rillig   1822: </dl></div>
                   1823: </div>
1.148     asau     1824: <div class="sect2">
1.89      rillig   1825: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      1826: <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   1827: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1828:        please make sure to use the <code class="literal">+=</code> operator
                   1829:        instead of the <code class="literal">=</code> operator:</p>
                   1830: <pre class="programlisting">
1.100     rillig   1831: CFLAGS+=        -your -flags
1.78      rillig   1832: </pre>
                   1833: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      1834:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  1835:        need to add their own flags.  You may want to take a look
1.250     leot     1836:        at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128     wiz      1837:        package if you're interested in optimization specifically
                   1838:        for the current CPU. </p>
1.78      rillig   1839: </div>
1.148     asau     1840: <div class="sect2">
1.88      wiz      1841: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      1842: <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      1843: <p>If you want to pass flags to the linker, both in the configure
                   1844: step and the build step, you can do this in two ways.  Either set
                   1845: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1846: between the two is that <code class="varname">LIBS</code> will be appended to
                   1847: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1848: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1849: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1850: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1851: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1852: settings, use the <code class="literal">+=</code> operator:</p>
                   1853: <pre class="programlisting">
1.100     rillig   1854: LDFLAGS+=        -your -linkerflags
1.88      wiz      1855: </pre>
                   1856: </div>
1.78      rillig   1857: </div>
1.148     asau     1858: <div class="sect1">
1.78      rillig   1859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      1860: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 1861: <p>
1.75      rillig   1862:       </p>
1.148     asau     1863: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1864: <li class="listitem">
1.75      rillig   1865: <p><code class="varname">PKG_DEVELOPER</code>:
                   1866:            Run some sanity checks that package developers want:
                   1867:            </p>
1.148     asau     1868: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      1869: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      1870:              fuzz</p></li>
1.128     wiz      1871: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      1872:              binaries will find their shared libs.</p></li>
1.75      rillig   1873: </ul></div>
                   1874: <p>
1.87      wiz      1875:        </p>
1.75      rillig   1876: </li>
1.128     wiz      1877: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      1878:        of debugging output which is displayed whilst making and
                   1879:        installing the package.  The default value for this is 0,
                   1880:        which will not display the commands as they are executed
                   1881:        (normal, default, quiet operation); the value 1 will display
                   1882:        all shell commands before their invocation, and the value 2
                   1883:        will display both the shell commands before their invocation,
1.223     rillig   1884:        as well as their actual execution progress with <span class="command"><strong>set
                   1885:        -x</strong></span>.</p></li>
1.75      rillig   1886: </ul></div>
                   1887: <p>
                   1888:     </p>
                   1889: </div>
1.148     asau     1890: <div class="sect1">
1.75      rillig   1891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      1892: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      1893: <p>Some packages have build time options, usually to select
                   1894:     between different dependencies, enable optional support for big
                   1895:     dependencies or enable experimental features.</p>
1.75      rillig   1896: <p>To see which options, if any, a package supports, and which
1.110     hubertf  1897:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      1898:     show-options</strong></span>, for example:</p>
1.75      rillig   1899: <pre class="programlisting">
                   1900:     The following options are supported by this package:
                   1901:         ssl      Enable SSL support.
                   1902:     Exactly one of the following gecko options is required:
                   1903:         firefox  Use firefox as gecko rendering engine.
                   1904:         mozilla  Use mozilla as gecko rendering engine.
                   1905:     At most one of the following database options may be selected:
                   1906:         mysql    Enable support for MySQL database.
                   1907:         pgsql    Enable support for PostgreSQL database.
1.1       grant    1908: 
1.75      rillig   1909:     These options are enabled by default: firefox
                   1910:     These options are currently enabled: mozilla ssl
1.1       grant    1911: </pre>
1.75      rillig   1912: <p>The following variables can be defined in
1.110     hubertf  1913:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      1914:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   1915:     which can be used to select or disable options for all packages
                   1916:     that support them, and
                   1917:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   1918:     which can be used to select or disable options specifically for
                   1919:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      1920:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      1921:     are disabled. A few examples:</p>
1.75      rillig   1922: <pre class="screen">
1.110     hubertf  1923: <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   1924: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   1925: PKG_OPTIONS.kdebase=    debug -sasl
                   1926: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   1927: <p>It is important to note that options that were specifically
1.120     snj      1928:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   1929:     you do not wish to include the option.  If you are unsure you can view
                   1930:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      1931: <p>The following settings are consulted in the order given, and
                   1932:     the last setting that selects or disables an option is
                   1933:     used:</p>
1.128     wiz      1934: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1935: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      1936:       maintainer</p></li>
1.128     wiz      1937: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      1938:       variables (see below)</p></li>
1.128     wiz      1939: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   1940: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   1941: </ol></div>
                   1942: <p>For groups of mutually exclusive options, the last option
1.88      wiz      1943:     selected is used, all others are automatically disabled.  If an
                   1944:     option of the group is explicitly disabled, the previously
                   1945:     selected option, if any, is used.  It is an error if no option
                   1946:     from a required group of options is selected, and building the
                   1947:     package will fail.</p>
                   1948: <p>Before the options framework was introduced, build options
                   1949:     were selected by setting a variable (often named
                   1950:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  1951:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      1952:     transition to the options framework for the user, these legacy
                   1953:     variables are converted to the appropriate options setting
                   1954:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   1955:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  1956:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      1957:     directly.  Support for the legacy variables will be removed
                   1958:     eventually.</p>
1.75      rillig   1959: </div>
                   1960: </div>
1.148     asau     1961: <div class="chapter">
1.75      rillig   1962: <div class="titlepage"><div><div><h2 class="title">
                   1963: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   1964: <div class="toc">
                   1965: <p><b>Table of Contents</b></p>
1.210     leot     1966: <dl class="toc">
1.75      rillig   1967: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   1968: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   1969: </dl>
                   1970: </div>
1.148     asau     1971: <div class="sect1">
1.75      rillig   1972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1973: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      1974: <p>Once you have built and installed a package, you can create
                   1975:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.257     leot     1976:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      1977:     the same package on a group of hosts and wasting CPU time. It also
                   1978:     provides a simple means for others to install your package, should
                   1979:     you distribute it.</p>
                   1980: <p>To create a binary package, change into the appropriate
1.110     hubertf  1981:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      1982:     package</strong></span>:</p>
                   1983: <pre class="screen">
1.223     rillig   1984: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1985: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   1986: </pre>
1.87      wiz      1987: <p>This will build and install your package (if not already done),
                   1988:     and then build a binary package from what was installed. You can
1.110     hubertf  1989:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      1990:     it. Binary packages are created by default in
                   1991:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  1992:     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.250     leot     1993:     continuation of the above <a href="https://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  1994: <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      1995:     such a binary package.</p>
1.75      rillig   1996: </div>
1.148     asau     1997: <div class="sect1">
1.75      rillig   1998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1999: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2000: <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   2001: </div>
                   2002: </div>
1.148     asau     2003: <div class="chapter">
1.106     rillig   2004: <div class="titlepage"><div><div><h2 class="title">
                   2005: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2006: builds)</h2></div></div></div>
                   2007: <div class="toc">
                   2008: <p><b>Table of Contents</b></p>
1.210     leot     2009: <dl class="toc">
1.180     wiz      2010: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                   2011: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                   2012: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                   2013: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau     2014: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2015: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2016: </dl>
                   2017: </div>
1.180     wiz      2018: <p>For a number of reasons you may want to build binary packages
                   2019: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
                   2020: For instance, when you have multiple machines that should run the same software,
                   2021: it is wasted time if they all build their packages themselves from source.
                   2022: Or you may want to build a list of packages you want and check them before
                   2023: deploying onto production system.
                   2024: There is a way of getting a set of binary packages:
1.223     rillig   2025: The bulk build system, or pbulk ("p" stands for "parallel").
                   2026: This chapter describes how to set it up.</p>
1.148     asau     2027: <div class="sect1">
1.106     rillig   2028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2029: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
                   2030: <p>First of all, you have to decide whether you build all packages
                   2031: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2032: both space and time, than builds for some practical sets of packages.
                   2033: There exists a number of particularly heavy packages that are not actually
                   2034: interesting to a wide audience.
                   2035: 
                   2036: For a limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2037: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2038: </p>
                   2039: <p>During bulk builds various packages are installed and deinstalled
                   2040: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2041: so make sure that you don't need any package during the builds.
1.223     rillig   2042: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2043: or something even more restrictive, depending on what the operating system provides,
                   2044: or dedicate the whole physical machine.
                   2045: As a useful side effect this makes sure that bulk builds cannot
                   2046: break anything in your system. There have been numerous cases where
1.106     rillig   2047: certain packages tried to install files outside the
                   2048: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2049: <code class="filename">/etc</code>.
                   2050: </p>
1.106     rillig   2051: </div>
1.148     asau     2052: <div class="sect1">
1.106     rillig   2053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2054: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   2055: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148     asau     2056: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2057: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2058: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2059: </ul></div>
1.148     asau     2060: <div class="sect2">
1.116     rillig   2061: <div class="titlepage"><div><div><h3 class="title">
1.180     wiz      2062: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.223     rillig   2063: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2064: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2065: Configure network access to fetch distribution files.
1.223     rillig   2066: Create a user with name "pbulk".</p>
1.178     asau     2067: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2068: <pre class="screen">
1.181     wiz      2069: <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>
                   2070: <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>
                   2071: <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     2072: </pre>
                   2073: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2074: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2075: <pre class="screen">
1.230     sevan    2076: <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     2077: <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>
                   2078: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2079: </pre>
                   2080: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2081: <h3 class="title">Note</h3>
                   2082: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2083: <code class="filename">mk.conf</code> that contains settings you want to
                   2084: apply to packages you build. For instance,</p>
                   2085: <pre class="programlisting">
1.223     rillig   2086: PKG_DEVELOPER=          yes     # perform more checks
                   2087: X11_TYPE=               modular # use pkgsrc X11
                   2088: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2089:                                 # when building all packages)
1.178     asau     2090: </pre>
                   2091: </div>
                   2092: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2093: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2094: <pre class="programlisting">
                   2095: www/firefox
                   2096: mail/thunderbird
                   2097: misc/libreoffice4
                   2098: </pre>
1.179     asau     2099: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2100: and make final amendments, if wanted.</p>
1.178     asau     2101: <p>Start it:</p>
                   2102: <pre class="screen">
                   2103: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2104: </pre>
                   2105: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2106: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2107: </p>
                   2108: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2109: <h3 class="title">Note</h3>
                   2110: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2111: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2112: The script is kept small enough for better understanding.</p>
                   2113: </div>
                   2114: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2115: <h3 class="title">Note</h3>
                   2116: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2117: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2118: </div>
1.106     rillig   2119: </div>
                   2120: </div>
1.148     asau     2121: <div class="sect1">
1.106     rillig   2122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2123: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
                   2124: <p>A complete bulk build requires lots of disk space. Some of the
                   2125: disk space can be read-only, some other must be writable. Some can be on
                   2126: remote filesystems (such as NFS) and some should be local. Some can be
                   2127: temporary filesystems, others must survive a sudden reboot.</p>
                   2128: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2129: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2130: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2131: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2132: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2133: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2134: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2135: </ul></div>
                   2136: </div>
                   2137: <div class="sect1">
                   2138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174     asau     2139: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2140: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2141:     create a CD-ROM set of the resulting binary packages to assist
                   2142:     in installing packages on other machines.  The
1.250     leot     2143:     <a href="https://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      2144:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2145:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2146:     way that keeps all the dependencies for a given package on the same
                   2147:     CD as that package.</p>
1.148     asau     2148: <div class="sect2">
1.75      rillig   2149: <div class="titlepage"><div><div><h3 class="title">
1.174     asau     2150: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2151: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2152:       man page. The following short example assumes that the binary
                   2153:       packages are left in
                   2154:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2155:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2156:       hold the ISO 9660 images.</p>
                   2157: <pre class="screen">
                   2158: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2159: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2160: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2161:       </pre>
                   2162: <p>If you wish to include a common set of files
                   2163:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2164:       etc.) on each CD in the collection, then you need to create a
                   2165:       directory which contains these files. e.g.</p>
                   2166: <pre class="screen">
                   2167: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2168: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2169: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2170: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2171: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2172: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2173: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2174:       </pre>
1.75      rillig   2175: <p>Now create the images:</p>
                   2176: <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   2177: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2178:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2179:       in their root directories.</p>
1.75      rillig   2180: </div>
                   2181: </div>
                   2182: </div>
1.148     asau     2183: <div class="chapter">
1.75      rillig   2184: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2185: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2186: <div class="toc">
                   2187: <p><b>Table of Contents</b></p>
1.210     leot     2188: <dl class="toc">
1.128     wiz      2189: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2190: <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   2191: </dl>
                   2192: </div>
                   2193: <p>The files that are installed by pkgsrc are organized in a way that
                   2194: is similar to what you find in the <code class="filename">/usr</code> directory
                   2195: of the base system. But some details are different. This is because
                   2196: pkgsrc initially came from FreeBSD and had adopted its file system
                   2197: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2198: which operating system you are using pkgsrc with, you can expect the
                   2199: same layout for pkgsrc.</p>
1.91      rillig   2200: <p>There are mainly four root directories for pkgsrc, which are all
                   2201: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2202: When pkgsrc has been installed as root, the default locations
                   2203: are:</p>
                   2204: <pre class="programlisting">
1.100     rillig   2205: LOCALBASE=              /usr/pkg
                   2206: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2207: VARBASE=                /var
1.231     sevan    2208: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2209: </pre>
                   2210: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2211: user), the default locations are:</p>
                   2212: <pre class="programlisting">
1.100     rillig   2213: LOCALBASE=              ${HOME}/pkg
                   2214: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2215: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2216: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2217: </pre>
                   2218: <p>What these four directories are for, and what they look like is
                   2219: explained below.</p>
1.148     asau     2220: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2221: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2222: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2223: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2224: the well-known subdirectories like <code class="filename">bin</code>,
                   2225: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2226: <code class="filename">share</code> and
                   2227: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2228: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2229: <code class="filename">/var</code> in the base system. Some programs (especially
                   2230: games, network daemons) need write access to it during normal
                   2231: operation.</p></li>
1.128     wiz      2232: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2233: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2234: 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   2235: itself.</p></li>
                   2236: </ul></div>
1.148     asau     2237: <div class="sect1">
1.90      rillig   2238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2239: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2240: </h2></div></div></div>
1.90      rillig   2241: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2242: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2243: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2244: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2245: <dd><p>Contains executable programs that are intended to be
                   2246: directly used by the end user.</p></dd>
                   2247: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2248: <dd><p>Contains files for the emulation layers of various other
                   2249: operating systems, especially for
                   2250: NetBSD.</p></dd>
                   2251: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2252: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2253: <dd><p>Contains
                   2254: the configuration files.</p></dd>
                   2255: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2256: <dd><p>Contains headers for the C and C++ programming
                   2257: languages.</p></dd>
                   2258: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2259: <dd><p>Contains GNU info files of various
                   2260: packages.</p></dd>
                   2261: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2262: <dd><p>Contains shared and static
                   2263: libraries.</p></dd>
                   2264: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2265: <dd><p>Contains data files that don't change after
                   2266: installation. Other data files belong into
                   2267: <code class="filename">${VARBASE}</code>.</p></dd>
                   2268: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2269: <dd><p>Contains programs that are not intended to be used by
                   2270: end users, such as helper programs or network
                   2271: daemons.</p></dd>
                   2272: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2273: <dd><p>Contains programs that are intended to be executed as
                   2274: CGI scripts by a web server.</p></dd>
                   2275: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2276: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2277: <dd><p>Contains brief
                   2278: documentation in form of manual pages.</p></dd>
                   2279: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2280: <dd><p>Contains programs that are intended to be used only by
                   2281: the super-user.</p></dd>
                   2282: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2283: <dd><p>Contains platform-independent data files that don't
                   2284: change after installation.</p></dd>
                   2285: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2286: <dd><p>Contains documentation files provided by the
                   2287: packages.</p></dd>
                   2288: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2289: <dd><p>Contains example files provided by the packages. Among
                   2290: others, the original configuration files are saved here and copied to
                   2291: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2292: installation.</p></dd>
                   2293: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2294: <dd><p>Contains the original files for rc.d
                   2295: scripts.</p></dd>
                   2296: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2297: <code class="filename">${VARBASE}</code>)</span></dt>
                   2298: <dd><p>Contains files
                   2299: that may be modified after
                   2300: installation.</p></dd>
                   2301: </dl></div>
                   2302: </div>
1.148     asau     2303: <div class="sect1">
1.90      rillig   2304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2305: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2306: </h2></div></div></div>
1.148     asau     2307: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2308: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2309: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2310: <dd><p>Contains
                   2311: information about the currently installed
                   2312: packages.</p></dd>
                   2313: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2314: <dd><p>Contains highscore
                   2315: files.</p></dd>
                   2316: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2317: <dd><p>Contains log files.</p></dd>
                   2318: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2319: <dd><p>Contains informational files about daemons that are
                   2320: currently running.</p></dd>
                   2321: </dl></div>
                   2322: </div>
                   2323: </div>
1.148     asau     2324: <div class="chapter">
1.90      rillig   2325: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2326: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2327: <div class="toc">
                   2328: <p><b>Table of Contents</b></p>
1.210     leot     2329: <dl class="toc">
1.106     rillig   2330: <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 2331: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                   2332: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                   2333: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2334: <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>
                   2335: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                   2336: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                   2337: <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>
                   2338: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                   2339: <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      2340: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert 2341: <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>
                   2342: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2343: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   2344: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                   2345: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2346: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                   2347: <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   2348: </dl>
                   2349: </div>
                   2350: <p>This section contains hints, tips &amp; tricks on special things in
                   2351: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2352: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2353: <div class="sect1">
1.75      rillig   2354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2355: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2356: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2357: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2358: <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   2359:          This is a general purpose list for most issues regarding
                   2360:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2361:          for pkgsrc configuration, unexpected build failures, using
                   2362:          particular packages, upgrading pkgsrc installations,
                   2363:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2364:          proposals for changes that impact the pkgsrc user community,
                   2365:          e.g. major infrastructure changes, new features, package
                   2366:          removals, etc., may also be posted.</p></li>
1.128     wiz      2367: <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   2368:          A list where the results of pkgsrc bulk builds are sent and
                   2369:          discussed.</p></li>
1.128     wiz      2370: <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   2371:          This list is for those who are interested in getting a
                   2372:          commit message for every change committed to pkgsrc. It is
                   2373:          also available in digest form, meaning one daily message
                   2374:          containing all commit messages for changes to the package
                   2375:          source tree in that 24 hour period.</p></li>
                   2376: </ul></div>
                   2377: <p>To subscribe, do:</p>
                   2378: <pre class="programlisting">
1.100     rillig   2379: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2380: </pre>
                   2381: <p>Archives for all these mailing lists are available from
1.110     hubertf  2382: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2383: </div>
1.148     asau     2384: <div class="sect1">
1.75      rillig   2385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2386: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2387: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2388: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2389: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2390: they might be useful, and not to duplicate the documentation that comes
                   2391: with each package.</p>
                   2392: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.250     leot     2393: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://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   2394:       Symlinks for use by buildlink.</p></li></ul></div>
                   2395: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2396: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2397: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233     sevan    2398:       Calculates various kinds of checksums (including SHA3).</p></li>
1.250     leot     2399: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   2400:       Compatibility library for pkgsrc tools.</p></li>
1.250     leot     2401: <li class="listitem"><p><a href="https://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      2402:       non-BSD systems due to lack of native mtree.</p></li>
1.250     leot     2403: <li class="listitem"><p><a href="https://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   2404:       Up-to-date replacement for
1.76      rillig   2405:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2406:       systems where pkg_install is not present.</p></li>
                   2407: </ul></div>
                   2408: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2409: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2410: <li class="listitem"><p><a href="https://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   2411:       Create a binary package from an
1.110     hubertf  2412:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2413:       save the old package.</p></li>
1.250     leot     2414: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   2415:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2416:       from multiple locations. It currently supports the following
                   2417:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.250     leot     2418: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117     jnemeth  2419:       the best compiler flags to optimise code for your current
1.128     wiz      2420:       CPU and compiler. </p></li>
1.75      rillig   2421: </ul></div>
                   2422: <p>Utilities for keeping track of installed packages, being up to date,
                   2423: etc:</p>
1.148     asau     2424: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2425: <li class="listitem"><p><a href="https://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      2426:     update tool similar to apt(1). Download, install, and upgrade
                   2427:     binary packages easily.</p></li>
1.250     leot     2428: <li class="listitem"><p><a href="https://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   2429:       packages whose installed versions do not match the latest pkgsrc
                   2430:       entries.</p></li>
1.250     leot     2431: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   2432:       dependency graphs of packages, to aid in choosing a strategy for
                   2433:       updating.</p></li>
1.250     leot     2434: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   2435:       graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   2436: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   2437:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.250     leot     2438: <li class="listitem"><p><a href="https://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   2439:       does various checks on the complete pkgsrc system.</p></li>
1.250     leot     2440: <li class="listitem"><p><a href="https://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   2441:       packages you have installed.</p></li>
                   2442: </ul></div>
                   2443: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2444: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2445: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   2446:       making and maintaining patches for a package (includes pkgdiff,
                   2447:       pkgvi, mkpatches, etc.).</p></li>
1.250     leot     2448: <li class="listitem"><p><a href="https://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   2449:       converting to pkgsrc.</p></li>
                   2450: </ul></div>
                   2451: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2452: utilities)</p>
1.148     asau     2453: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2454: <li class="listitem"><p><a href="https://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   2455:       packages in a chrooted area.</p></li>
1.250     leot     2456: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   2457:       kernel version for chrooted cross builds.</p></li>
                   2458: </ul></div>
                   2459: </div>
1.148     asau     2460: <div class="sect1">
1.75      rillig   2461: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2462: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2463: <p>To install packages from source as a non-root user, download
                   2464: 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
                   2465: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2466: --unprivileged</strong></span>.</p>
                   2467: <p>This will install the binary part of pkgsrc to
                   2468: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2469: into <code class="filename">~/pkg/etc</code>.</p>
                   2470: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2471: </div>
1.148     asau     2472: <div class="sect1">
1.75      rillig   2473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2474: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2475: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2476: enable this feature by adding the option
                   2477: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2478: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2479: distfile is found, pkgsrc will try to resume it.</p>
                   2480: <p>You can also
1.168     wiz      2481: use a different program than the platform default program by changing the
1.117     jnemeth  2482: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2483: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2484: by using the value manual.  A value of custom disables the system defaults
                   2485: and dependency tracking for the fetch program.  In that case you have to
                   2486: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2487: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2488: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2489: <p>For example, if you want to use
1.117     jnemeth  2490: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2491: like:</p>
                   2492: <pre class="programlisting">
1.223     rillig   2493: FETCH_USING=    wget
1.1       grant    2494: </pre>
1.75      rillig   2495: </div>
1.148     asau     2496: <div class="sect1">
1.75      rillig   2497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2498: <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      2499: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   2500: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   2501: you will have to add the following line into
1.110     hubertf  2502: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   2503: <pre class="programlisting">
1.103     wiz      2504: X11_TYPE=modular
1.1       grant    2505: </pre>
1.75      rillig   2506: </div>
1.148     asau     2507: <div class="sect1">
1.75      rillig   2508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2509: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   2510: <p>If you are sitting behind a firewall which does not allow direct
                   2511: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2512: relevant proxy hosts.  This is done using an environment variable in the
                   2513: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      2514: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   2515: port 80 as the proxy port number.  So the proxy environment variables
                   2516: are:</p>
                   2517: <pre class="programlisting">
1.100     rillig   2518: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2519: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    2520: </pre>
1.75      rillig   2521: </div>
1.148     asau     2522: <div class="sect1">
1.75      rillig   2523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2524: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      2525: <p>Some fetch tools are not prepared to support HTTPS by default
                   2526: (for example, the one in NetBSD 6.0), or the one installed by the
                   2527: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2528: dependency graph).</p>
                   2529: <p>Usually you won't notice, because distribution files are
                   2530: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2531: be often enough if you are following pkgsrc-current. In that case, set
                   2532: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2533: <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
                   2534: with HTTPS support by default. Of course, these tools need to be
                   2535: installed before you can use them this way.</p>
                   2536: </div>
                   2537: <div class="sect1">
                   2538: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2539: <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   2540: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   2541: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   2542: the first available command from the following list:</p>
1.148     asau     2543: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2544: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2545: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   2546: </ul></div>
                   2547: <p>On a default NetBSD installation, this will be
1.76      rillig   2548: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   2549: connections first, and falls back to active connections if the server
                   2550: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  2551: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   2552: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2553: <p>Having that option present will prevent
1.76      rillig   2554: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   2555: transfers.</p>
                   2556: </div>
1.148     asau     2557: <div class="sect1">
1.75      rillig   2558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2559: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      2560: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  2561: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      2562: 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   2563: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  2564: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   2565: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   2566: resulting list to your machine at work/school and use it there.  If you
1.257     leot     2567: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   2568: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2569: URL:</p>
                   2570: <p>At home:</p>
                   2571: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2572: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2573: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2574: <p>At work:</p>
                   2575: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   2576: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   2577: home.</p>
                   2578: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      2579: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2580: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  2581: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      2582: directly by running:</p>
1.75      rillig   2583: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2584: <p>If you even decide to ignore
                   2585: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2586: by running:</p>
                   2587: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2588: </div>
1.148     asau     2589: <div class="sect1">
1.75      rillig   2590: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2591: <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      2592: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.250     leot     2593: <p>When compiling the <a href="https://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   2594: package, you get the error from make that it doesn't know how to make
1.76      rillig   2595: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      2596: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   2597: the NetBSD base distribution on your machine.  It is recommended to do
                   2598: that to format man pages.</p>
1.250     leot     2599: <p>In the case of the <a href="https://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   2600: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  2601: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   2602: </div>
1.148     asau     2603: <div class="sect1">
1.75      rillig   2604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2605: <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      2606: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   2607: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   2608: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   2609: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2610: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   2611: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  2612: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   2613: -r</strong></span>).</p>
                   2614: </div>
1.148     asau     2615: <div class="sect1">
1.75      rillig   2616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2617: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   2618: <p>When installing packages as non-root user and using the just-in-time
1.257     leot     2619: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-8.0"><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   2620: password for each required package installed.  To avoid this, the sudo
                   2621: package can be used, which does password caching over a limited time.  To
                   2622: use it, install sudo (either as binary package or from
1.250     leot     2623: <a href="https://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  2624: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      2625: <span class="emphasis"><em>after</em></span> the definition of the
                   2626: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   2627: <pre class="programlisting">
1.100     rillig   2628: .if exists(${LOCALBASE}/bin/sudo)
                   2629: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2630: .endif
1.1       grant    2631: </pre>
1.75      rillig   2632: </div>
1.148     asau     2633: <div class="sect1">
1.75      rillig   2634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2635: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   2636: <p>As the system administrator, you can choose where configuration files
                   2637: are installed.  The default settings make all these files go into
1.76      rillig   2638: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   2639: be suboptimal depending on your expectations (e.g., a read-only,
                   2640: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   2641: configuration of the provided packages).</p>
                   2642: <p>In order to change the defaults, you can modify the
                   2643: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  2644: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   2645: directory; some common examples include <code class="filename">/etc</code> or
                   2646: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   2647: <p>Furthermore, you can change this value on a per-package basis by
                   2648: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   2649: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   2650: package you would like to modify, that is, the contents of
                   2651: <code class="varname">PKGBASE</code>.</p>
                   2652: <p>Note that after changing these settings, you must rebuild and
                   2653: reinstall any affected packages.</p>
                   2654: </div>
1.148     asau     2655: <div class="sect1">
1.75      rillig   2656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2657: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75      rillig   2658: <p>Please be aware that there can often be bugs in third-party software,
                   2659: and some of these bugs can leave a machine vulnerable to exploitation by
                   2660: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   2661: maintains a database of known-exploits to packages which have at one time
                   2662: been included in pkgsrc.  The database can be downloaded automatically, and
                   2663: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 2664: do this, refer to the following two tools (installed as part of the
1.250     leot     2665: <a href="https://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      2666: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2667: <li class="listitem">
1.122     reed     2668: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   2669:     download a list of the security vulnerabilities information.  This list
1.132     spz      2670:     is kept up to date by the pkgsrc security team, and is distributed
                   2671:     from the NetBSD ftp server:</p>
                   2672: <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   2673: </li>
1.128     wiz      2674: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   2675:     current machine, checking each known vulnerability.  If a
1.75      rillig   2676:     vulnerable package is installed, it will be shown by output to stdout,
                   2677:     including a description of the type of vulnerability, and a URL
                   2678:     containing more information.</p></li>
                   2679: </ol></div>
1.233     sevan    2680: <p>Use of these tools is strongly recommended!
                   2681: 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
                   2682: reporting.</p>
                   2683: <p>If this database is installed, pkgsrc builds will use it to
                   2684: perform a security check before building any package.</p>
1.75      rillig   2685: </div>
1.148     asau     2686: <div class="sect1">
1.75      rillig   2687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2688: <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   2689: <p>When you add your own preferences to the
                   2690:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  2691:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   2692:        environment variables to the <code class="filename">./configure</code>
1.257     leot     2693:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   2694:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   2695:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   2696:        package.</p>
                   2697: <p>Currently there is no solution to this problem. If you
                   2698:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  2699:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   2700:        directory and then inspect any <code class="filename">Makefile</code> and
                   2701:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   2702:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      2703:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   2704:        programmers write so bad code that it only works for the
                   2705:        specific combination of <code class="varname">CFLAGS</code> they have
                   2706:        chosen.</p>
                   2707: </div>
1.148     asau     2708: <div class="sect1">
1.80      rillig   2709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2710: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      2711: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     2712: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   2713:        case that occurs often is that people only update pkgsrc in
                   2714:        parts, because of performance reasons. Since pkgsrc is one large
                   2715:        system, not a collection of many small systems, there are
                   2716:        sometimes changes that only work when the whole pkgsrc tree is
                   2717:        updated.</p></li>
1.148     asau     2718: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      2719:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   2720:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   2721:        files.</p></li>
1.148     asau     2722: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  2723:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   2724:        verify this.</p></li>
1.218     rillig   2725: <li class="step"><p>If you are a package developer who wants to invest
                   2726:        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     2727: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   2728:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   2729: </ol></div>
                   2730: </div>
1.148     asau     2731: <div class="sect1">
1.88      wiz      2732: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2733: <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   2734: <p>You have modified a file from pkgsrc, and someone else has
                   2735: modified that same file afterwards in the CVS repository. Both changes
                   2736: are in the same region of the file, so when you updated pkgsrc, the
                   2737: <code class="literal">cvs</code> command marked the conflicting changes in the
                   2738: file. Because of these markers, the file is no longer a valid
                   2739: <code class="filename">Makefile</code>.</p>
                   2740: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  2741: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   2742: -dP</strong></span> in that directory to download the current version.</p>
                   2743: </div>
1.75      rillig   2744: </div>
                   2745: </div>
1.148     asau     2746: <div class="part">
1.75      rillig   2747: <div class="titlepage"><div><div><h1 class="title">
                   2748: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     2749: <div class="partintro">
1.77      rillig   2750: <div></div>
                   2751: <p>This part of the book deals with creating and
1.128     wiz      2752:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   2753:        guide on creating a new package. The remaining chapters are more
                   2754:        like a reference manual for pkgsrc.</p>
1.75      rillig   2755: <div class="toc">
                   2756: <p><b>Table of Contents</b></p>
1.210     leot     2757: <dl class="toc">
1.106     rillig   2758: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   2759: <dd><dl>
1.106     rillig   2760: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   2761: <dd><dl>
1.106     rillig   2762: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.245     wiz      2763: <dt><span class="sect2"><a href="#creating.python-module">10.1.2. Python modules and programs</a></span></dt>
1.91      rillig   2764: </dl></dd>
1.106     rillig   2765: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   2766: <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>
                   2767: </dl></dd>
                   2768: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   2769: <dd><dl>
1.128     wiz      2770: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   2771: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219     rillig   2772: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig   2773: <dd><dl>
                   2774: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   2775: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   2776: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   2777: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   2778: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   2779: </dl></dd>
                   2780: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   2781: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   2782: <dd><dl>
                   2783: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   2784: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   2785: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   2786: </dl></dd>
1.128     wiz      2787: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   2788: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   2789: </dl></dd>
1.128     wiz      2790: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   2791: <dd><dl>
                   2792: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      2793: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   2794: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   2795: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   2796: <dd><dl>
                   2797: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228     yyamano  2798: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220     wiz      2799: <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>
                   2800: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig   2801: </dl></dd>
                   2802: </dl></dd>
                   2803: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   2804: <dd><dl>
                   2805: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      2806: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   2807: <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   2808: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   2809: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      2810: <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   2811: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz      2812: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   2813: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106     rillig   2814: </dl></dd>
                   2815: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   2816: <dd><dl>
                   2817: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      2818: <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   2819: <dd><dl>
                   2820: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      2821: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   2822:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2823:       and
                   2824:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2825:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   2826: </dl></dd>
1.128     wiz      2827: <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   2828: <dd><dl>
1.128     wiz      2829: <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   2830: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   2831: </dl></dd>
                   2832: </dl></dd>
                   2833: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   2834: <dd><dl>
                   2835: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   2836: <dd><dl>
                   2837: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   2838: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   2839: </dl></dd>
                   2840: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   2841: <dd><dl>
1.128     wiz      2842: <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   2843: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   2844: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   2845: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   2846: </dl></dd>
                   2847: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   2848: <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>
                   2849: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   2850: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   2851: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   2852: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   2853: <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>
                   2854: </dl></dd>
                   2855: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   2856: <dd><dl>
                   2857: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      2858: <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   2859: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   2860: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   2861: </dl></dd>
                   2862: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   2863: <dd><dl>
                   2864: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   2865: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   2866: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   2867: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      2868: <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   2869: <dd><dl>
                   2870: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   2871: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   2872: </dl></dd>
1.128     wiz      2873: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   2874: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   2875: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   2876: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   2877: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   2878: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2879: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2880: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   2881: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2882: <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   2883: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   2884: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   2885: </dl></dd>
                   2886: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   2887: <dd><dl>
                   2888: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   2889: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   2890: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   2891: </dl></dd>
                   2892: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   2893: <dd><dl>
                   2894: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   2895: <dd><dl>
1.218     rillig   2896: <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>
                   2897: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                   2898: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                   2899: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                   2900: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                   2901: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                   2902: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                   2903: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   2904: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                   2905: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   2906: <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   2907: </dl></dd>
1.218     rillig   2908: <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   2909: <dd><dl>
                   2910: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   2911: <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      2912: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig   2913: </dl></dd>
1.218     rillig   2914: <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   2915: <dd><dl>
                   2916: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   2917: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   2918: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   2919: </dl></dd>
                   2920: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   2921: <dd><dl>
                   2922: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   2923: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   2924: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      2925: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   2926: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   2927: </dl></dd>
1.218     rillig   2928: <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   2929: <dd><dl>
                   2930: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   2931: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      2932: <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   2933: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   2934: </dl></dd>
1.218     rillig   2935: <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   2936: <dd><dl>
                   2937: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   2938: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   2939: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   2940: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   2941: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   2942: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   2943: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   2944: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   2945: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   2946: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   2947: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   2948: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   2949: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   2950: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   2951: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   2952: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   2953: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   2954: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      2955:     emulation</a></span></dt>
1.106     rillig   2956: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   2957: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   2958: </dl></dd>
1.106     rillig   2959: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   2960: </dl></dd>
1.106     rillig   2961: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   2962: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   2963: <dd><dl>
1.106     rillig   2964: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   2965: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   2966: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.243     wiz      2967: <dt><span class="sect1"><a href="#commit-messages">21.4. Commit Messages</a></span></dt>
                   2968: <dt><span class="sect1"><a href="#committing-importing">21.5. Committing: Adding a package to CVS</a></span></dt>
                   2969: <dt><span class="sect1"><a href="#updating-package">21.6. Updating a package to a newer version</a></span></dt>
                   2970: <dt><span class="sect1"><a href="#renaming-package">21.7. Renaming a package in pkgsrc</a></span></dt>
                   2971: <dt><span class="sect1"><a href="#moving-package">21.8. Moving a package in pkgsrc</a></span></dt>
1.106     rillig   2972: </dl></dd>
                   2973: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   2974: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   2975: <dd><dl>
                   2976: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   2977: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   2978: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   2979: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     2980: </dl></dd>
1.75      rillig   2981: </dl>
                   2982: </div>
1.77      rillig   2983: </div>
1.148     asau     2984: <div class="chapter">
1.77      rillig   2985: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2986: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   2987: <div class="toc">
                   2988: <p><b>Table of Contents</b></p>
1.210     leot     2989: <dl class="toc">
1.106     rillig   2990: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   2991: <dd><dl>
1.106     rillig   2992: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.245     wiz      2993: <dt><span class="sect2"><a href="#creating.python-module">10.1.2. Python modules and programs</a></span></dt>
1.91      rillig   2994: </dl></dd>
1.106     rillig   2995: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   2996: <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   2997: </dl>
                   2998: </div>
1.77      rillig   2999: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3000: most likely have a URL from where you can download the source
                   3001: code. Starting with this URL, creating a package involves only a
                   3002: few steps.</p>
1.128     wiz      3003: <div class="procedure"><ol class="procedure" type="1">
1.250     leot     3004: <li class="step"><p>First, install the packages <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="https://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     3005: <li class="step"><p>Then, choose one of the top-level directories as the
1.91      rillig   3006: category in which you want to place your package. You can also create a
                   3007: directory of your own (maybe called <code class="filename">local</code>). In that
                   3008: category directory, create another directory for your package and change
                   3009: into it.</p></li>
1.148     asau     3010: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3011: you for a URL. Enter the URL of the distribution file (in most cases a
                   3012: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3013: of your package are created automatically. The distribution file is
                   3014: extracted automatically to fill in some details in the
                   3015: <code class="filename">Makefile</code> that would otherwise have to be done
                   3016: manually.</p></li>
1.148     asau     3017: <li class="step">
1.91      rillig   3018: <p>Examine the extracted files to determine the dependencies of
                   3019: your package. Ideally, this is mentioned in some
                   3020: <code class="filename">README</code> file, but things may differ. For each of
                   3021: these dependencies, look where it exists in pkgsrc, and if there is a
                   3022: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3023: line to your package <code class="filename">Makefile</code> which includes that
                   3024: file just before the last line. If the
1.132     spz      3025: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3026: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3027: <p>If you just need binaries from a package, add a
1.91      rillig   3028: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3029: version of the dependency and where it can be found in pkgsrc. This line
                   3030: should be placed in the third paragraph. If the dependency is only
                   3031: needed for building the package, but not when using it, use
                   3032: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3033: Your package may then look like this:</p>
1.77      rillig   3034: <pre class="programlisting">
1.100     rillig   3035: [...]
1.77      rillig   3036: 
1.174     asau     3037: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100     rillig   3038: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3039: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3040: 
1.100     rillig   3041: [...]
1.77      rillig   3042: 
1.100     rillig   3043: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3044: .include "../../devel/glib2/buildlink3.mk"
                   3045: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3046: </pre>
                   3047: </li>
1.148     asau     3048: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128     wiz      3049: 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  3050: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3051: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3052: -e</strong></span>, which outputs additional
                   3053: explanations.</p></li>
1.148     asau     3054: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  3055: 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   3056: over there, you can hopefully continue here.</p></li>
1.148     asau     3057: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3058: directory from the extracted files. Besides these files, a lot of cache
                   3059: files and other system information has been saved in the working
                   3060: directory, which may become wrong after you edited the
                   3061: <code class="filename">Makefile</code>.</p></li>
1.148     asau     3062: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110     hubertf  3063: 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     3064: <li class="step"><p>When the package builds fine, the next step is to install
1.110     hubertf  3065: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3066: everything works.</p></li>
1.148     asau     3067: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91      rillig   3068: contains a list of the files that are installed by the package, is
1.110     hubertf  3069: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3070: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3071: the file using your preferred text editor to see if the list of
                   3072: files looks plausible.</p></li>
1.148     asau     3073: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3074: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148     asau     3075: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3076: has been registered in the database of installed files, but with an
1.110     hubertf  3077: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3078: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3079: registered with the list of files from
                   3080: <code class="filename">PLIST</code>.</p></li>
1.148     asau     3081: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3082: package from the set of installed files.</p></li>
1.77      rillig   3083: </ol></div>
1.148     asau     3084: <div class="sect1">
1.91      rillig   3085: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3086: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148     asau     3087: <div class="sect2">
1.91      rillig   3088: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3089: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   3090: <p>Simple Perl modules are handled automatically by
1.110     hubertf  3091: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   3092: </div>
1.148     asau     3093: <div class="sect2">
1.91      rillig   3094: <div class="titlepage"><div><div><h3 class="title">
1.245     wiz      3095: <a name="creating.python-module"></a>10.1.2. Python modules and programs</h3></div></div></div>
1.118     imil     3096: <p>Python modules and programs packages are easily created using a
                   3097: set of predefined variables.</p>
                   3098: <p>
1.171     wiz      3099: If some Python versions are not supported by the software, set the
                   3100: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   3101: that are not supported, e.g.
1.118     imil     3102: </p>
                   3103: <pre class="programlisting">
1.203     sevan    3104: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.118     imil     3105: </pre>
                   3106: <p>
1.213     wiz      3107: If the packaged software is a Python module, include one of
                   3108: <code class="filename">../../lang/python/egg.mk</code>,
                   3109: <code class="filename">../../lang/python/distutils.mk</code>, or
                   3110: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   3111: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3112: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3113: if the packaged software is using setuptools, you only need
                   3114: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   3115: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   3116: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>.
                   3117: so pkgsrc will use this framework.
                   3118: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3119: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   3120: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3121: to the name of the script.</p>
                   3122: <p>Either way, the package directory should be called
1.128     wiz      3123: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3124: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.118     imil     3125: </p>
                   3126: <pre class="programlisting">
                   3127: DISTNAME=   foopymodule-1.2.10
                   3128: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3129: </pre>
1.171     wiz      3130: <p>If it is an application, include
                   3131: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   3132: In order to correctly set the path to the Python interpreter, use the
1.118     imil     3133: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142     wiz      3134: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171     wiz      3135: For example:
1.118     imil     3136: </p>
                   3137: <pre class="programlisting">
1.142     wiz      3138: REPLACE_PYTHON=   *.py
1.118     imil     3139: </pre>
1.171     wiz      3140: <p>Some Python modules have separate distributions for Python-2.x
                   3141: and Python-3.x support. In pkgsrc this is handled by the
                   3142: <code class="filename">versioned_dependencies.mk</code> file. Set
                   3143: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   3144: packages that should be depended upon and include
                   3145: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   3146: then the pkgsrc infrastructure will depend on the appropriate package
                   3147: version. For example:
                   3148: </p>
                   3149: <pre class="programlisting">
1.248     wiz      3150: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.171     wiz      3151: </pre>
                   3152: <p>
                   3153: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   3154: of supported packages.</p>
1.118     imil     3155: </div>
1.91      rillig   3156: </div>
1.148     asau     3157: <div class="sect1">
1.91      rillig   3158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3159: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148     asau     3160: <div class="sect2">
1.91      rillig   3161: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3162: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148     asau     3163: <div class="sect3">
1.91      rillig   3164: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3165: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   3166: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128     wiz      3167: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.91      rillig   3168: pkgsrc. As the description says it has to do with the web, the obvious
1.128     wiz      3169: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.91      rillig   3170: <pre class="programlisting">
1.100     rillig   3171: <code class="prompt">$</code> mkdir www/nvu
                   3172: <code class="prompt">$</code> cd www/nvu
1.91      rillig   3173: </pre>
                   3174: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  3175: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   3176: <pre class="programlisting">
1.100     rillig   3177: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   3178: </pre>
                   3179: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3180: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128     wiz      3181: 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   3182: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3183: <code class="varname">COMMENT</code> fields. Then the package
                   3184: <code class="filename">Makefile</code> looked like that:</p>
                   3185: <pre class="programlisting">
1.233     sevan    3186: # $NetBSD $
1.100     rillig   3187: #
1.91      rillig   3188: 
1.100     rillig   3189: DISTNAME=       nvu-1.0-sources
                   3190: PKGNAME=        nvu-1.0
                   3191: CATEGORIES=     www
                   3192: MASTER_SITES=   http://cvs.nvu.com/download/
                   3193: EXTRACT_SUFX=   .tar.bz2
                   3194: 
                   3195: MAINTAINER=     rillig@NetBSD.org
                   3196: HOMEPAGE=       http://cvs.nvu.com/
                   3197: COMMENT=        Web Authoring System
1.91      rillig   3198: 
1.100     rillig   3199: # url2pkg-marker (please do not remove this line.)
                   3200: .include "../../mk/bsd.pkg.mk"
1.91      rillig   3201: </pre>
1.237     wiz      3202: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.233     sevan    3203: this is a workaround to prevent CVS expanding to the filename of the
                   3204: guide.</p>
1.91      rillig   3205: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3206: source archive:</p>
                   3207: <pre class="programlisting">
1.100     rillig   3208: url2pkg&gt; Running "make makesum" ...
                   3209: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3210: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3211: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3212: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3213: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3214: url2pkg&gt; Running "make extract" ...
                   3215: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3216: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3217: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3218: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3219: ===&gt; Installing dependencies for nvu-1.0
                   3220: ===&gt; Overriding tools for nvu-1.0
                   3221: ===&gt; Extracting for nvu-1.0
                   3222: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   3223: 
1.100     rillig   3224: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   3225: 
1.100     rillig   3226: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   3227: </pre>
                   3228: </div>
1.148     asau     3229: <div class="sect3">
1.91      rillig   3230: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3231: <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   3232: <p>Now that the package has been extracted, let's see what's inside
                   3233: it. The package has a <code class="filename">README.txt</code>, but that only
                   3234: says something about mozilla, so it's probably useless for seeing what
                   3235: dependencies this package has. But since there is a GNU configure script
                   3236: in the package, let's hope that it will complain about everything it
                   3237: needs.</p>
                   3238: <pre class="programlisting">
1.100     rillig   3239: <code class="prompt">$</code> bmake
                   3240: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3241: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3242: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3243: ===&gt; Patching for nvu-1.0
                   3244: ===&gt; Creating toolchain wrappers for nvu-1.0
                   3245: ===&gt; Configuring for nvu-1.0
                   3246: [...]
                   3247: configure: error: Perl 5.004 or higher is required.
                   3248: [...]
                   3249: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3250: [...]
1.91      rillig   3251: </pre>
                   3252: <p>That worked quite well. So I opened the package Makefile in my
                   3253: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128     wiz      3254: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.91      rillig   3255: package have changed now, and since a perl wrapper is automatically
1.128     wiz      3256: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.91      rillig   3257: from scratch.</p>
                   3258: <pre class="programlisting">
1.100     rillig   3259: <code class="prompt">$</code> bmake clean
                   3260: ===&gt; Cleaning for nvu-1.0
                   3261: <code class="prompt">$</code> bmake
                   3262: [...]
                   3263: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   3264: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   3265: [...]
1.91      rillig   3266: </pre>
1.128     wiz      3267: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.91      rillig   3268: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   3269: <pre class="programlisting">
1.100     rillig   3270: [...]
                   3271: checking for GTK - version &gt;= 1.2.0... no
                   3272: *** Could not run GTK test program, checking why...
                   3273: [...]
1.91      rillig   3274: </pre>
                   3275: <p>Now to the other dependencies. The first question is: Where is the
                   3276: GTK package hidden in pkgsrc?</p>
                   3277: <pre class="programlisting">
1.100     rillig   3278: <code class="prompt">$</code> echo ../../*/gtk*
                   3279: [many packages ...]
                   3280: <code class="prompt">$</code> echo ../../*/gtk
                   3281: ../../x11/gtk
                   3282: <code class="prompt">$</code> echo ../../*/gtk2
                   3283: ../../x11/gtk2
                   3284: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   3285: ../../x11/gtk2/buildlink3.mk
1.91      rillig   3286: </pre>
                   3287: <p>The first try was definitely too broad. The second one had exactly
                   3288: one result, which is very good. But there is one pitfall with GNOME
                   3289: packages. Before GNOME 2 had been released, there were already many
                   3290: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   3291: packages, the GNOME 2 packages were imported as separate packages, and
1.128     wiz      3292: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.91      rillig   3293: whether this was the case here, and indeed it was.</p>
                   3294: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   3295: file, adding the dependency is very easy. I just inserted an
                   3296: <code class="literal">.include</code> line before the last line of the package
                   3297: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   3298: <pre class="programlisting">
1.100     rillig   3299: [...]
                   3300: .include "../../x11/gtk2/buildlink3.mk"
                   3301: .include "../../mk/bsd.pkg.mk
1.91      rillig   3302: </pre>
1.110     hubertf  3303: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   3304: was:</p>
                   3305: <pre class="programlisting">
1.100     rillig   3306: [...]
                   3307: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   3308: checking for GTK - version &gt;= 1.2.0... no
                   3309: *** Could not run GTK test program, checking why...
                   3310: *** The test program failed to compile or link. See the file config.log for the
                   3311: *** exact error that occured. This usually means GTK was incorrectly installed
                   3312: *** or that you have moved GTK since it was installed. In the latter case, you
                   3313: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   3314: configure: error: Test for GTK failed.
                   3315: [...]
1.91      rillig   3316: </pre>
1.128     wiz      3317: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   3318: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.91      rillig   3319: told me that this package really wanted to have the GNOME 1 version of
                   3320: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  3321: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   3322: So I changed the <code class="literal">x11/gtk2</code> to
                   3323: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   3324: and tried again.</p>
                   3325: <pre class="programlisting">
1.100     rillig   3326: [...]
1.166     jnemeth  3327: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
1.100     rillig   3328: In file included from xpidl.c:42:
                   3329: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   3330: In file included from xpidl.c:42:
                   3331: xpidl.h:132: error: parse error before "IDL_ns"
                   3332: [...]
1.91      rillig   3333: </pre>
                   3334: <p>The package still does not find all of its dependencies. Now the
                   3335: question is: Which package provides the
                   3336: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   3337: <pre class="programlisting">
1.100     rillig   3338: <code class="prompt">$</code> echo ../../*/*idl*
                   3339: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   3340: <code class="prompt">$</code> echo ../../*/*IDL*
                   3341: ../../net/libIDL
1.91      rillig   3342: </pre>
                   3343: <p>Let's take the one from the second try. So I included the
                   3344: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   3345: again. But the error didn't change. After digging through some of the
                   3346: code, I concluded that the build process of the package was broken and
                   3347: couldn't have ever worked, but since the Mozilla source tree is quite
                   3348: large, I didn't want to fix it. So I added the following to the package
                   3349: <code class="filename">Makefile</code> and tried again:</p>
                   3350: <pre class="programlisting">
1.100     rillig   3351: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.252     leot     3352: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.91      rillig   3353: </pre>
                   3354: <p>The latter line is needed because the package expects the library
                   3355: <code class="filename">libIDL.so</code>, but only
                   3356: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   3357: wrapper to rewrite that on the fly.</p>
                   3358: <p>The next problem was related to a recent change of the FreeType
1.250     leot     3359: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.91      rillig   3360: which patch files were relevant for this issue and copied them to the
                   3361: <code class="filename">patches</code> directory. Then I retried, fixed the
                   3362: patches so that they applied cleanly and retried again. This time,
                   3363: everything worked.</p>
                   3364: </div>
1.148     asau     3365: <div class="sect3">
1.91      rillig   3366: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3367: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   3368: <pre class="programlisting">
1.100     rillig   3369: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   3370: [...]
                   3371: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   3372: <code class="prompt">$</code> bmake deinstall
                   3373: <code class="prompt">$</code> bmake install
1.91      rillig   3374: </pre>
                   3375: </div>
                   3376: </div>
                   3377: </div>
1.77      rillig   3378: </div>
1.148     asau     3379: <div class="chapter">
1.75      rillig   3380: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3381: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   3382: <div class="toc">
                   3383: <p><b>Table of Contents</b></p>
1.210     leot     3384: <dl class="toc">
1.128     wiz      3385: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3386: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219     rillig   3387: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig   3388: <dd><dl>
                   3389: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3390: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3391: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3392: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3393: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3394: </dl></dd>
                   3395: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3396: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3397: <dd><dl>
                   3398: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3399: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3400: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   3401: </dl></dd>
1.128     wiz      3402: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3403: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   3404: </dl>
                   3405: </div>
1.87      wiz      3406: <p>Whenever you're preparing a package, there are a number of
                   3407: files involved which are described in the following
                   3408: sections.</p>
1.148     asau     3409: <div class="sect1">
1.75      rillig   3410: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3411: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93      rillig   3412: </h2></div></div></div>
1.75      rillig   3413: <p>Building, installation and creation of a binary package are all
1.87      wiz      3414:   controlled by the package's <code class="filename">Makefile</code>.
                   3415:   The <code class="filename">Makefile</code> describes various things about
                   3416:   a package, for example from where to get it, how to configure,
                   3417:   build, and install it.</p>
1.76      rillig   3418: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      3419:   sections that describe the package.</p>
1.75      rillig   3420: <p>In the first section there are the following variables, which
1.87      wiz      3421:   should appear exactly in the order given here.  The order and
                   3422:   grouping of the variables is mostly historical and has no further
                   3423:   meaning.</p>
1.148     asau     3424: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3425: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      3426:     distribution file to be downloaded from the package's
                   3427:     website.</p></li>
1.128     wiz      3428: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174     asau     3429:     package, as used by pkgsrc. You need to provide it if
1.87      wiz      3430:     <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174     asau     3431:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3432:     provided (no distribution file is required).  Usually it is the pkgsrc
1.87      wiz      3433:     directory name together with the version number. It must match the
                   3434:     regular expression
                   3435:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3436:     starts with a letter or digit, and contains only letters, digits,
                   3437:     dashes, underscores, dots and plus signs.</p></li>
1.128     wiz      3438: <li class="listitem">
1.75      rillig   3439: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      3440:     which the package fits in. You can choose any of the top-level
                   3441:     directories of pkgsrc for it.</p>
1.75      rillig   3442: <p>Currently the following values are available for
1.87      wiz      3443:     <code class="varname">CATEGORIES</code>. If more than
                   3444:     one is used, they need to be separated by spaces:</p>
1.75      rillig   3445: <pre class="programlisting">
1.100     rillig   3446: archivers     cross         geography     meta-pkgs     security
                   3447: audio         databases     graphics      misc          shells
                   3448: benchmarks    devel         ham           multimedia    sysutils
                   3449: biology       editors       inputmethod   net           textproc
                   3450: cad           emulators     lang          news          time
                   3451: chat          finance       mail          parallel      wm
                   3452: comms         fonts         math          pkgtools      www
                   3453: converters    games         mbone         print         x11
                   3454: </pre>
1.75      rillig   3455: </li>
1.128     wiz      3456: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      3457:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3458:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3459:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.128     wiz      3460:     <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   3461: </ul></div>
                   3462: <p>The second section contains information about separately
1.87      wiz      3463:   downloaded patches, if any.
                   3464:   </p>
1.148     asau     3465: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190     wiz      3466: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87      wiz      3467:     Name(s) of additional files that contain distribution patches.
                   3468:     There is no default. pkgsrc will look for them at
                   3469:     <code class="varname">PATCH_SITES</code>.
                   3470:     They will automatically be uncompressed before patching if
                   3471:     the names end with <code class="filename">.gz</code> or
                   3472:     <code class="filename">.Z</code>.</p></li>
1.128     wiz      3473: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      3474:     Primary location(s) for distribution patch files (see
1.190     wiz      3475:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3476: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.257     leot     3477:     an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.190     wiz      3478:     help find the correct files to patch. It defaults to
                   3479:     <span class="command"><strong>-p0</strong></span>.</p></li>
1.75      rillig   3480: </ul></div>
                   3481: <p>The third section contains the following variables.
1.87      wiz      3482:   </p>
1.148     asau     3483: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3484: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114     jmcneill 3485:     address of the person who feels responsible for this package,
                   3486:     and who is most likely to look at problems or questions regarding
1.257     leot     3487:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114     jmcneill 3488:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3489:     before making changes to the package, but are not required to
                   3490:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3491:     to yourself. If you really can't maintain the package for future
                   3492:     updates, set it to
1.110     hubertf  3493:     <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      3494: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114     jmcneill 3495:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3496:     developers to update or change the package without contacting
                   3497:     you first. A package Makefile should contain one of
                   3498:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3499:     not both.  </p></li>
1.128     wiz      3500: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      3501:     find more information about the package.</p></li>
1.128     wiz      3502: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      3503:     description of the package (should not include the package
                   3504:     name).</p></li>
1.234     leot     3505: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
                   3506:     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   3507: </ul></div>
                   3508: <p>Other variables that affect the build:
1.87      wiz      3509:   </p>
1.148     asau     3510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75      rillig   3511: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      3512:       interesting distribution files of the package are found. The
                   3513:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3514:       works for most packages.</p>
1.75      rillig   3515: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      3516:       (most GNU software does, for instance), but extracts itself in
                   3517:       the current directory, you should set
                   3518:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3519: <p>If a package doesn't create a subdirectory with the
                   3520:       name of <code class="varname">DISTNAME</code> but some different name,
                   3521:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3522:       <code class="filename">${WRKDIR}</code>, for example
                   3523:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.250     leot     3524:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://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   3525: <p>The name of the working directory created by pkgsrc is
1.87      wiz      3526:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3527:       variable. By default, its value is
                   3528:       <code class="filename">work</code>. If you want to use the same
                   3529:       pkgsrc tree for building different kinds of binary packages,
                   3530:       you can change the variable according to your needs. Two
                   3531:       other variables handle common cases of setting
                   3532:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3533:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  3534:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      3535:       the host's name is attached to the directory name. If
                   3536:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3537:       is attached, which might look like
                   3538:       <code class="filename">work.i386</code> or
                   3539:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   3540: </li></ul></div>
                   3541: <p>Please pay attention to the following gotchas:</p>
1.148     asau     3542: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3543: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      3544:       installed in compressed form by the package.  For packages using
                   3545:       BSD-style makefiles which honor MANZ, there is
                   3546:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128     wiz      3547: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3548:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.88      wiz      3549:       below).</p></li>
1.128     wiz      3550: <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   3551: </ul></div>
                   3552: </div>
1.148     asau     3553: <div class="sect1">
1.75      rillig   3554: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3555: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   3556: </h2></div></div></div>
1.76      rillig   3557: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      3558:   digest, or checksum, of each distfile needed for the package. This
                   3559:   ensures that the distfiles retrieved from the Internet have not been
                   3560:   corrupted during transfer or altered by a malign force to introduce
1.219     rillig   3561:   a security hole. To provide maximum security, all distfiles are
                   3562:   protected using three different message digest algorithms (SHA1,
                   3563:   RMD160, SHA512), as well as the file size.</p>
1.76      rillig   3564: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      3565:   checksums for all the patches found in the
1.258     leot     3566:   <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>). These checksums ensure that patches
                   3567:   are only applied intentionally and that they don't accidentally change,
                   3568:   e.g. when merging different changes together. They also make sure that
                   3569:   new patches are actually added to CVS and old ones are removed.
                   3570:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3571:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.76      rillig   3572: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.219     rillig   3573:   <span class="command"><strong>make distinfo</strong></span> command.</p>
1.75      rillig   3574: <p>Some packages have different sets of distfiles depending on
1.250     leot     3575:   the platform, for example <a href="https://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      3576:   <code class="filename">distinfo</code> file and care should be taken when
                   3577:   upgrading such a package to ensure distfile information is not
                   3578:   lost.</p>
1.75      rillig   3579: </div>
1.148     asau     3580: <div class="sect1">
1.75      rillig   3581: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219     rillig   3582: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
                   3583: </h2></div></div></div>
                   3584: <p>Some packages don't work out-of-the box on the various
                   3585:   platforms that are supported by pkgsrc. These packages need
                   3586:   to be patched to make them work. The patch files can be
1.93      rillig   3587:   found in the <code class="filename">patches/</code> directory.</p>
                   3588: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3589:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.219     rillig   3590:   extracting them, in alphabetic order.</p>
1.148     asau     3591: <div class="sect2">
1.93      rillig   3592: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3593: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   3594: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  3595:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   3596:   problems. (To force patches to apply with fuzz you can set
                   3597:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 3598:   should contain only changes for a single file, and no file should be
1.93      rillig   3599:   patched by more than one patch file. This helps to keep future
                   3600:   modifications simple.</p>
                   3601: <p>Each patch file is structured as follows: In the first line,
                   3602:   there is the RCS Id of the patch itself. The second line should be
                   3603:   empty for aesthetic reasons. After that, there should be a comment for
                   3604:   each change that the patch does. There are a number of standard
                   3605:   cases:</p>
1.148     asau     3606: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3607: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93      rillig   3608:   mention the vulnerability ID (CAN, CVE).</p></li>
1.128     wiz      3609: <li class="listitem"><p>Patches that change source code should mention the
1.93      rillig   3610:   platform and other environment (for example, the compiler) that the
                   3611:   patch is needed for.</p></li>
                   3612: </ul></div>
1.219     rillig   3613: <p>The patch should be commented so that any
1.93      rillig   3614:   developer who knows the code of the application can make some use of
                   3615:   the patch. Special care should be taken for the upstream developers,
                   3616:   since we generally want that they accept our patches, so we have less
                   3617:   work in the future.</p>
                   3618: </div>
1.148     asau     3619: <div class="sect2">
1.93      rillig   3620: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3621: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   3622: <p>One important thing to mention is to pay attention that no RCS
                   3623:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      3624:   later checked into the NetBSD CVS tree. Use the
1.250     leot     3625:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://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   3626:   problems.</p>
1.87      wiz      3627: <p>For even more automation, we recommend using
1.110     hubertf  3628:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      3629:   whole set of patches. You just have to backup files before you
                   3630:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  3631:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3632:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      3633:   you upgrade a package this way, you can easily compare the new
                   3634:   set of patches with the previously existing one with
1.130     wiz      3635:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3636:   are replaced by new files, so carefully check if you want to take all
                   3637:   the changes.</p>
1.87      wiz      3638: <p>When you have finished a package, remember to generate
1.110     hubertf  3639:   the checksums for the patch files by using the <span class="command"><strong>make
1.128     wiz      3640:   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      3641: <p>When adding a patch that corrects a problem in the
                   3642:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3643:   man pages should go), send the patch as a bug report to the
                   3644:   maintainer.  This benefits non-pkgsrc users of the package,
                   3645:   and usually makes it possible to remove the patch in future
                   3646:   version.</p>
1.101     rillig   3647: <p>The file names of the patch files are usually of the form
1.130     wiz      3648:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3649:   Many packages still use the previous convention
                   3650:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3651:   but new patches should be of the form containing the filename.
1.250     leot     3652:   <span class="command"><strong>mkpatches</strong></span> included in <a href="https://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      3653:   automatically.</p>
1.93      rillig   3654: </div>
1.148     asau     3655: <div class="sect2">
1.93      rillig   3656: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3657: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      3658: <p>If you want to share patches between multiple packages
                   3659:   in pkgsrc, e.g. because they use the same distfiles, set
                   3660:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3661:   can be found, e.g.:</p>
                   3662: <pre class="programlisting">
1.100     rillig   3663: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   3664: </pre>
1.75      rillig   3665: <p>Patch files that are distributed by the author or other
1.87      wiz      3666:     maintainers can be listed in
                   3667:     <code class="varname">PATCHFILES</code>.</p>
                   3668: <p>If it is desired to store any patches that should not be
                   3669:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3670:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3671:     directory tree there is expected to have the same
1.128     wiz      3672:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.87      wiz      3673:     patches are expected to be stored inside these dirs (also
                   3674:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3675:     example, if you want to keep a private patch for
                   3676:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3677:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3678:     files in the named directory are expected to be patch files,
                   3679:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3680:     applied</em></span>.</p>
1.93      rillig   3681: </div>
1.148     asau     3682: <div class="sect2">
1.85      jmmv     3683: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3684: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     3685: <p>When fixing a portability issue in the code do not use
                   3686:       preprocessor magic to check for the current operating system nor
                   3687:       platform.  Doing so hurts portability to other platforms because
                   3688:       the OS-specific details are not abstracted appropriately.</p>
                   3689: <p>The general rule to follow is: instead of checking for the
                   3690:       operating system the application is being built on, check for the
                   3691:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3692:       instead of assuming that kqueue is available under NetBSD and
                   3693:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126     jakllsch 3694:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     3695:       yes, this generally involves patching the
1.110     hubertf  3696:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     3697:       that prevents some OSes from adopting interfaces from other OSes
                   3698:       (e.g. Linux implementing kqueue), something that the above checks
                   3699:       cannot take into account.</p>
                   3700: <p>Of course, checking for features generally involves more
                   3701:       work on the developer's side, but the resulting changes are
1.87      wiz      3702:       cleaner and there are chances they will work on many other
1.85      jmmv     3703:       platforms.  Not to mention that there are higher chances of being
                   3704:       later integrated into the mainstream sources.  Remember:
                   3705:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3706: <p>Some typical examples:</p>
                   3707: <div class="table">
1.106     rillig   3708: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.216     tnn      3709: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.85      jmmv     3710: <colgroup>
                   3711: <col>
                   3712: <col>
                   3713: <col>
                   3714: </colgroup>
                   3715: <thead><tr>
                   3716: <th>Where</th>
                   3717: <th>Incorrect</th>
                   3718: <th>Correct</th>
                   3719: </tr></thead>
                   3720: <tbody>
                   3721: <tr>
                   3722: <td>configure script</td>
                   3723: <td>
1.100     rillig   3724: <pre class="programlisting">
                   3725: case ${target_os} in
                   3726: netbsd*) have_kvm=yes ;;
                   3727: *)       have_kvm=no  ;;
                   3728: esac
                   3729: </pre>
1.85      jmmv     3730:              </td>
                   3731: <td>
1.100     rillig   3732: <pre class="programlisting">
                   3733: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   3734: </pre>
1.85      jmmv     3735:              </td>
                   3736: </tr>
                   3737: <tr>
                   3738: <td>C source file</td>
                   3739: <td>
1.100     rillig   3740: <pre class="programlisting">
                   3741: #if defined(__NetBSD__)
                   3742: #  include &lt;sys/event.h&gt;
                   3743: #endif
                   3744: </pre>
1.85      jmmv     3745:              </td>
                   3746: <td>
1.100     rillig   3747: <pre class="programlisting">
                   3748: #if defined(HAVE_SYS_EVENT_H)
                   3749: #  include &lt;sys/event.h&gt;
                   3750: #endif
                   3751: </pre>
1.85      jmmv     3752:              </td>
                   3753: </tr>
                   3754: <tr>
                   3755: <td>C source file</td>
                   3756: <td>
1.100     rillig   3757: <pre class="programlisting">
                   3758: int
                   3759: monitor_file(...)
                   3760: {
                   3761: #if defined(__NetBSD__)
                   3762:         int fd = kqueue();
                   3763:         ...
                   3764: #else
                   3765:         ...
                   3766: #endif
                   3767: }
                   3768: </pre>
1.85      jmmv     3769:              </td>
                   3770: <td>
1.100     rillig   3771: <pre class="programlisting">
                   3772: int
                   3773: monitor_file(...)
                   3774: {
                   3775: #if defined(HAVE_KQUEUE)
                   3776:         int fd = kqueue();
                   3777:         ...
                   3778: #else
1.223     rillig   3779:         ...
1.100     rillig   3780: #endif
                   3781: }
                   3782: </pre>
1.85      jmmv     3783:              </td>
                   3784: </tr>
                   3785: </tbody>
1.91      rillig   3786: </table></div>
1.85      jmmv     3787: </div>
1.254     maya     3788: <br class="table-break">
1.85      jmmv     3789: </div>
1.148     asau     3790: <div class="sect2">
1.85      jmmv     3791: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3792: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     3793: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3794:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3795:       improvements you do to a package to the mainstream developers.
                   3796:       This is the only way to get their attention on portability issues
                   3797:       and to ensure that future versions can be built out-of-the box on
                   3798:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3799:       the fixes straight from the packaged code.</p>
1.93      rillig   3800: <p>This generally involves cleaning up the patches
                   3801:       (because sometimes the patches that are
1.147     wiz      3802:       added to pkgsrc are quick hacks), filing bug reports in the
1.85      jmmv     3803:       appropriate trackers for the projects and working with the
                   3804:       mainstream authors to accept your changes.  It is
                   3805:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3806:       the packages in pkgsrc are kept simple and thus further changes
                   3807:       can be done without much hassle.</p>
1.130     wiz      3808: <p>When you have done this, please add a URL to the upstream
                   3809:       bug report to the patch comment.</p>
1.85      jmmv     3810: <p>Support the idea of free software!</p>
                   3811: </div>
1.75      rillig   3812: </div>
1.148     asau     3813: <div class="sect1">
1.75      rillig   3814: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3815: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148     asau     3816: <div class="variablelist"><dl class="variablelist">
1.76      rillig   3817: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   3818: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      3819:          any credits where they are due.  Please bear in mind that others do not
                   3820:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3821:          will read everything that you write here.</p></dd>
1.76      rillig   3822: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      3823: <dd><p>This file governs the files that are installed on your
                   3824:          system: all the binaries, manual pages, etc. There are other
                   3825:          directives which may be entered in this file, to control the
                   3826:          creation and deletion of directories, and the location of
1.110     hubertf  3827:          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      3828:          information.</p></dd>
1.75      rillig   3829: </dl></div>
                   3830: </div>
1.148     asau     3831: <div class="sect1">
1.75      rillig   3832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3833: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148     asau     3834: <div class="sect2">
1.78      rillig   3835: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3836: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148     asau     3837: <div class="variablelist"><dl class="variablelist">
1.76      rillig   3838: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135     wiz      3839: <dd>
1.257     leot     3840: <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-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      3841:            First time after package extraction and before files are
                   3842:            moved in place, the second time after the files to install
                   3843:            are moved in place. This can be used to do any custom
                   3844:            procedures not possible with @exec commands in
1.257     leot     3845:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   3846:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.0"><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      3847:            Please note that you can modify variables in it easily by using
                   3848:            <code class="varname">FILES_SUBST</code> in the package's
                   3849:            <code class="filename">Makefile</code>:</p>
                   3850: <pre class="programlisting">
                   3851: FILES_SUBST+=  SOMEVAR="somevalue"
                   3852: </pre>
                   3853: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3854:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3855:            performed for <code class="varname">PREFIX</code>,
                   3856:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3857:            <code class="varname">VARBASE</code>, and a few others, type
                   3858:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3859:            complete list.</p>
                   3860: </dd>
1.76      rillig   3861: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   3862: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      3863:            this script's responsibility to clean up any additional messy details
                   3864:            around the package's installation, since all pkg_delete knows is how to
                   3865:            delete the files created in the original distribution.
1.257     leot     3866:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   3867:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135     wiz      3868:            The same methods to replace variables can be used as for
                   3869:            the <code class="filename">INSTALL</code> file.</p></dd>
1.76      rillig   3870: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   3871: <dd>
                   3872: <p>This file is displayed after installation of the package.
1.87      wiz      3873:            Useful for things like legal notices on almost-free
                   3874:            software and hints for updating config files after
                   3875:            installing modules for apache, PHP etc.
                   3876:            Please note that you can modify variables in it easily by using
                   3877:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3878:            <code class="filename">Makefile</code>:</p>
1.75      rillig   3879: <pre class="programlisting">
1.100     rillig   3880: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   3881: </pre>
1.128     wiz      3882: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.87      wiz      3883:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3884:            performed for <code class="varname">PKGNAME</code>,
                   3885:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.209     sevan    3886:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.87      wiz      3887:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3888:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  3889:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      3890: <p>You can display a different or additional files by
                   3891:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3892:            default is <code class="filename">MESSAGE</code>, if the file
                   3893:            exists.</p>
1.75      rillig   3894: </dd>
1.78      rillig   3895: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174     asau     3896: <dd>
                   3897: <p>This file is used by the alternatives framework.
                   3898:            It creates, configures, and destroys generic wrappers used to
                   3899:            run programs with similar interfaces.
                   3900:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3901:             for more information.</p>
                   3902: <p>Each line of the file contains two filenames, first
                   3903:            the wrapper and then the alternative provided by the package.
                   3904:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3905: </dd>
1.78      rillig   3906: </dl></div>
                   3907: </div>
1.148     asau     3908: <div class="sect2">
1.78      rillig   3909: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3910: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148     asau     3911: <div class="variablelist"><dl class="variablelist">
1.78      rillig   3912: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3913: <dd><p>This file contains arbitrary things that could
                   3914:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3915:        to be used by more than one package. This file should only be
                   3916:        used when the packages that will use the file are known in
                   3917:        advance. For other purposes it is often better to write a
                   3918:        <code class="filename">*.mk</code> file and give it a good name that
                   3919:        describes what it does.</p></dd>
                   3920: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3921: <dd><p>This file contains the dependency information
1.110     hubertf  3922:        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   3923: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3924: <dd><p>This file contains workarounds for compiler bugs
                   3925:        and similar things. It is included automatically by the pkgsrc
                   3926:        infrastructure, so you don't need an extra
                   3927:        <code class="literal">.include</code> line for
                   3928:        it.</p></dd>
                   3929: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3930: <dd><p>This file contains the code for the
1.110     hubertf  3931:        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   3932:        selected by the user. If a package has only one or two options,
                   3933:        it is equally acceptable to put the code directly into the
                   3934:        <code class="filename">Makefile</code>.</p></dd>
                   3935: </dl></div>
                   3936: </div>
1.148     asau     3937: <div class="sect2">
1.78      rillig   3938: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3939: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148     asau     3940: <div class="variablelist"><dl class="variablelist">
1.78      rillig   3941: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   3942: <dd><p>These files do not take place in the creation of
                   3943:        a package and thus are purely informative to the package
                   3944:        developer.</p></dd>
                   3945: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   3946: <dd><p>This file contains things that need to be done
                   3947:        to make the package even
                   3948:        better.</p></dd>
1.75      rillig   3949: </dl></div>
                   3950: </div>
1.78      rillig   3951: </div>
1.148     asau     3952: <div class="sect1">
1.75      rillig   3953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3954: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   3955: </h2></div></div></div>
1.110     hubertf  3956: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      3957:     unpacked into the directory denoted by
                   3958:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  3959:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      3960:     directory is also used to keep various timestamp files.
                   3961:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   3962:     The default is <code class="filename">${.CURDIR}/work</code>
                   3963:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   3964:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   3965: </div>
1.148     asau     3966: <div class="sect1">
1.75      rillig   3967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3968: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   3969: </h2></div></div></div>
1.75      rillig   3970: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      3971:     to configuration or building, you could place these files here and use
1.110     hubertf  3972:     a <span class="command"><strong>${CP}</strong></span> command in the
1.128     wiz      3973:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.87      wiz      3974:     this. Alternatively, you could simply diff the file against
                   3975:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   3976:     the creation of this file.</p>
                   3977: <p>If you want to share files in this way with other
                   3978:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   3979:     to the other package's <code class="filename">files</code> directory,
                   3980:     e.g.:</p>
                   3981: <pre class="programlisting">
1.100     rillig   3982: FILESDIR=${.CURDIR}/../xemacs/files
                   3983: </pre>
1.75      rillig   3984: </div>
                   3985: </div>
1.148     asau     3986: <div class="chapter">
1.75      rillig   3987: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3988: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   3989: <div class="toc">
                   3990: <p><b>Table of Contents</b></p>
1.210     leot     3991: <dl class="toc">
1.106     rillig   3992: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      3993: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   3994: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3995: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3996: <dd><dl>
                   3997: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.228     yyamano  3998: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.220     wiz      3999: <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>
                   4000: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.75      rillig   4001: </dl></dd>
                   4002: </dl>
                   4003: </div>
1.76      rillig   4004: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4005:   each of which forms a well-defined part of the pkgsrc system. Using
1.257     leot     4006:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75      rillig   4007:   like pkgsrc requires some discipline to keep the code correct and
                   4008:   understandable.</p>
1.76      rillig   4009: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4010:   programming are variables (which are actually macros) and shell
                   4011:   commands. Among these shell commands may even be more complex ones
1.257     leot     4012:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75      rillig   4013:   as intended it is necessary to quote all variables correctly when they
                   4014:   are used.</p>
                   4015: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4016:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4017:   with them.</p>
1.148     asau     4018: <div class="sect1">
1.75      rillig   4019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4020: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148     asau     4021: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97      rillig   4022: <p>When you are creating a file as a
                   4023:     target of a rule, always write the data to a temporary file first
                   4024:     and finally rename that file. Otherwise there might occur an error
                   4025:     in the middle of generating the file, and when the user runs
1.257     leot     4026:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><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   4027:     regenerated properly. Example:</p>
                   4028: <pre class="programlisting">
1.100     rillig   4029: wrong:
                   4030:         @echo "line 1" &gt; ${.TARGET}
                   4031:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4032:         @false
                   4033: 
                   4034: correct:
                   4035:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4036:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4037:         @false
                   4038:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4039: </pre>
1.110     hubertf  4040: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4041:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4042:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4043:     correct</strong></span> gives an error message twice, as expected.</p>
1.257     leot     4044: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97      rillig   4045:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4046:     happens when it is interrupted, for example by pressing
                   4047:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.257     leot     4048:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97      rillig   4049: </li></ul></div>
                   4050: </div>
1.148     asau     4051: <div class="sect1">
1.97      rillig   4052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4053: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4054: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4055:     can be processed using the five operators ``='', ``+='', ``?='',
1.257     leot     4056:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75      rillig   4057:     page.</p>
                   4058: <p>When a variable's value is parsed from a
1.76      rillig   4059:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4060:     backslash character ``\'' are handled specially. If a backslash is
                   4061:     followed by a newline, any whitespace immediately in front of the
                   4062:     backslash, the backslash, the newline, and any whitespace
                   4063:     immediately behind the newline are replaced with a single space. A
                   4064:     backslash character and an immediately following hash character are
                   4065:     replaced with a single hash character. Otherwise, the backslash is
                   4066:     passed as is. In a variable assignment, any hash character that is
1.251     leot     4067:     not preceded by a backslash starts a comment that continues up to the
1.75      rillig   4068:     end of the logical line.</p>
1.219     rillig   4069: <p>The evaluation of variables either happens immediately or lazy.
                   4070:     It happens immediately when the variable occurs
                   4071:     on the right-hand side of the ``:='' or the ``!='' operator, in a
                   4072:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   4073:     In the other cases, it is evaluated lazily.</p>
1.75      rillig   4074: <p>Some of the modifiers split the string into words and then
                   4075:     operate on the words, others operate on the string as a whole. When
1.257     leot     4076:     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-8.0"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.75      rillig   4077: <p>There are several types of variables that should be handled
                   4078:     differently. Strings and two types of lists.</p>
1.148     asau     4079: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4080: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75      rillig   4081:       characters. Nevertheless, you should restrict yourself to only
                   4082:       using printable characters. Examples are
                   4083:       <code class="varname">PREFIX</code> and
                   4084:       <code class="varname">COMMENT</code>.</p></li>
1.128     wiz      4085: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75      rillig   4086:       are never exported to any shell command. Their elements are
                   4087:       separated by whitespace. Therefore, the elements themselves cannot
                   4088:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  4089:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   4090:       Examples are <code class="varname">DEPENDS</code> and
                   4091:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128     wiz      4092: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75      rillig   4093:       may be exported to a shell command. Their elements can contain any
                   4094:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  4095:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   4096:       <code class="varname">DISTFILES</code> and
                   4097:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4098: </ul></div>
1.148     asau     4099: <div class="sect2">
1.75      rillig   4100: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4101: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148     asau     4102: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4103: <li class="listitem"><p>All variable names starting with an underscore
1.75      rillig   4104:        are reserved for use by the pkgsrc infrastructure. They shall
                   4105:        not be used by package
1.76      rillig   4106:        <code class="filename">Makefile</code>s.</p></li>
1.128     wiz      4107: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4108:        lowercase variable names for the iteration
                   4109:        variables.</p></li>
1.128     wiz      4110: <li class="listitem"><p>All list variables should have a ``plural''
1.75      rillig   4111:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4112:        <code class="varname">DISTFILES</code>.</p></li>
                   4113: </ul></div>
                   4114: </div>
                   4115: </div>
1.148     asau     4116: <div class="sect1">
1.75      rillig   4117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4118: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.148     asau     4119: <div class="sect2">
1.75      rillig   4120: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4121: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.220     wiz      4122: <p>When adding a string that possibly contains whitespace or quotes to
                   4123: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   4124: modifier.</p>
                   4125: <p>When adding another list to a list (example 2), it must not be
                   4126: quoted, since its elements are already quoted.</p>
1.75      rillig   4127: <pre class="programlisting">
1.220     wiz      4128: STRING=         foo * bar `date`
                   4129: LIST=           # empty
                   4130: ANOTHER_LIST=   a=b c=d
                   4131: 
                   4132: LIST+=          ${STRING:Q}       # 1
                   4133: LIST+=          ${ANOTHER_LIST}   # 2
                   4134: </pre>
1.75      rillig   4135: </div>
1.148     asau     4136: <div class="sect2">
1.75      rillig   4137: <div class="titlepage"><div><div><h3 class="title">
1.228     yyamano  4138: <a name="echo-literal"></a>12.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.220     wiz      4139: <p>Echoing a string containing special characters needs special
                   4140: work.</p>
1.75      rillig   4141: <pre class="programlisting">
1.100     rillig   4142: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
1.219     rillig   4143: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
1.1       grant    4144: 
1.100     rillig   4145: all:
                   4146:         echo ${STRING}                  # 1
1.219     rillig   4147:         echo ${STRING:Q}                # 2
                   4148:         printf '%s\n' ${STRING:Q}''     # 3
1.220     wiz      4149:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.1       grant    4150: </pre>
1.220     wiz      4151: <p>Example 1 leads to a syntax error in the shell, as the characters
                   4152: are just copied.</p>
                   4153: <p>Example 2 quotes the string so that the shell interprets it
                   4154: correctly. But the echo command may additionally interpret strings with a
                   4155: leading dash or those containing backslashes.</p>
1.257     leot     4156: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.252     leot     4157: interprets the format string, but not the next argument. The trailing
                   4158: single quotes handle the case when the string is empty. In that case, the
                   4159: :Q modifier would result in an empty string too, which would then be
1.257     leot     4160: skipped by the shell. For <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.252     leot     4161: but other programs may care.</p>
1.220     wiz      4162: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   4163: need to be quoted because the quoting has already been done
                   4164: when adding elements to the list.</p>
1.75      rillig   4165: </div>
1.148     asau     4166: <div class="sect2">
1.75      rillig   4167: <div class="titlepage"><div><div><h3 class="title">
1.220     wiz      4168: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   4169: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   4170: GNU-style configure script (especially those that call other configure
                   4171: scripts), it must not have leading or trailing whitespace, since
                   4172: otherwise the configure script gets confused. To trim leading and
                   4173: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   4174: following example:</p>
1.75      rillig   4175: <pre class="programlisting">
1.100     rillig   4176: CPPFLAGS=               # empty
1.220     wiz      4177: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
1.100     rillig   4178: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4179: 
                   4180: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4181: 
                   4182: all:
                   4183:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
1.220     wiz      4184:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
1.1       grant    4185: </pre>
1.220     wiz      4186: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   4187: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   4188: space.</p>
                   4189: </div>
                   4190: <div class="sect2">
                   4191: <div class="titlepage"><div><div><h3 class="title">
                   4192: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
                   4193: <p>When a possibly empty variable is used in a shell program, it may
                   4194: lead to a syntax error.</p>
                   4195: <pre class="programlisting">
                   4196: EGFILES=        # empty
                   4197: 
                   4198: install-examples:   # produces a syntax error in the shell
                   4199:         for egfile in ${EGFILES}; do            \
                   4200:                 echo "Installing $$egfile";     \
                   4201:         done
                   4202: </pre>
                   4203: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.257     leot     4204: <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-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.220     wiz      4205: To fix this syntax error, use one of the snippets below.</p>
                   4206: <pre class="programlisting">
                   4207: EMPTY=          # empty
                   4208: 
                   4209: install-examples:
                   4210:         for egfile in ${EGFILES} ""; do         \
                   4211:                 [ -n "$$egfile" ] || continue;  \
                   4212:                 echo "Installing $$egfile";     \
1.100     rillig   4213:         done
1.220     wiz      4214: </pre>
                   4215: <p>In this case, an empty string is appended to the iteration list (to
                   4216: prevent the syntax error) and filtered out later.</p>
                   4217: <pre class="programlisting">
                   4218: EGFILES=        # empty
1.100     rillig   4219: 
1.220     wiz      4220: install-examples:
                   4221: .for egfile in ${EGFILES}
                   4222:         echo "Installing ${egfile}"
1.100     rillig   4223: .endfor
1.1       grant    4224: </pre>
1.220     wiz      4225: <p>This variant only works when <code class="varname">EGFILES</code> does not
                   4226: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
                   4227: simple whitespace.</p>
                   4228: <p>To have a shell command test whether a make variable is empty, use
                   4229: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.75      rillig   4230: </div>
                   4231: </div>
                   4232: </div>
1.148     asau     4233: <div class="chapter">
1.75      rillig   4234: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4235: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   4236: <div class="toc">
                   4237: <p><b>Table of Contents</b></p>
1.210     leot     4238: <dl class="toc">
1.106     rillig   4239: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      4240: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   4241: <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   4242: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   4243: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      4244: <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   4245: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz      4246: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   4247: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.75      rillig   4248: </dl>
                   4249: </div>
1.87      wiz      4250: <p>The <code class="filename">PLIST</code> file contains a package's
1.128     wiz      4251:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.87      wiz      4252:   the package (relative to the <code class="filename">${PREFIX}</code>
                   4253:   directory it's been installed in) plus some additional statements
1.257     leot     4254:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87      wiz      4255:   This chapter addresses some issues that need attention when
                   4256:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   4257:   below!).</p>
1.148     asau     4258: <div class="sect1">
1.75      rillig   4259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4260: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      4261: <p>Be sure to add a RCS ID line as the first thing in any
                   4262:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   4263: <pre class="programlisting">
1.233     sevan    4264: @comment $NetBSD $
1.222     sevan    4265: </pre>
1.235     yyamano  4266: <p>An artificial space has been added between NetBSD and $, this is a
1.233     sevan    4267: workaround here to prevent CVS expanding to the filename of the guide. When
1.238     leot     4268: adding the RCS ID the space should be omitted.</p>
1.75      rillig   4269: </div>
1.148     asau     4270: <div class="sect1">
1.75      rillig   4271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4272: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  4273: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      4274:     to output a PLIST that matches any new files since the package
1.110     hubertf  4275:     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      4276:     more information on this target.</p>
1.75      rillig   4277: </div>
1.148     asau     4278: <div class="sect1">
1.75      rillig   4279: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  4280: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   4281: </h2></div></div></div>
1.87      wiz      4282: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   4283:     of AWK patterns and actions that are used to filter the output of
                   4284:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   4285:     scripting you like to it, but be careful with quoting.</p>
                   4286: <p>For example, to get all files inside the
                   4287:     <code class="filename">libdata/foo</code> directory removed from the
                   4288:     resulting PLIST:</p>
                   4289: <pre class="programlisting">
1.100     rillig   4290: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.222     sevan    4291: </pre>
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.106     rillig   4295: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      4296: <p>A number of variables are substituted automatically in
                   4297:     PLISTs when a package is installed on a system. This includes the
                   4298:     following variables:</p>
1.148     asau     4299: <div class="variablelist"><dl class="variablelist">
1.75      rillig   4300: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   4301: <dd>
                   4302: <p>Some packages like emacs and perl embed information
1.87      wiz      4303:          about which architecture they were built on into the
                   4304:          pathnames where they install their files. To handle this
                   4305:          case, PLIST will be preprocessed before actually used, and
                   4306:          the symbol
1.128     wiz      4307:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.110     hubertf  4308:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      4309:          same is done if the string
                   4310:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   4311:          PLIST somewhere - use this on packages that have GNU
                   4312:          autoconf-created configure scripts.</p>
1.148     asau     4313: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   4314: <h3 class="title">Legacy note</h3>
                   4315: <p>There used to be a symbol
1.128     wiz      4316:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.110     hubertf  4317:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      4318:            -m</strong></span>, but that's no longer supported and has
                   4319:            been removed.</p>
1.75      rillig   4320: </div>
                   4321: </dd>
                   4322: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   4323: <dd>
                   4324: <p>Some packages want to embed the OS name and version
1.87      wiz      4325:          into some paths.  To do this, use these variables in the
                   4326:          <code class="filename">PLIST</code>:
                   4327:          </p>
1.148     asau     4328: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4329: <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>
                   4330: <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>
                   4331: <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   4332: </ul></div>
                   4333: </dd>
                   4334: </dl></div>
1.199     tnn      4335: <p>For a list of values which are replaced by
                   4336:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   4337: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   4338: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87      wiz      4339: <p>If you want to change other variables not listed above, you
                   4340:     can add variables and their expansions to this variable in the
1.110     hubertf  4341:     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   4342: <pre class="programlisting">
1.100     rillig   4343: PLIST_SUBST+=   SOMEVAR="somevalue"
1.222     sevan    4344: </pre>
1.128     wiz      4345: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.87      wiz      4346:     in the <code class="filename">PLIST</code> with
1.128     wiz      4347:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.120     snj      4348: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119     mishka   4349:     the common case of conditionally including some
                   4350:     <code class="filename">PLIST</code> entries. It can be done by adding
                   4351:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120     snj      4352:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   4353:     to <code class="literal">yes</code> if the entry should be included.
1.128     wiz      4354:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.119     mishka   4355:     in the <code class="filename">PLIST</code> with either
1.128     wiz      4356:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   4357:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.119     mishka   4358:     For example, in <code class="filename">Makefile</code>:</p>
                   4359: <pre class="programlisting">
1.223     rillig   4360: PLIST_VARS+=    foo
1.119     mishka   4361: .if <em class="replaceable"><code>condition</code></em>
1.223     rillig   4362: PLIST.foo=      yes
1.119     mishka   4363: .else
1.222     sevan    4364: </pre>
1.119     mishka   4365: <p>And then in <code class="filename">PLIST</code>:</p>
                   4366: <pre class="programlisting">
1.233     sevan    4367: @comment $NetBSD $
1.119     mishka   4368: bin/bar
                   4369: man/man1/bar.1
                   4370: ${PLIST.foo}bin/foo
                   4371: ${PLIST.foo}man/man1/foo.1
                   4372: ${PLIST.foo}share/bar/foo.data
1.222     sevan    4373: </pre>
1.235     yyamano  4374: <p>An artificial space has been added between NetBSD and $, this is a
1.233     sevan    4375: workaround here to prevent CVS expanding to the filename of the guide. When
                   4376: adding the RCS ID the space should be ommited.</p>
1.75      rillig   4377: </div>
1.148     asau     4378: <div class="sect1">
1.75      rillig   4379: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4380: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   4381: <p>Man pages should be installed in compressed form if
1.87      wiz      4382:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   4383:     and uncompressed otherwise. To handle this in the
1.128     wiz      4384:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.87      wiz      4385:     appended/removed automatically for man pages according to
                   4386:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   4387:     or not, see above for details. This modification of the
                   4388:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   4389:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   4390: </div>
1.148     asau     4391: <div class="sect1">
1.75      rillig   4392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4393: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   4394: </h2></div></div></div>
1.76      rillig   4395: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      4396:     in generating the binary package, set the variable
                   4397:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.257     leot     4398:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87      wiz      4399:     important. The default for <code class="varname">PLIST_SRC</code> is
                   4400:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   4401: </div>
1.148     asau     4402: <div class="sect1">
1.75      rillig   4403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4404: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   4405: <p>Some packages decide to install a different set of files based on
1.87      wiz      4406:     the operating system being used. These differences can be
                   4407:     automatically handled by using the following files:</p>
1.148     asau     4408: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4409: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   4410: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   4411: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   4412: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   4413: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   4414: </ul></div>
                   4415: </div>
1.148     asau     4416: <div class="sect1">
1.75      rillig   4417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.197     wiz      4418: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
                   4419: <p>Some packages decide to generate hard-to-guess file names
                   4420:     during installation that are hard to wire down.</p>
                   4421: <p>In such cases, you can set the
                   4422:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   4423:     terminated (with a semicolon) that will output PLIST entries which
                   4424:     will be appended to the PLIST</p>
                   4425: <p>You can find one example in editors/xemacs:</p>
                   4426: <pre class="programlisting">
1.222     sevan    4427: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   4428: </pre>
1.197     wiz      4429: <p>which will append something like
                   4430:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   4431:     <code class="filename">PLIST</code>.
                   4432:     </p>
                   4433: </div>
                   4434: <div class="sect1">
                   4435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4436: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.128     wiz      4437: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.87      wiz      4438:     multiple (and unrelated) packages install files.  These
1.125     wiz      4439:     directories were problematic because you had to add special
                   4440:     tricks in the PLIST to conditionally remove them, or have some
1.87      wiz      4441:     centralized package handle them.</p>
1.125     wiz      4442: <p>In pkgsrc, it is now easy: Each package should create
                   4443:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   4444:     will remove any directories left empty after uninstalling a
                   4445:     package.</p>
                   4446: <p>If a package needs an empty directory to work, create
                   4447:     the directory during installation as usual, and also add an
                   4448:     entry to the PLIST:
1.222     sevan    4449: 
                   4450: </p>
1.87      wiz      4451: <pre class="programlisting">
1.125     wiz      4452: @pkgdir path/to/empty/directory
1.222     sevan    4453: </pre>
1.125     wiz      4454: <p>
1.222     sevan    4455: 
1.197     wiz      4456:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   4457:     <code class="varname">OWN_DIRS</code>.
1.125     wiz      4458:     </p>
1.75      rillig   4459: </div>
                   4460: </div>
1.148     asau     4461: <div class="chapter">
1.75      rillig   4462: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4463: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   4464: <div class="toc">
                   4465: <p><b>Table of Contents</b></p>
1.210     leot     4466: <dl class="toc">
1.106     rillig   4467: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      4468: <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   4469: <dd><dl>
1.106     rillig   4470: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      4471: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   4472:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4473:       and
                   4474:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4475:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   4476: </dl></dd>
1.128     wiz      4477: <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   4478: <dd><dl>
1.128     wiz      4479: <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   4480: <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   4481: </dl></dd>
                   4482: </dl>
                   4483: </div>
                   4484: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      4485:   are seen by a package's configure and build processes.  This is implemented
                   4486:   in a two step process:</p>
1.128     wiz      4487: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4488: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87      wiz      4489:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   4490:       of <code class="varname">WRKDIR</code>.</p></li>
1.128     wiz      4491: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      4492:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   4493:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   4494:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   4495:       native compiler on some operating systems look like GCC, so that
                   4496:       packages that expect GCC won't require modifications to build with
                   4497:       those native compilers.</p></li>
1.75      rillig   4498: </ol></div>
                   4499: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      4500:   package may be built consistently despite what other software may be
                   4501:   installed. Please note that the normal system header and library paths,
                   4502:   e.g. <code class="filename">/usr/include</code>,
                   4503:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   4504:   designed to insulate the package build from non-system-supplied
                   4505:   software.</p>
1.148     asau     4506: <div class="sect1">
1.75      rillig   4507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4508: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   4509: <p>The process of converting packages to use the buildlink3
1.128     wiz      4510:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.87      wiz      4511:     The things to keep in mind are:</p>
1.128     wiz      4512: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4513: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87      wiz      4514:        instead of the actual toolchain.  Some packages are tricky,
                   4515:        and the only way to know for sure is the check
                   4516:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   4517:        wrappers are being invoked.</p></li>
1.128     wiz      4518: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87      wiz      4519:        the package Makefile, e.g. Java VMs, standalone shells,
                   4520:        etc., because the code to symlink files into
                   4521:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128     wiz      4522:        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      4523:        </p></li>
1.128     wiz      4524: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87      wiz      4525:        <code class="filename">buildlink3.mk</code> files that you list in a
                   4526:        package's Makefile are added as dependencies for that package.
                   4527:        </p></li>
1.75      rillig   4528: </ol></div>
1.87      wiz      4529: <p>If a dependency on a particular package is required for its libraries and
                   4530:     headers, then we replace:</p>
1.75      rillig   4531: <pre class="programlisting">
1.100     rillig   4532: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   4533: </pre>
1.75      rillig   4534: <p>with</p>
                   4535: <pre class="programlisting">
1.100     rillig   4536: .include "../../category/foo/buildlink3.mk"
                   4537: </pre>
1.75      rillig   4538: <p>The buildlink3.mk files usually define the required dependencies.
                   4539:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      4540:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   4541: <pre class="programlisting">
1.100     rillig   4542: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   4543: .include "../../category/foo/buildlink3.mk"
                   4544: </pre>
1.76      rillig   4545: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      4546:     files in <code class="filename">pkgsrc/mk</code>
                   4547:     that handle special package issues:</p>
1.148     asau     4548: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4549: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      4550:        the native or a pkgsrc Berkeley DB implementation based on
                   4551:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   4552:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128     wiz      4553: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      4554:        comes with neither Curses nor NCurses, this will take care
1.250     leot     4555:        to install the <a href="https://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      4556: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      4557:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   4558:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   4559:        require a Kerberos 5 implementation.</p></li>
1.128     wiz      4560: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88      wiz      4561:        system-provided Motif installation or adds a dependency on
1.250     leot     4562:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.128     wiz      4563:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.239     leot     4564:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   4565:        to choose which Motif version will be used.</p></li>
1.161     ryoon    4566: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162     wiz      4567:        system-provided GNU readline or editline (libedit) installation,
1.250     leot     4568:        or adds a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
                   4569:        <a href="https://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    4570:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   4571:        If your package really needs GNU readline library, its Makefile
                   4572:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   4573:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128     wiz      4574: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      4575:        variables that may be used by packages that use the
                   4576:        Open Sound System (OSS) API.</p></li>
1.128     wiz      4577: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142     wiz      4578:        any of the Postgres versions in the variable
                   4579:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   4580:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87      wiz      4581:        the file for more information.</p></li>
1.128     wiz      4582: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      4583:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.250     leot     4584:        a dependency on <a href="https://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      4585: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      4586:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   4587:        library.</p></li>
1.75      rillig   4588: </ul></div>
1.76      rillig   4589: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      4590:     files provide a more complete
                   4591:     description of how to use them properly.</p>
1.75      rillig   4592: </div>
1.148     asau     4593: <div class="sect1">
1.75      rillig   4594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4595: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   4596: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      4597:     included by Makefiles to indicate the need to compile and link
                   4598:     against header files and libraries provided by the package.  A
                   4599:     <code class="filename">buildlink3.mk</code> file should always provide
                   4600:     enough information to add the correct type of dependency
                   4601:     relationship and include any other
                   4602:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   4603:     headers and libraries that it needs in turn.</p>
                   4604: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.250     leot     4605:     file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87      wiz      4606:     package is highly recommended.  For most packages, the following
                   4607:     command will generate a good starting point for
                   4608:     <code class="filename">buildlink3.mk</code> files:</p>
                   4609: <pre class="screen">
                   4610: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   4611: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   4612:     </pre>
1.148     asau     4613: <div class="sect2">
1.75      rillig   4614: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4615: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   4616: <p>The following real-life example
1.87      wiz      4617:       <code class="filename">buildlink3.mk</code> is taken
                   4618:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   4619: <pre class="programlisting">
1.120     snj      4620: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       grant    4621: 
1.223     rillig   4622: BUILDLINK_TREE+=        tiff
1.1       grant    4623: 
1.120     snj      4624: .if !defined(TIFF_BUILDLINK3_MK)
                   4625: TIFF_BUILDLINK3_MK:=
1.87      wiz      4626: 
1.223     rillig   4627: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   4628: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   4629: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
1.87      wiz      4630: 
1.100     rillig   4631: .include "../../devel/zlib/buildlink3.mk"
                   4632: .include "../../graphics/jpeg/buildlink3.mk"
1.120     snj      4633: .endif # TIFF_BUILDLINK3_MK
1.87      wiz      4634: 
1.223     rillig   4635: BUILDLINK_TREE+=        -tiff
1.100     rillig   4636: </pre>
1.87      wiz      4637: <p>The header and footer manipulate
1.120     snj      4638:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87      wiz      4639:       <code class="filename">buildlink3.mk</code> files and is used to track
1.120     snj      4640:       the dependency tree.</p>
                   4641: <p>The main section is protected from multiple inclusion
1.87      wiz      4642:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   4643:       added.  Several important variables are set in the section:</p>
1.148     asau     4644: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4645: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4646:          is the actual dependency recorded in the installed
                   4647:          package; this should always be set using
1.110     hubertf  4648:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      4649:          we're appending to any pre-existing list of values.  This
                   4650:          variable should be set to the first version of the
1.133     wiz      4651:          package that had an backwards-incompatible API change.
1.87      wiz      4652:          </p></li>
1.128     wiz      4653: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4654:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   4655:          pkgsrc directory.</p></li>
1.128     wiz      4656: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4657:          (not shown above) controls whether we use
                   4658:          <code class="varname">BUILD_DEPENDS</code> or
                   4659:          <code class="varname">DEPENDS</code> to add the dependency on
                   4660:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   4661:          selected by setting
                   4662:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4663:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.87      wiz      4664:          used.</p></li>
1.128     wiz      4665: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4666:            and
                   4667:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   4668:            (not shown above) are lists of subdirectories of
1.76      rillig   4669:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   4670:            to add to the header and library search paths.  These
1.128     wiz      4671:            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      4672:          respectively.</p></li>
1.128     wiz      4673: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4674:            (not shown above) is the list of preprocessor flags to add
                   4675:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128     wiz      4676:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.75      rillig   4677:            should be avoided and instead be handled using
                   4678:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      4679:          above.</p></li>
1.75      rillig   4680: </ul></div>
1.87      wiz      4681: <p>The following variables are all optionally defined within
                   4682:       this second section (protected against multiple inclusion) and
                   4683:       control which package files are symlinked into
                   4684:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   4685:       transformed during the symlinking:</p>
1.148     asau     4686: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4687: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4688:            (not shown above) is a shell glob pattern relative to
1.76      rillig   4689:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   4690:            to be symlinked into
1.76      rillig   4691:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      4692:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.128     wiz      4693: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4694:            (not shown above) is a shell pipeline that
                   4695:            outputs to stdout a list of files relative to
                   4696:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   4697:            The resulting files are to be symlinked
                   4698:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   4699:            this takes the <code class="filename">+CONTENTS</code> of a
                   4700:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   4701:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128     wiz      4702: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4703:            (not shown above) is a filter command that filters
1.76      rillig   4704:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   4705:            relative to
1.76      rillig   4706:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194     bsiegert 4707:            on stdout.  By default,
1.75      rillig   4708:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   4709:            outputs the contents of the <code class="filename">include</code>
                   4710:            and <code class="filename">lib</code> directories in the package
1.194     bsiegert 4711:            <code class="filename">+CONTENTS</code>.</p></li>
1.128     wiz      4712: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4713:            (not shown above) is a list of sed arguments used to
                   4714:            transform the name of the source filename into a
1.110     hubertf  4715:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      4716:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   4717: </ul></div>
1.120     snj      4718: <p>This section can additionally include any
1.87      wiz      4719:       <code class="filename">buildlink3.mk</code> needed for
                   4720:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   4721:       Including these <code class="filename">buildlink3.mk</code> files
                   4722:       means that the headers and libraries for these
                   4723:       dependencies are also symlinked into
                   4724:       <code class="filename">${BUILDLINK_DIR}</code>
                   4725:       whenever the <em class="replaceable"><code>pkg</code></em>
                   4726:       <code class="filename">buildlink3.mk</code>
1.120     snj      4727:       file is included. Dependencies are only added for directly
                   4728:       include <code class="filename">buildlink3.mk</code> files.</p>
1.153     wiz      4729: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   4730:       including other <code class="filename">buildlink3.mk</code> files in it,
1.156     wiz      4731:       please only add necessary ones, i.e., those whose libraries or
1.153     wiz      4732:       header files are automatically exposed when the package is
                   4733:       use.</p>
                   4734: <p>In particular, if only an executable
                   4735:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   4736:       library does not need to be propagated in the
                   4737:       <code class="filename">buildlink3.mk</code> file.</p>
                   4738: <p>The following steps should help you decide if a
                   4739:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   4740:       </p>
                   4741: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4742: <li class="listitem"><p>Look at the installed header files: What
                   4743:        headers do they include? The packages providing these files
                   4744:        must be buildlinked.</p></li>
1.155     wiz      4745: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   4746:        libraries and look against what other libraries they link.
                   4747:        Some of the packages providing these probably need to be
                   4748:        buildlinked; however, it's not automatic, since e.g. GTK on
                   4749:        some systems pulls in the X libraries, so they will show up in
                   4750:        the <code class="filename">ldd</code> output, while on others (like OS
1.156     wiz      4751:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.155     wiz      4752:        used as a hint.</p></li>
1.153     wiz      4753: </ul></div>
                   4754: <p>
                   4755:       </p>
1.75      rillig   4756: </div>
1.148     asau     4757: <div class="sect2">
1.75      rillig   4758: <div class="titlepage"><div><div><h3 class="title">
1.133     wiz      4759: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87      wiz      4760:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      4761:       and
                   4762:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4763:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   4764: <p>These two variables differ in that one describes source
                   4765:       compatibility (API) and the other binary compatibility (ABI).
                   4766:       The difference is that a change in the API breaks compilation of
                   4767:       programs while changes in the ABI stop compiled programs from
                   4768:       running.</p>
                   4769: <p>Changes to the
1.134     wiz      4770:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      4771:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   4772:       very rarely. One possible reason is that all packages depending
                   4773:       on this already need a newer version. In case it is bumped see
                   4774:       the description below.</p>
                   4775: <p>The most common example of an ABI change is that the major
                   4776:       version of a shared library is increased. In this case,
                   4777:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4778:       should be adjusted to require at least the new package version.
                   4779:       Then the packages that depend on this package need their
                   4780:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   4781:       <code class="filename">buildlink3.mk</code> files, their
                   4782:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4783:       adjusted, too. This is needed so pkgsrc will require the correct
                   4784:       package dependency and not settle for an older one when building
                   4785:       the source.</p>
1.218     rillig   4786: <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      4787:       more information about dependencies on other packages,
                   4788:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      4789:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   4790: <p>Please take careful consideration before adjusting
                   4791:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4792:       or
                   4793:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4794:       as we don't want to cause unneeded package deletions and
                   4795:       rebuilds.  In many cases, new versions of packages work just
                   4796:       fine with older dependencies.</p>
                   4797: <p>Also it is not needed to set
1.133     wiz      4798:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4799:       when it is identical to
1.87      wiz      4800:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   4801: </div>
                   4802: </div>
1.148     asau     4803: <div class="sect1">
1.75      rillig   4804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4805: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      4806: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   4807:       coincide with headers and libraries present in the base system.
1.76      rillig   4808:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   4809:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   4810:       file that includes the necessary checks to decide whether using
                   4811:       the built-in software or the pkgsrc software is
1.87      wiz      4812:     appropriate.</p>
                   4813: <p>The only requirements of a builtin.mk file for
                   4814:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.128     wiz      4815: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4816: <li class="listitem"><p>It should set
1.87      wiz      4817:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4818:        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      4819:        after it is included.</p></li>
1.128     wiz      4820: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87      wiz      4821:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4822:        which is already set before the
                   4823:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.128     wiz      4824: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.87      wiz      4825:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   4826:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   4827: </ol></div>
1.148     asau     4828: <div class="sect2">
1.75      rillig   4829: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4830: <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   4831: <p>The following is the recommended template for builtin.mk
1.87      wiz      4832:       files:</p>
1.75      rillig   4833: <pre class="programlisting">
1.100     rillig   4834: .if !defined(IS_BUILTIN.foo)
                   4835: #
                   4836: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   4837: # genuinely exists in the system or not.
                   4838: #
                   4839: IS_BUILTIN.foo?=        no
                   4840: 
                   4841: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   4842: # version can be determined.
                   4843: #
                   4844: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   4845: BUILTIN_PKG.foo?=       foo-1.0
                   4846: .  endif
                   4847: .endif  # IS_BUILTIN.foo
                   4848: 
                   4849: .if !defined(USE_BUILTIN.foo)
                   4850: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   4851: .  if defined(BUILTIN_PKG.foo)
                   4852: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   4853: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   4854: USE_BUILTIN.foo!=                                                       \
                   4855:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   4856:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   4857: .      endif
                   4858: .    endfor
                   4859: .  endif
                   4860: .endif  # USE_BUILTIN.foo
                   4861: 
                   4862: CHECK_BUILTIN.foo?=     no
                   4863: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   4864: #
                   4865: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   4866: # "yes" or "no".
                   4867: #
                   4868: .endif  # CHECK_BUILTIN.foo
                   4869: </pre>
1.87      wiz      4870: <p>The first section sets
                   4871:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4872:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   4873:       in the base system.  This should not be a base system software
                   4874:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128     wiz      4875:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.87      wiz      4876:       included as part of the base system.  This variable is only
                   4877:       used internally within the <code class="filename">builtin.mk</code>
                   4878:       file.</p>
                   4879: <p>The second section sets
                   4880:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4881:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   4882:       system if it exists (if
                   4883:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4884:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.87      wiz      4885:       within the <code class="filename">builtin.mk</code> file.</p>
                   4886: <p>The third section sets
                   4887:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4888:       and is <span class="emphasis"><em>required</em></span> in all
                   4889:       <code class="filename">builtin.mk</code> files.  The code in this
                   4890:       section must make the determination whether the built-in
                   4891:       software is adequate to satisfy the dependencies listed in
                   4892:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   4893:       This is typically done by comparing
                   4894:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4895:       against each of the dependencies in
                   4896:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   4897:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4898:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   4899:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   4900:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4901:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.87      wiz      4902:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4903:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.87      wiz      4904:       that the built-in version of the software is similar enough to
                   4905:       be used as a replacement.</p>
                   4906: <p>The last section is guarded by
                   4907:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   4908:       and includes code that uses the value of
                   4909:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4910:       set in the previous section.  This typically includes, e.g.,
                   4911:       adding additional dependency restrictions and listing additional
                   4912:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   4913:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   4914: </div>
1.148     asau     4915: <div class="sect2">
1.75      rillig   4916: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4917: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      4918: <p>When building packages, it's possible to choose whether to set
                   4919:        a global preference for using either the built-in (native)
                   4920:        version or the pkgsrc version of software to satisfy a
                   4921:        dependency.  This is controlled by setting
                   4922:        <code class="varname">PREFER_PKGSRC</code> and
                   4923:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.128     wiz      4924:        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      4925:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   4926:        use the pkgsrc versions of software, while
                   4927:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   4928:        built-in versions.  Preferences are determined by the most
                   4929:        specific instance of the package in either
                   4930:        <code class="varname">PREFER_PKGSRC</code> or
                   4931:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   4932:        in neither or in both variables, then
                   4933:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   4934:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   4935:        using pkgsrc versions of software for all but the most basic
                   4936:       bits on a NetBSD system, you can set:</p>
                   4937: <pre class="programlisting">
1.100     rillig   4938: PREFER_PKGSRC=  yes
                   4939: PREFER_NATIVE=  getopt skey tcp_wrappers
                   4940: </pre>
1.87      wiz      4941: <p>A package <span class="emphasis"><em>must</em></span> have a
                   4942:       <code class="filename">builtin.mk</code>
                   4943:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   4944:       otherwise it is simply ignored in that list.</p>
1.229     sevan    4945: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
                   4946:       straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
                   4947:       bootstrap.
                   4948:       Switching between settings globally at a later date can introduce
                   4949:       complications with dependency resolution. This is caused by packages
                   4950:       built with the opposite preference being installed alongside each other.</p>
                   4951: <pre class="screen">
                   4952: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
                   4953: </pre>
1.75      rillig   4954: </div>
                   4955: </div>
                   4956: </div>
1.148     asau     4957: <div class="chapter">
1.75      rillig   4958: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4959: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   4960: <div class="toc">
                   4961: <p><b>Table of Contents</b></p>
1.210     leot     4962: <dl class="toc">
1.106     rillig   4963: <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   4964: <dd><dl>
1.106     rillig   4965: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   4966: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   4967: </dl></dd>
1.106     rillig   4968: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   4969: <dd><dl>
1.128     wiz      4970: <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   4971: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   4972: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   4973: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   4974: </dl></dd>
                   4975: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   4976: <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>
                   4977: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   4978: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   4979: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   4980: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   4981: <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   4982: </dl>
                   4983: </div>
                   4984: <p>This chapter describes the framework known as
                   4985: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148     asau     4986: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4987: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75      rillig   4988:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      4989: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75      rillig   4990:     provided that packages are correctly designed.</p></li>
1.128     wiz      4991: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   4992: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   4993: <li class="listitem"><p>Registration of system shells.</p></li>
                   4994: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75      rillig   4995: </ul></div>
                   4996: <p>The following sections inspect each of the above points in detail.</p>
                   4997: <p>You may be thinking that many of the things described here could be
                   4998: easily done with simple code in the package's post-installation target
                   4999: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5000: as the code in them is only executed when building from source.  Machines
                   5001: using binary packages could not benefit from it at all (as the code itself
                   5002: could be unavailable).  Therefore, the only way to achieve any of the items
                   5003: described above is by means of the installation scripts, which are
                   5004: automatically generated by pkginstall.</p>
1.148     asau     5005: <div class="sect1">
1.75      rillig   5006: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5007: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5008: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5009: of files and directories that belong to a package.  The names used in it
1.76      rillig   5010: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5011: which means that it cannot register files outside this directory (absolute
                   5012: path names are not allowed).  Despite this restriction, some packages need
                   5013: to install files outside this location; e.g., under
1.76      rillig   5014: <code class="filename">${VARBASE}</code> or
1.87      wiz      5015: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5016: is to create such files during installation time by using
                   5017: installation scripts.</p>
                   5018: <p>The generic installation scripts are shell scripts that can
                   5019: contain arbitrary code.  The list of scripts to execute is taken from
                   5020: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5021: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5022: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5023: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5024: commands, so they have the potential to create and manage files
                   5025: anywhere in the file system.</p>
                   5026: <p>Using these general installation files is not recommended, but
                   5027: may be needed in some special cases.  One reason for avoiding them is
                   5028: that the user has to trust the packager that there is no unwanted or
                   5029: simply erroneous code included in the installation script. Also,
                   5030: previously there were many similar scripts for the same functionality,
                   5031: and fixing a common error involved finding and changing all of
                   5032: them.</p>
                   5033: <p>The pkginstall framework offers another, standardized way.  It
                   5034: provides generic scripts to abstract the manipulation of such files
                   5035: and directories based on variables set in the package's
                   5036: <code class="filename">Makefile</code>.  The rest of this section describes
                   5037: these variables.</p>
1.148     asau     5038: <div class="sect2">
1.75      rillig   5039: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5040: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5041: <p>The following variables can be set to request the creation of
                   5042: directories anywhere in the file system:</p>
1.148     asau     5043: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.218     rillig   5044: <li class="listitem">
                   5045: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75      rillig   5046:     contain a list of directories that should be created and should attempt
                   5047:     to be destroyed by the installation scripts.  The difference between
                   5048:     the two is that the latter prompts the administrator to remove any
                   5049:     directories that may be left after deinstallation (because they were
1.218     rillig   5050:     not empty), while the former does not.  Example:</p>
                   5051: <pre class="programlisting">
                   5052: MAKE_DIRS+=             ${VARBASE}/foo/private
                   5053: </pre>
                   5054: </li>
1.128     wiz      5055: <li class="listitem">
1.75      rillig   5056: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5057:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5058:     which directories should be created and should attempt to be destroyed
                   5059:     by the installation scripts.  Each tuple holds the following values,
                   5060:     separated by spaces: the directory name, its owner, its group and its
                   5061:     numerical mode.  For example:</p>
                   5062: <pre class="programlisting">
1.218     rillig   5063: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   5064:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5065: </pre>
1.75      rillig   5066: <p>The difference between the two is exactly the same as their
                   5067:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5068: </li>
                   5069: </ul></div>
                   5070: </div>
1.148     asau     5071: <div class="sect2">
1.75      rillig   5072: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5073: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5074: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5075: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5076: To overcome this problem, the only solution is to extract the file in the
                   5077: known place (i.e., inside the installation prefix) and copy it to the
                   5078: appropriate location during installation (done by the installation scripts
                   5079: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5080: file</em></span> in the following paragraphs, which describe the variables
                   5081: that can be used to automatically and consistently handle files outside the
                   5082: installation prefix:</p>
1.148     asau     5083: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5084: <li class="listitem">
1.75      rillig   5085: <p><code class="varname">CONF_FILES</code> and
1.137     wiz      5086:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75      rillig   5087:     During installation time, the master file is copied to the target one
                   5088:     if and only if the latter does not exist.  Upon deinstallation, the
                   5089:     target file is removed provided that it was not modified by the
                   5090:     installation.</p>
                   5091: <p>The difference between the two is that the latter prompts the
                   5092:     administrator to remove any files that may be left after
                   5093:     deinstallation (because they were not empty), while the former does
                   5094:     not.</p>
                   5095: </li>
1.128     wiz      5096: <li class="listitem">
1.75      rillig   5097: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137     wiz      5098:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75      rillig   5099:     files as well as their target locations.  For each of them, it also
                   5100:     specifies their owner, their group and their numeric permissions, in
                   5101:     this order.  For example:</p>
                   5102: <pre class="programlisting">
1.218     rillig   5103: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   5104:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5105: </pre>
1.75      rillig   5106: <p>The difference between the two is exactly the same as their
                   5107:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5108: </li>
                   5109: </ul></div>
                   5110: </div>
                   5111: </div>
1.148     asau     5112: <div class="sect1">
1.75      rillig   5113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5114: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   5115: <p>Configuration files are special in the sense that they are installed
                   5116: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5117: need special treatment during installation (most of which is automated by
                   5118: pkginstall).  The main concept you must bear in mind is that files marked
                   5119: as configuration files are automatically copied to the right place (somewhere
                   5120: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5121: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5122: be removed if they have local modifications.  This ensures that
                   5123: administrators never lose any custom changes they may have made.</p>
1.148     asau     5124: <div class="sect2">
1.75      rillig   5125: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5126: <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   5127: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5128: specifies where configuration files shall be installed.  Its contents are
                   5129: set based upon the following variables:</p>
1.148     asau     5130: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5131: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5132:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5133:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5134:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5135:     Packages must not use it directly.</p></li>
1.128     wiz      5136: <li class="listitem">
1.75      rillig   5137: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5138:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5139:     for the package being built shall be installed.  The definition of this
                   5140:     variable only makes sense in the package's
1.76      rillig   5141:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5142: <p>As an example, consider the Apache package,
1.250     leot     5143:     <a href="https://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   5144:     configuration files under the
1.76      rillig   5145:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5146:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5147:     Makefile.</p>
                   5148: </li>
1.128     wiz      5149: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75      rillig   5150:     variable that holds this package's configuration directory (if
                   5151:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5152:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5153:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128     wiz      5154: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75      rillig   5155:     directory where the configuration files for the package identified by
                   5156:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5157: </ul></div>
                   5158: <p>Based on the above variables, pkginstall determines the value of
                   5159: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5160: variable that can be used within a package to refer to its configuration
                   5161: directory.  The algorithm used to set its value is basically the
                   5162: following:</p>
1.128     wiz      5163: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5164: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75      rillig   5165:     its value is used.</p></li>
1.128     wiz      5166: <li class="listitem"><p>If the previous variable is not defined but
1.75      rillig   5167:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5168:     <code class="filename">Makefile</code>, the resulting value is
                   5169:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128     wiz      5170: <li class="listitem"><p>Otherwise, it is set to
1.76      rillig   5171:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5172: </ol></div>
1.76      rillig   5173: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117     jnemeth  5174: 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
                   5175: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   5176: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   5177: </div>
1.148     asau     5178: <div class="sect2">
1.75      rillig   5179: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5180: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   5181: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5182: known place, you need to teach each package where it shall install its
                   5183: files.  In some cases you will have to patch the package Makefiles to
                   5184: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5185: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5186: generated files:</p>
                   5187: <pre class="programlisting">
1.100     rillig   5188: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    5189: </pre>
1.75      rillig   5190: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5191: for</em></span> its configuration files, not where they will be originally
                   5192: installed (although the difference is never explicit,
                   5193: unfortunately).</p>
                   5194: </div>
1.148     asau     5195: <div class="sect2">
1.75      rillig   5196: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5197: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   5198: <p>As said before, pkginstall automatically handles configuration files.
                   5199: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   5200: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   5201: directly</strong></span>.  Bad news is that many software installation scripts
                   5202: will, out of the box, mess with the contents of that directory.  So what is
                   5203: the correct procedure to fix this issue?</p>
                   5204: <p>You must teach the package (usually by manually patching it) to
                   5205: install any configuration files under the examples hierarchy,
1.76      rillig   5206: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5207: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   5208: has the original copies available.</p>
                   5209: <p>Once the required configuration files are in place (i.e., under the
                   5210: examples hierarchy), the pkginstall framework can use them as master copies
                   5211: during the package installation to update what is in
1.76      rillig   5212: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   5213: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  5214: 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   5215: about their syntax and their purpose.  Here is an example, taken from the
1.250     leot     5216: <a href="https://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   5217: <pre class="programlisting">
1.100     rillig   5218: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5219: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    5220: </pre>
1.75      rillig   5221: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5222: package and has no meaning outside it.</p>
                   5223: </div>
1.148     asau     5224: <div class="sect2">
1.75      rillig   5225: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5226: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   5227: <p>The automatic copying of config files can be toggled by setting the
                   5228: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5229: installation.</p>
                   5230: </div>
                   5231: </div>
1.148     asau     5232: <div class="sect1">
1.75      rillig   5233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5234: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   5235: <p>System startup scripts are special files because they must be
                   5236: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  5237: 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   5238: can be used.  However, pkginstall provides a special mechanism to handle
                   5239: these files.</p>
                   5240: <p>In order to provide system startup scripts, the package has
                   5241: to:</p>
1.128     wiz      5242: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5243: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   5244:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.250     leot     5245:     <a href="https://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   5246:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128     wiz      5247: <li class="listitem">
1.75      rillig   5248: <p>Tell pkginstall to handle it, appending the name of the script,
                   5249:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5250:     Continuing the previous example:</p>
                   5251: <pre class="programlisting">
1.100     rillig   5252: RCD_SCRIPTS+=   cupsd
1.1       grant    5253: </pre>
1.75      rillig   5254: </li>
                   5255: </ol></div>
                   5256: <p>Once this is done, pkginstall will do the following steps for each
                   5257: script in an automated fashion:</p>
1.128     wiz      5258: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5259: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76      rillig   5260:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   5261:     variable.</p></li>
1.128     wiz      5262: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76      rillig   5263:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   5264:     that this master file must be explicitly registered in the
1.76      rillig   5265:     <code class="filename">PLIST</code>.</p></li>
1.128     wiz      5266: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75      rillig   5267:     from the examples hierarchy into the system-wide startup scripts
                   5268:     directory.</p></li>
                   5269: </ol></div>
1.148     asau     5270: <div class="sect2">
1.75      rillig   5271: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5272: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   5273: <p>The automatic copying of config files can be toggled by setting the
                   5274: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   5275: installation.  Note that the scripts will be always copied inside the
1.76      rillig   5276: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   5277: matter what the value of this variable is.</p>
                   5278: </div>
                   5279: </div>
1.148     asau     5280: <div class="sect1">
1.75      rillig   5281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5282: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   5283: <p>If a package needs to create special users and/or groups during
                   5284: installation, it can do so by using the pkginstall framework.</p>
                   5285: <p>Users can be created by adding entries to the
                   5286: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   5287: syntax:</p>
                   5288: <pre class="programlisting">
1.100     rillig   5289: user:group
1.1       grant    5290: </pre>
1.87      wiz      5291: <p>Further specification of user details may be done by setting
                   5292: per-user variables.
                   5293: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   5294: numeric UID for the user.
                   5295: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   5296: user's description or comment.
                   5297: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   5298: user's home directory, and defaults to
                   5299: <code class="filename">/nonexistent</code> if not specified.
                   5300: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 5301: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      5302: not specified.</p>
1.75      rillig   5303: <p>Similarly, groups can be created by adding entries to the
                   5304: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   5305: <pre class="programlisting">
1.100     rillig   5306: group
1.1       grant    5307: </pre>
1.93      rillig   5308: <p>The numeric GID of the group may be set by defining
1.75      rillig   5309: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   5310: <p>If a package needs to create the users and groups at an earlier
1.227     wiz      5311: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   5312: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   5313: <code class="literal">pre-install</code> to indicate the phase before which the
                   5314: users and groups are created. In this case, the numeric UIDs and GIDs
                   5315: of the created users and groups are automatically hardcoded into the
                   5316: final installation scripts.</p>
1.75      rillig   5317: </div>
1.148     asau     5318: <div class="sect1">
1.75      rillig   5319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5320: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   5321: <p>Packages that install system shells should register them in the shell
1.76      rillig   5322: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   5323: administrator.  This must be done from the installation scripts to keep
                   5324: binary packages working on any system.  pkginstall provides an easy way to
                   5325: accomplish this task.</p>
                   5326: <p>When a package provides a shell interpreter, it has to set the
                   5327: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   5328: add some hooks to the installation scripts to handle it.  Consider the
1.250     leot     5329: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75      rillig   5330: <pre class="programlisting">
1.100     rillig   5331: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    5332: </pre>
1.148     asau     5333: <div class="sect2">
1.75      rillig   5334: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5335: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   5336: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   5337: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   5338: environment variable to <code class="literal">NO</code>.</p>
                   5339: </div>
                   5340: </div>
1.148     asau     5341: <div class="sect1">
1.75      rillig   5342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5343: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   5344: <p>Packages that install X11 fonts should update the database files
                   5345: that index the fonts within each fonts directory.  This can easily be
                   5346: accomplished within the pkginstall framework.</p>
                   5347: <p>When a package installs X11 fonts, it must list the directories in
                   5348: which fonts are installed in the
                   5349: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128     wiz      5350: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   5351: <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   5352: installation scripts to run the appropriate commands to update the fonts
                   5353: database files within each of those directories.  For convenience, if the
                   5354: directory path is relative, it is taken to be relative to the package's
1.250     leot     5355: installation prefix.  Consider the following example, taken from <a href="https://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   5356: <pre class="programlisting">
1.175     wiz      5357: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       grant    5358: </pre>
1.148     asau     5359: <div class="sect2">
1.75      rillig   5360: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5361: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   5362: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   5363: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   5364: environment variable to <code class="literal">NO</code>.</p>
                   5365: </div>
                   5366: </div>
                   5367: </div>
1.148     asau     5368: <div class="chapter">
1.75      rillig   5369: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5370: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   5371: <div class="toc">
                   5372: <p><b>Table of Contents</b></p>
1.210     leot     5373: <dl class="toc">
1.106     rillig   5374: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      5375: <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   5376: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   5377: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   5378: </dl>
                   5379: </div>
                   5380: <p>Many packages have the ability to be built to support different
1.76      rillig   5381: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   5382: in pkgsrc that provides generic handling of those options that
                   5383: determine different ways in which the packages can be built.  It's
                   5384: possible for the user to specify exactly which sets of options will be
                   5385: built into a package or to allow a set of global default options
                   5386: apply.</p>
1.107     rillig   5387: <p>There are two broad classes of behaviors that one might want to
                   5388: control via options.  One is whether some particular feature is
                   5389: enabled in a program that will be built anyway, often by including or
                   5390: not including a dependency on some other package.  The other is
                   5391: whether or not an additional program will be built as part of the
                   5392: package.  Generally, it is better to make a split package for such
                   5393: additional programs instead of using options, because it enables
                   5394: binary packages to be built which can then be added separately.  For
                   5395: example, the foo package might have minimal dependencies (those
                   5396: packages without which foo doesn't make sense), and then the foo-gfoo
                   5397: package might include the GTK frontend program gfoo.  This is better
                   5398: than including a gtk option to foo that adds gfoo, because either that
                   5399: option is default, in which case binary users can't get foo without
                   5400: gfoo, or not default, in which case they can't get gfoo.  With split
                   5401: packages, they can install foo without having GTK, and later decide to
                   5402: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5403: source users too, avoiding the need for rebuilds.</p>
                   5404: <p>Plugins with widely varying dependencies should usually be split
                   5405: instead of options.</p>
                   5406: <p>It is often more work to maintain split packages, especially if
                   5407: the upstream package does not support this.  The decision of split
                   5408: vs. option should be made based on the likelihood that users will want
                   5409: or object to the various pieces, the size of the dependencies that are
                   5410: included, and the amount of work.</p>
                   5411: <p>A further consideration is licensing.  Non-free parts, or parts
                   5412: that depend on non-free dependencies (especially plugins) should
                   5413: almost always be split if feasible.</p>
1.148     asau     5414: <div class="sect1">
1.75      rillig   5415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5416: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   5417: <p>Global default options are listed in
                   5418: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5419: that should be built into every package if that option is supported.
1.110     hubertf  5420: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5421: </div>
1.148     asau     5422: <div class="sect1">
1.75      rillig   5423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5424: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   5425: </h2></div></div></div>
1.75      rillig   5426: <p>The following example shows how
1.76      rillig   5427: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   5428: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   5429: <code class="filename">Makefile</code>, or in a file,
                   5430: e.g. <code class="filename">options.mk</code>, that is included by the
                   5431: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5432: <pre class="programlisting">
1.100     rillig   5433: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5434: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5435: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5436: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5437: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5438: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5439: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5440: 
                   5441: .include "../../mk/bsd.prefs.mk"
                   5442: 
                   5443: # this package was previously named wibble2
                   5444: .if defined(PKG_OPTIONS.wibble2)
                   5445: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5446: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5447:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5448: .endif
                   5449: 
                   5450: .include "../../mk/bsd.options.mk"
                   5451: 
                   5452: # Package-specific option-handling
                   5453: 
                   5454: ###
                   5455: ### FOO support
                   5456: ###
                   5457: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5458: CONFIGURE_ARGS+=    --enable-foo
                   5459: .endif
                   5460: 
                   5461: ###
                   5462: ### LDAP support
                   5463: ###
                   5464: .if !empty(PKG_OPTIONS:Mldap)
                   5465: .  include "../../databases/openldap-client/buildlink3.mk"
                   5466: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5467: .endif
                   5468: 
                   5469: ###
                   5470: ### database support
                   5471: ###
                   5472: .if !empty(PKG_OPTIONS:Mmysql)
                   5473: .  include "../../mk/mysql.buildlink3.mk"
                   5474: .endif
                   5475: .if !empty(PKG_OPTIONS:Mpgsql)
                   5476: .  include "../../mk/pgsql.buildlink3.mk"
                   5477: .endif
1.75      rillig   5478: </pre>
                   5479: <p>The first section contains the information about which build
                   5480: options are supported by the package, and any default options settings
                   5481: if needed.</p>
1.128     wiz      5482: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5483: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.257     leot     5484: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75      rillig   5485: options.  It should be set to
1.78      rillig   5486: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5487: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5488: at the point where the options are processed.</p></li>
1.128     wiz      5489: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75      rillig   5490: build options supported by the package.</p></li>
1.128     wiz      5491: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75      rillig   5492: list of names of groups of mutually exclusive options.  The options in
                   5493: each group are listed in
                   5494: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5495: The most specific setting of any option from the group takes
                   5496: precedence over all other options in the group.  Options from the
                   5497: groups will be automatically added to
                   5498: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128     wiz      5499: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75      rillig   5500: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5501: packages will fail if no option from the group is
                   5502: selected.</p></li>
1.128     wiz      5503: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75      rillig   5504: of names of sets of options.  At least one option from each set must
                   5505: be selected.  The options in each set are listed in
                   5506: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5507: Options from the sets will be automatically added to
                   5508: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5509: fail if no option from the set is selected.</p></li>
1.128     wiz      5510: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75      rillig   5511: build options which are enabled by default.</p></li>
1.128     wiz      5512: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75      rillig   5513: of
1.128     wiz      5514: <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  5515: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   5516: their option counterparts.  Pairs should be added with
1.128     wiz      5517: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.75      rillig   5518: warning will be issued if the user uses a legacy
                   5519: variable.</p></li>
1.128     wiz      5520: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75      rillig   5521: of
1.128     wiz      5522: <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   5523: pairs that map options that have been renamed to their new
1.128     wiz      5524: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.75      rillig   5525: the listing of global legacy options.  A warning will be issued if
                   5526: the user uses a legacy option.</p></li>
1.128     wiz      5527: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75      rillig   5528: options implied by deprecated variables used.  This can be used for
                   5529: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5530: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5531: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128     wiz      5532: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75      rillig   5533: a list of warnings about deprecated variables or options used, and
                   5534: what to use instead.</p></li>
                   5535: </ol></div>
                   5536: <p>A package should never modify
                   5537: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5538: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5539: To suggest a default set of options, use
                   5540: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5541: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   5542: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   5543: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5544: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5545: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5546: happen with platform-specific options if none of them is supported on
                   5547: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5548: empty list and the package is otherwise treated as not using the
                   5549: options framework.</p>
1.76      rillig   5550: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   5551: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5552: build options, properly filtered to remove unsupported and duplicate
                   5553: options.</p>
                   5554: <p>The remaining sections contain the logic that is specific to
                   5555: each option.  The correct way to check for an option is to check
                   5556: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5557: <pre class="programlisting">
1.100     rillig   5558: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   5559: </pre>
                   5560: </div>
1.148     asau     5561: <div class="sect1">
1.75      rillig   5562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5563: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   5564: <p>Options that enable similar features in different packages (like
                   5565: optional support for a library) should use a common name in all
                   5566: packages that support it (like the name of the library).  If another
                   5567: package already has an option with the same meaning, use the same
                   5568: name.</p>
                   5569: <p>Options that enable features specific to one package, where it's
                   5570: unlikely that another (unrelated) package has the same (or a similar)
                   5571: optional feature, should use a name prefixed with
                   5572: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5573: <p>If a group of related packages share an optional feature
                   5574: specific to that group, prefix it with the name of the
1.128     wiz      5575: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.75      rillig   5576: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5577: <p>For new options, add a line to
1.76      rillig   5578: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   5579: fields, separated by tab.  The first field is the option name, the
                   5580: second its description.  The description should be a whole sentence
                   5581: (starting with an uppercase letter and ending with a period) that
1.128     wiz      5582: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5583: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.75      rillig   5584: </div>
1.148     asau     5585: <div class="sect1">
1.107     rillig   5586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5587: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  5588: <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   5589: different dependencies based on the options with which the package was
                   5590: built. For querying these options, the file
                   5591: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5592: typical example looks like this:</p>
                   5593: <pre class="programlisting">
                   5594: pkgbase := libpurple
                   5595: .include "../../mk/pkg-build-options.mk"
                   5596: 
                   5597: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5598: ...
                   5599: .endif
                   5600: </pre>
                   5601: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5602: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5603: options of the libpurple package, which can then be queried like
                   5604: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5605: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5606: details.</p>
                   5607: </div>
1.75      rillig   5608: </div>
1.148     asau     5609: <div class="chapter">
1.75      rillig   5610: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5611: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   5612: <div class="toc">
                   5613: <p><b>Table of Contents</b></p>
1.210     leot     5614: <dl class="toc">
1.106     rillig   5615: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   5616: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   5617: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   5618: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      5619: <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   5620: <dd><dl>
                   5621: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   5622: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   5623: </dl></dd>
1.128     wiz      5624: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   5625: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   5626: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   5627: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   5628: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   5629: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   5630: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   5631: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   5632: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   5633: <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   5634: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   5635: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   5636: </dl>
                   5637: </div>
1.148     asau     5638: <div class="sect1">
1.75      rillig   5639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5640: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   5641: <p>This chapter gives a detailed description on how a package is
1.87      wiz      5642:     built. Building a package is separated into different
                   5643:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   5644:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120     snj      5645:     described in the following sections. Each phase is split into
1.87      wiz      5646:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   5647:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   5648:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   5649:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   5650:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   5651: <p>Never override the regular targets (like
                   5652:     <code class="varname">fetch</code>), if you have to, override the
                   5653:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   5654: <p>The basic steps for building a program are always the same.  First
1.87      wiz      5655:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   5656:     the local system and then extracted. After any pkgsrc-specific patches
                   5657:     to compile properly are applied, the software can be configured, then
                   5658:     built (usually by compiling), and finally the generated binaries, etc.
                   5659:     can be put into place on the system.</p>
1.97      rillig   5660: <p>To get more details about what is happening at each step,
                   5661:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   5662:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   5663:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   5664: </div>
1.148     asau     5665: <div class="sect1">
1.75      rillig   5666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5667: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   5668: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      5669:     the next section, here's a brief discussion on where programs are
                   5670:     installed, and which variables influence this.</p>
1.75      rillig   5671: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      5672:     where all files of the final program shall be installed. It is
                   5673:     usually set to <code class="varname">LOCALBASE</code>
                   5674:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      5675:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      5676:     <code class="varname">PREFIX</code> needs to be put
                   5677:     into the various places in the program's source where paths to
1.219     rillig   5678:     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   5679: <p>When choosing which of these variables to use,
1.87      wiz      5680:     follow the following rules:</p>
1.148     asau     5681: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5682: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88      wiz      5683:        where the current pkg will be installed.  When referring to a
                   5684:        pkg's own installation path, use
1.128     wiz      5685:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   5686: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88      wiz      5687:        are installed.  If you need to construct a -I or -L argument
                   5688:        to the compiler to find includes and libraries installed by
1.128     wiz      5689:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.87      wiz      5690:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   5691:        installed all packages in <code class="filename">/usr/local</code>. As
                   5692:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   5693:        administrator, this variable is a misnomer.</p></li>
1.128     wiz      5694: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88      wiz      5695:        distribution (from xsrc, etc.) is installed. When looking for
                   5696:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128     wiz      5697:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
1.209     sevan    5698: <li class="listitem"><p>X11-based packages using imake must set
                   5699:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   5700:        <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      5701: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.257     leot     5702:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87      wiz      5703:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   5704:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   5705: </ul></div>
                   5706: </div>
1.148     asau     5707: <div class="sect1">
1.75      rillig   5708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5709: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 5710: <p>When building a package, various directories are used to store
1.87      wiz      5711:     source files, temporary files, pkgsrc-internal files, and so on. These
                   5712:     directories are explained here.</p>
1.75      rillig   5713: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      5714:     are two common base directories for these relative directories:
                   5715:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   5716:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   5717:     inside the package itself.</p>
1.148     asau     5718: <div class="variablelist"><dl class="variablelist">
1.75      rillig   5719: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   5720: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      5721:       root directory. Generally, you don't need
                   5722:       it.</p></dd>
1.97      rillig   5723: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   5724: <dd><p>This is an absolute pathname that points to the
                   5725:       current package.</p></dd>
1.75      rillig   5726: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   5727: <dd><p>This is a pathname relative to
1.87      wiz      5728:       <code class="varname">PKGSRCDIR</code> that points to the current
                   5729:       package.</p></dd>
1.75      rillig   5730: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   5731: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   5732:       where all work takes place. The distfiles are extracted to this
1.87      wiz      5733:       directory. It also contains temporary directories and log files used by
                   5734:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   5735:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   5736: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   5737: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      5738:       where the distfiles are extracted. It is usually a direct subdirectory
                   5739:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   5740:       that isn't hidden. This variable may be changed by a package
                   5741:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   5742: </dl></div>
1.114     jmcneill 5743: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   5744:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   5745:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 5746:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   5747:     If users would like to have their pkgsrc trees behave in a
                   5748:     read-only manner, then the value of
                   5749:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   5750:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   5751: </div>
1.148     asau     5752: <div class="sect1">
1.75      rillig   5753: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5754: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  5755: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      5756:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   5757:     phase. This will automatically run all phases that are required for this
                   5758:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  5759:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      5760:     the package will be built, but not installed.</p>
1.75      rillig   5761: </div>
1.148     asau     5762: <div class="sect1">
1.75      rillig   5763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5764: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   5765: <p>The first step in building a package is to fetch the
1.88      wiz      5766:     distribution files (distfiles) from the sites that are providing
                   5767:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   5768:     phase.</p>
1.148     asau     5769: <div class="sect2">
1.81      rillig   5770: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5771: <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      5772: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   5773:       defines all URLs from where the distfile, whose name is
                   5774:       derived from the <code class="varname">DISTNAME</code> variable, is
                   5775:       fetched. The more complicated cases are described
                   5776:       below.</p>
                   5777: <p>The variable <code class="varname">DISTFILES</code> specifies
                   5778:       the list of distfiles that have to be fetched. Its value
1.174     asau     5779:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   5780:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88      wiz      5781:       so that most packages don't need to define it at all.
                   5782:       <code class="varname">EXTRACT_SUFX</code> is
                   5783:       <code class="literal">.tar.gz</code> by default, but can be changed
                   5784:       freely. Note that if your package requires additional
                   5785:       distfiles to the default one, you cannot just append the
                   5786:       additional filenames using the <code class="literal">+=</code>
                   5787:       operator, but you have write for example:</p>
1.81      rillig   5788: <pre class="programlisting">
1.174     asau     5789: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100     rillig   5790: </pre>
1.88      wiz      5791: <p>Each distfile is fetched from a list of sites, usually
                   5792:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   5793:       <code class="varname">DISTFILES</code> or multiple
                   5794:       <code class="varname">PATCHFILES</code> from different sites, you can
                   5795:       set
                   5796:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   5797:       to the list of URLs where the file
                   5798:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   5799:       (including the suffix) can be found.</p>
                   5800: <pre class="programlisting">
1.100     rillig   5801: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   5802: DISTFILES+=     foo-file.tar.gz
                   5803: SITES.foo-file.tar.gz= \
                   5804: http://www.somewhere.com/somehow/ \
                   5805: http://www.somewhereelse.com/mirror/somehow/
                   5806: </pre>
1.81      rillig   5807: <p>When actually fetching the distfiles, each item from
1.88      wiz      5808:       <code class="varname">MASTER_SITES</code> or
                   5809:       <code class="varname">SITES.*</code> gets the name of each distfile
                   5810:       appended to it, without an intermediate slash. Therefore,
                   5811:       all site values have to end with a slash or other separator
                   5812:       character. This allows for example to set
                   5813:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   5814:       that gets the name of the distfile as a parameter. In this
                   5815:       case, the definition would look like:</p>
1.81      rillig   5816: <pre class="programlisting">
1.100     rillig   5817: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   5818: </pre>
1.125     wiz      5819: <p> The exception to this rule are URLs starting with a dash.
1.174     asau     5820:       In that case the URL is taken as is, fetched and the result
                   5821:       stored under the name of the distfile. You can use this style
                   5822:       for the case when the download URL style does not match the
                   5823:       above common case. For example, if permanent download URL is a
                   5824:       redirector to the real download URL, or the download file name
                   5825:       is offered by an HTTP Content-Disposition header. In the
                   5826:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   5827:       created instead of the default
                   5828:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   5829: <pre class="programlisting">
                   5830: DISTNAME=       foo-1.0.0
                   5831: MASTER_SITES=   -http://www.example.com/archive/v1.0.0.tar.gz
                   5832: </pre>
1.81      rillig   5833: <p>There are some predefined values for
1.88      wiz      5834:       <code class="varname">MASTER_SITES</code>, which can be used in
                   5835:       packages.  The names of the variables should speak for
                   5836:       themselves.</p>
                   5837: <pre class="programlisting">
1.100     rillig   5838: ${MASTER_SITE_APACHE}
                   5839: ${MASTER_SITE_BACKUP}
                   5840: ${MASTER_SITE_CYGWIN}
                   5841: ${MASTER_SITE_DEBIAN}
                   5842: ${MASTER_SITE_FREEBSD}
                   5843: ${MASTER_SITE_FREEBSD_LOCAL}
                   5844: ${MASTER_SITE_GENTOO}
                   5845: ${MASTER_SITE_GNOME}
                   5846: ${MASTER_SITE_GNU}
                   5847: ${MASTER_SITE_GNUSTEP}
1.174     asau     5848: ${MASTER_SITE_HASKELL_HACKAGE}
1.100     rillig   5849: ${MASTER_SITE_IFARCHIVE}
                   5850: ${MASTER_SITE_KDE}
                   5851: ${MASTER_SITE_MOZILLA}
1.174     asau     5852: ${MASTER_SITE_MOZILLA_ALL}
                   5853: ${MASTER_SITE_MOZILLA_ESR}
1.100     rillig   5854: ${MASTER_SITE_MYSQL}
1.174     asau     5855: ${MASTER_SITE_NETLIB}
1.100     rillig   5856: ${MASTER_SITE_OPENOFFICE}
1.208     ryoon    5857: ${MASTER_SITE_OSDN}
1.100     rillig   5858: ${MASTER_SITE_PERL_CPAN}
                   5859: ${MASTER_SITE_PGSQL}
1.174     asau     5860: ${MASTER_SITE_RUBYGEMS}
1.100     rillig   5861: ${MASTER_SITE_R_CRAN}
                   5862: ${MASTER_SITE_SOURCEFORGE}
                   5863: ${MASTER_SITE_SUNSITE}
                   5864: ${MASTER_SITE_SUSE}
                   5865: ${MASTER_SITE_TEX_CTAN}
                   5866: ${MASTER_SITE_XCONTRIB}
                   5867: ${MASTER_SITE_XEMACS}
1.174     asau     5868: ${MASTER_SITE_XORG}
1.100     rillig   5869: </pre>
1.88      wiz      5870: <p>Some explanations for the less self-explaining ones:
                   5871:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133     wiz      5872:       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      5873:       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      5874: <p>If you choose one of these predefined sites, you may
                   5875:       want to specify a subdirectory of that site. Since these
                   5876:       macros may expand to more than one actual site, you
                   5877:       <span class="emphasis"><em>must</em></span> use the following construct to
                   5878:       specify a subdirectory:</p>
1.81      rillig   5879: <pre class="programlisting">
1.100     rillig   5880: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   5881: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   5882: </pre>
1.81      rillig   5883: <p>Note the trailing slash after the subdirectory
1.88      wiz      5884:       name.</p>
1.81      rillig   5885: </div>
1.148     asau     5886: <div class="sect2">
1.81      rillig   5887: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5888: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      5889: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   5890:       all the distfiles exist in a local directory
1.93      rillig   5891:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      5892:       user). If the files do not exist, they are fetched using
                   5893:       commands of the form</p>
1.75      rillig   5894: <pre class="programlisting">
1.100     rillig   5895: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   5896: </pre>
1.88      wiz      5897: <p>where <code class="literal">${site}</code> varies through
                   5898:       several possibilities in turn: first,
                   5899:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   5900:       sites specified in either <code class="varname">SITES.file</code> if
                   5901:       defined, else <code class="varname">MASTER_SITES</code> or
                   5902:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   5903:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   5904:       all except the first and the last can be optionally sorted
                   5905:       by the user, via setting either
                   5906:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   5907:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      5908:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  5909: <p> The specific command and arguments used depend on the
                   5910:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   5911:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   5912: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   5913:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   5914:       distfiles, if they are freely distributable.  Packages setting
                   5915:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128     wiz      5916:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.97      rillig   5917:       mirrored.</p>
1.81      rillig   5918: </div>
1.75      rillig   5919: </div>
1.148     asau     5920: <div class="sect1">
1.75      rillig   5921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5922: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      5923: <p>After the distfile(s) are fetched, their checksum is
                   5924:     generated and compared with the checksums stored in the
                   5925:     distinfo file. If the checksums don't match, the build is
                   5926:     aborted. This is to ensure the same distfile is used for
                   5927:     building, and that the distfile wasn't changed, e.g. by some
                   5928:     malign force, deliberately changed distfiles on the master
                   5929:     distribution site or network lossage.</p>
1.75      rillig   5930: </div>
1.148     asau     5931: <div class="sect1">
1.75      rillig   5932: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5933: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   5934: <p>When the distfiles are present on the local system, they
1.88      wiz      5935:     need to be extracted, as they usually come in the form of some
                   5936:     compressed archive format.</p>
1.75      rillig   5937: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      5938:     extracted. If you only need some of them, you can set the
                   5939:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   5940:     files.</p>
                   5941: <p>Extracting the files is usually done by a little
1.93      rillig   5942:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      5943:     already knows how to extract various archive formats, so most
                   5944:     likely you will not need to change anything here. But if you
                   5945:     need, the following variables may help you:</p>
1.148     asau     5946: <div class="variablelist"><dl class="variablelist">
1.75      rillig   5947: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   5948: <dd><p>Use these variables to override the default
1.88      wiz      5949:       options for an extract command, which are defined in
1.93      rillig   5950:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   5951: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   5952: <dd><p>This variable can be set to
1.114     jmcneill 5953:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   5954:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      5955:       absolute pathname pointing to the command with which tar
1.114     jmcneill 5956:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   5957:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   5958: </dl></div>
1.88      wiz      5959: <p>If the <code class="filename">extract</code> program doesn't
                   5960:     serve your needs, you can also override the
                   5961:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   5962:     command used for extracting the files. This command is
                   5963:     executed in the <code class="filename">${WRKSRC}</code>
                   5964:     directory. During execution of this command, the shell
                   5965:     variable <code class="varname">extract_file</code> holds the absolute
                   5966:     pathname of the file that is going to be extracted.</p>
1.75      rillig   5967: <p>And if that still does not suffice, you can override the
1.88      wiz      5968:     <code class="varname">do-extract</code> target in the package
                   5969:     Makefile.</p>
1.75      rillig   5970: </div>
1.148     asau     5971: <div class="sect1">
1.75      rillig   5972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5973: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   5974: <p>After extraction, all the patches named by the
1.88      wiz      5975:     <code class="varname">PATCHFILES</code>, those present in the patches
                   5976:     subdirectory of the package as well as in
                   5977:     $LOCALPATCHES/$PKGPATH (e.g.
                   5978:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   5979:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   5980:     <code class="filename">.gz</code> are uncompressed before they are
                   5981:     applied, files ending in <code class="filename">.orig</code> or
                   5982:     <code class="filename">.rej</code> are ignored. Any special options to
1.257     leot     5983:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.219     rillig   5984:     <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.257     leot     5985: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88      wiz      5986:     it fail if the patches apply with some lines of fuzz. Please
                   5987:     fix (regen) the patches so that they apply cleanly. The
                   5988:     rationale behind this is that patches that don't apply cleanly
                   5989:     may end up being applied in the wrong place, and cause severe
                   5990:     harm there.</p>
1.75      rillig   5991: </div>
1.148     asau     5992: <div class="sect1">
1.75      rillig   5993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5994: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  5995: <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      5996:     </p>
1.75      rillig   5997: </div>
1.148     asau     5998: <div class="sect1">
1.75      rillig   5999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6000: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6001: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6002:     linkers. The following variables can be used to tweak the
                   6003:     wrappers.</p>
1.148     asau     6004: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6005: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6006: <dd><p>The command used to print progress
1.88      wiz      6007:       messages. Does nothing by default. Set to
                   6008:       <code class="literal">${ECHO}</code> to see the progress
                   6009:       messages.</p></dd>
1.75      rillig   6010: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6011: <dd><p>This variable can be set to
1.88      wiz      6012:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6013:       depending on whether you want additional information in the
                   6014:       wrapper log file.</p></dd>
1.75      rillig   6015: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6016: <dd><p>This variable can be set to
1.88      wiz      6017:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6018:       on whether the wrapper should use its cache, which will
                   6019:       improve the speed. The default value is
                   6020:       <code class="literal">yes</code>, but is forced to
                   6021:       <code class="literal">no</code> if the platform does not support
                   6022:       it.</p></dd>
1.75      rillig   6023: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6024: <dd><p>A list of reordering commands. A reordering
                   6025:       command has the form
                   6026:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6027:       It ensures that that
                   6028:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6029:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6030:       </p></dd>
1.75      rillig   6031: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6032: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6033:       investigate further]</p></dd>
1.75      rillig   6034: </dl></div>
                   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.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6039: <p>Most pieces of software need information on the header
                   6040:     files, system calls, and library routines which are available
                   6041:     on the platform they run on. The process of determining this
                   6042:     information is known as configuration, and is usually
                   6043:     automated. In most cases, a script is supplied with the
                   6044:     distfiles, and its invocation results in generation of header
                   6045:     files, Makefiles, etc.</p>
                   6046: <p>If the package contains a configure script, this can be
                   6047:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128     wiz      6048:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.88      wiz      6049:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128     wiz      6050:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.88      wiz      6051:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6052: <pre class="programlisting">
1.100     rillig   6053: .for d in ${CONFIGURE_DIRS}
                   6054:         cd ${WRKSRC} \
                   6055:         &amp;&amp; cd ${d} \
                   6056:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6057: .endfor
                   6058: </pre>
1.88      wiz      6059: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128     wiz      6060:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6061:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6062:     configure script is run with the environment
                   6063:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6064:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6065:     <code class="varname">CONFIGURE_ENV</code>,
                   6066:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128     wiz      6067:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.88      wiz      6068:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6069:     package.</p>
1.144     wiz      6070: <p>If the program uses the Perl way of configuration (mainly Perl
                   6071:     modules, but not only), i.e. a file called
                   6072:     <code class="filename">Makefile.PL</code>, it should include
                   6073:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6074:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6075:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88      wiz      6076: <p>If the program uses an <code class="filename">Imakefile</code>
                   6077:     for configuration, the appropriate steps can be invoked by
                   6078:     setting <code class="varname">USE_IMAKE</code> to
1.209     sevan    6079:     <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>.
                   6080:     You can add variables to xmkmf's environment by adding them to the
1.97      rillig   6081:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   6082: <p>If the program uses <code class="filename">cmake</code>
                   6083:     for configuration, the appropriate steps can be invoked by
1.128     wiz      6084:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.111     rillig   6085:     You can add variables to cmake's environment by adding them to the
                   6086:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6087:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6088:     The top directory argument is given by the
                   6089:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128     wiz      6090:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   6091: <p>If there is no configure step at all, set
1.128     wiz      6092:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6093: </div>
1.148     asau     6094: <div class="sect1">
1.75      rillig   6095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6096: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6097: <p>For building a package, a rough equivalent of the
                   6098:     following code is executed.</p>
1.75      rillig   6099: <pre class="programlisting">
1.100     rillig   6100: .for d in ${BUILD_DIRS}
                   6101:         cd ${WRKSRC} \
                   6102:         &amp;&amp; cd ${d} \
                   6103:         &amp;&amp; env ${MAKE_ENV} \
                   6104:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6105:                 -f ${MAKE_FILE} \
                   6106:                 ${BUILD_TARGET}
                   6107: .endfor
                   6108: </pre>
1.88      wiz      6109: <p><code class="varname">BUILD_DIRS</code> (default:
1.128     wiz      6110:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6111:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6112:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6113:     <code class="varname">MAKE_ENV</code> and arguments
                   6114:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6115:     <code class="varname">MAKE_ENV</code>,
                   6116:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6117:     <code class="varname">MAKE_FILE</code> and
                   6118:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6119:     package.</p>
1.75      rillig   6120: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128     wiz      6121:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6122:     <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      6123:     default value of <code class="varname">MAKE_FILE</code> is
1.128     wiz      6124:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6125:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.97      rillig   6126: <p>If there is no build step at all, set
1.128     wiz      6127:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6128: </div>
1.148     asau     6129: <div class="sect1">
1.75      rillig   6130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6131: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6132: <p>[TODO]</p>
                   6133: </div>
1.148     asau     6134: <div class="sect1">
1.75      rillig   6135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6136: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6137: <p>Once the build stage has completed, the final step is to
1.88      wiz      6138:     install the software in public directories, so users can
                   6139:     access the programs and files.</p>
1.75      rillig   6140: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6141:     equivalent of the following code is executed. Additionally,
                   6142:     before and after this code, much magic is performed to do
                   6143:     consistency checks, registering the package, and so on.</p>
                   6144: <pre class="programlisting">
1.100     rillig   6145: .for d in ${INSTALL_DIRS}
                   6146:         cd ${WRKSRC} \
                   6147:         &amp;&amp; cd ${d} \
                   6148:         &amp;&amp; env ${MAKE_ENV} \
                   6149:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6150:                 -f ${MAKE_FILE} \
                   6151:                 ${INSTALL_TARGET}
                   6152: .endfor
                   6153: </pre>
1.75      rillig   6154: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6155:     <span class="emphasis"><em>build</em></span> phase.
                   6156:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6157:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128     wiz      6158:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   6159:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.88      wiz      6160:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6161:     defined.</p>
1.75      rillig   6162: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6163:     variables are useful. They are all variations of the
1.257     leot     6164:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88      wiz      6165:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6166:     install command. The specialized variants, together with their
                   6167:     intended use, are:</p>
1.148     asau     6168: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6169: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6170: <dd><p>directories that contain
                   6171:       binaries</p></dd>
1.75      rillig   6172: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6173: <dd><p>directories that contain
                   6174:       scripts</p></dd>
1.75      rillig   6175: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6176: <dd><p>directories that contain shared and static
                   6177:       libraries</p></dd>
1.75      rillig   6178: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6179: <dd><p>directories that contain data
                   6180:       files</p></dd>
1.75      rillig   6181: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6182: <dd><p>directories that contain man
                   6183:       pages</p></dd>
1.210     leot     6184: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   6185: <dd><p>directories that contain data files for games
                   6186:       </p></dd>
1.75      rillig   6187: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      6188: <dd><p>binaries that can be stripped from debugging
                   6189:       symbols</p></dd>
1.75      rillig   6190: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      6191: <dd><p>binaries that cannot be
                   6192:       stripped</p></dd>
1.75      rillig   6193: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      6194: <dd><p>game
                   6195:       binaries</p></dd>
1.75      rillig   6196: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      6197: <dd><p>shared and static
                   6198:       libraries</p></dd>
1.75      rillig   6199: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6200: <dd><p>data files</p></dd>
                   6201: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      6202: <dd><p>data files for
                   6203:       games</p></dd>
1.75      rillig   6204: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6205: <dd><p>man pages</p></dd>
                   6206: </dl></div>
                   6207: <p>Some other variables are:</p>
1.148     asau     6208: <div class="variablelist"><dl class="variablelist">
1.216     tnn      6209: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.257     leot     6210: <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-8.0"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.216     tnn      6211:       when installing binaries. Any debugging sections and symbols present in
                   6212:       binaries will be preserved.
                   6213:       </p></dd>
1.75      rillig   6214: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6215: <dd><p>A list of directories relative to
1.88      wiz      6216:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      6217:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6218:       The package is supposed to create all needed directories itself
                   6219:       before installing files to it and list all other directories here.
                   6220:       </p></dd>
1.75      rillig   6221: </dl></div>
1.97      rillig   6222: <p>In the rare cases that a package shouldn't install anything,
1.128     wiz      6223:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.97      rillig   6224:     mostly relevant for packages in the <code class="filename">regress</code>
                   6225:     category.</p>
1.75      rillig   6226: </div>
1.148     asau     6227: <div class="sect1">
1.75      rillig   6228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6229: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      6230: <p>Once the install stage has completed, a binary package of
                   6231:     the installed files can be built.  These binary packages can be
                   6232:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  6233:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   6234:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      6235: <p>By default, the binary packages are created in
                   6236:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6237:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6238:     one for each category in the <code class="varname">CATEGORIES</code>
                   6239:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6240:     <code class="filename">pkgsrc/packages</code>.</p>
                   6241: </div>
1.148     asau     6242: <div class="sect1">
1.88      wiz      6243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6244: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      6245: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  6246:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      6247:     to clean the work directories of all dependencies too, use
1.110     hubertf  6248:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   6249: </div>
1.148     asau     6250: <div class="sect1">
1.75      rillig   6251: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6252: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148     asau     6253: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6254: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      6255: <dd><p>For any of the main targets described in the
                   6256:          previous section, two auxiliary targets exist with
1.128     wiz      6257:          <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      6258:          prefix for the main target's name.  These targets are
1.88      wiz      6259:          invoked before and after the main target is called,
                   6260:          allowing extra configuration or installation steps be
                   6261:          performed from a package's Makefile, for example, which
                   6262:          a program's configure script or install target
                   6263:          omitted.</p></dd>
1.75      rillig   6264: <dt><span class="term">do-*</span></dt>
1.88      wiz      6265: <dd><p>Should one of the main targets do the wrong thing,
                   6266:          and should there be no variable to fix this, you can
                   6267:          redefine it with the do-* target.  (Note that redefining
                   6268:          the target itself instead of the do-* target is a bad
                   6269:          idea, as the pre-* and post-* targets won't be called
                   6270:          anymore, etc.) You will not usually need to do
                   6271:          this.</p></dd>
1.75      rillig   6272: <dt><span class="term">reinstall</span></dt>
1.88      wiz      6273: <dd>
1.110     hubertf  6274: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      6275:          you noticed some file was not installed properly, you
                   6276:          can repeat the installation with this target, which will
1.128     wiz      6277:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.88      wiz      6278: <p>This is the default value of
                   6279:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  6280:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      6281:          package</strong></span>, where the defaults are
1.128     wiz      6282:          <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      6283:          respectively.</p>
                   6284: </dd>
1.75      rillig   6285: <dt><span class="term">deinstall</span></dt>
                   6286: <dd>
1.257     leot     6287: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88      wiz      6288:          current directory, effectively de-installing the
                   6289:          package. The following variables can be used to tune the
                   6290:          behaviour:</p>
1.148     asau     6291: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6292: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.257     leot     6293: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75      rillig   6294: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      6295: <dd><p>Remove all packages that require (depend on)
                   6296:                the given package.  This can be used to remove any
                   6297:                packages that may have been pulled in by a given
1.110     hubertf  6298:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      6299:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      6300:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   6301:                likely to remove whole KDE. Works by adding
1.257     leot     6302:                <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-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88      wiz      6303:                command line.</p></dd>
1.75      rillig   6304: </dl></div>
                   6305: </dd>
1.88      wiz      6306: <dt><span class="term">bin-install</span></dt>
                   6307: <dd><p>Install a binary package from local disk and via FTP
                   6308:          from a list of sites (see the
                   6309:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  6310:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      6311:          available anywhere.  The arguments given to
1.110     hubertf  6312:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      6313:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   6314:          operation, etc.</p></dd>
1.205     wiz      6315: <dt><span class="term">install-clean</span></dt>
                   6316: <dd><p>This target removes the state files for the "install" and later
                   6317:          phases so that the "install" target may be re-invoked. This can be
                   6318:          used after editing the PLIST to install the package without
                   6319:          rebuilding it.</p></dd>
                   6320: <dt><span class="term">build-clean</span></dt>
                   6321: <dd><p>This target removes the state files for the "build" and later
                   6322:          phases so that the "build" target may be re-invoked.</p></dd>
1.75      rillig   6323: <dt><span class="term">update</span></dt>
                   6324: <dd>
1.88      wiz      6325: <p>This target causes the current package to be
                   6326:          updated to the latest version.  The package and all
                   6327:          depending packages first get de-installed, then current
                   6328:          versions of the corresponding packages get compiled and
                   6329:          installed.  This is similar to manually noting which
                   6330:          packages are currently installed, then performing a
1.110     hubertf  6331:          series of <span class="command"><strong>make deinstall</strong></span> and
                   6332:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      6333:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   6334:          packages.</p>
1.128     wiz      6335: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.110     hubertf  6336:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      6337:          update</strong></span> was interrupted for some reason.
                   6338:          However, in this case, make sure you don't call
1.110     hubertf  6339:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      6340:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   6341:          Otherwise, you lose the ability to automatically update
                   6342:          the current package along with the dependent packages
                   6343:          you have installed.</p>
1.110     hubertf  6344: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      6345:          update</strong></span> will only work as long as the package
                   6346:          tree remains unchanged.  If the source code for one of
                   6347:          the packages to be updated has been changed, resuming
1.110     hubertf  6348:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      6349:          fail!</p>
                   6350: <p>The following variables can be used either on the
1.110     hubertf  6351:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   6352:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      6353:          update</strong></span>:</p>
1.148     asau     6354: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6355: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      6356: <dd><p>Install target to recursively use for the
                   6357:                updated package and the dependent packages.
                   6358:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128     wiz      6359:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.110     hubertf  6360:                <span class="command"><strong>make update</strong></span>.  Other good
1.128     wiz      6361:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   6362:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   6363:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.88      wiz      6364:                endless loop!</p></dd>
1.75      rillig   6365: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      6366: <dd><p>Don't clean up after updating.  Useful if
                   6367:                you want to leave the work sources of the updated
                   6368:                packages around for inspection or other purposes.
                   6369:                Be sure you eventually clean up the source tree
1.128     wiz      6370:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.88      wiz      6371:                or you may run into troubles with old source code
                   6372:                still lying around on your next
1.110     hubertf  6373:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      6374:                update</strong></span>.</p></dd>
1.75      rillig   6375: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      6376: <dd><p>Deinstall each package before installing
                   6377:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   6378:                may be necessary if the
1.128     wiz      6379:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.110     hubertf  6380:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      6381:                update</strong></span>.</p></dd>
1.75      rillig   6382: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      6383: <dd><p>Allows you to disable recursion and hardcode
                   6384:                the target for packages.  The default is
1.128     wiz      6385:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.88      wiz      6386:                facilitating a recursive update of prerequisite
                   6387:                packages.  Only set
                   6388:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   6389:                disable recursive updates. Use
                   6390:                <code class="varname">UPDATE_TARGET</code> instead to just
                   6391:                set a specific target for each package to be
1.110     hubertf  6392:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      6393:                (see above).</p></dd>
1.75      rillig   6394: </dl></div>
                   6395: </dd>
                   6396: <dt><span class="term">clean-update</span></dt>
                   6397: <dd>
1.88      wiz      6398: <p>Clean the source tree for all packages that would
1.110     hubertf  6399:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      6400:          from the current directory.  This target should not be
                   6401:          used if the current package (or any of its depending
                   6402:          packages) have already been de-installed (e.g., after
1.110     hubertf  6403:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      6404:          some packages you intended to update. As a rule of
                   6405:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  6406:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      6407:          and only if you have a dirty package tree (e.g., if you
                   6408:          used <code class="varname">NOCLEAN</code>).</p>
                   6409: <p>If you are unsure about whether your tree is
1.110     hubertf  6410:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      6411:          clean</strong></span> at the top of the tree, or use the
                   6412:          following sequence of commands from the directory of the
                   6413:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  6414:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      6415:          time, otherwise you lose all the packages you wanted to
                   6416:          update!):</p>
1.87      wiz      6417: <pre class="screen">
                   6418: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   6419: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      6420: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   6421:          </pre>
1.88      wiz      6422: <p>The following variables can be used either on the
1.110     hubertf  6423:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   6424:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.148     asau     6425: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6426: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  6427: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      6428:                reconstruct the list of directories to update for
1.110     hubertf  6429:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      6430:                update</strong></span> successfully installed all
                   6431:                packages you wanted to update.  Normally, this is
1.110     hubertf  6432:                done automatically on <span class="command"><strong>make
1.88      wiz      6433:                update</strong></span>, but may have been suppressed by
                   6434:                the <code class="varname">NOCLEAN</code> variable (see
                   6435:                above).</p></dd>
1.75      rillig   6436: </dl></div>
                   6437: </dd>
1.88      wiz      6438: <dt><span class="term">replace</span></dt>
                   6439: <dd>
                   6440: <p>Update the installation of the current package.  This
                   6441:          differs from update in that it does not replace dependent
1.250     leot     6442:          packages.  You will need to install <a href="https://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      6443:          target to work.</p>
                   6444: <p><span class="emphasis"><em>Be careful when using this
                   6445:          target!</em></span> There are no guarantees that dependent
                   6446:          packages will still work, in particular they will most
1.110     hubertf  6447:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      6448:          library package whose shared library major version changed
                   6449:          between your installed version and the new one.  For this
                   6450:          reason, this target is not officially supported and only
                   6451:          recommended for advanced users.</p>
                   6452: </dd>
1.75      rillig   6453: <dt><span class="term">info</span></dt>
1.257     leot     6454: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      6455:          package. You can use this to check which version of a
                   6456:          package is installed.</p></dd>
                   6457: <dt><span class="term">index</span></dt>
                   6458: <dd>
                   6459: <p>This is a top-level command, i.e. it should be used in
                   6460:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   6461:          database of all packages in the local pkgsrc tree, including
                   6462:          dependencies, comment, maintainer, and some other useful
                   6463:          information.  Individual entries are created by running
1.110     hubertf  6464:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      6465:          directories.  This index file is saved as
                   6466:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  6467:          verbose format by running <span class="command"><strong>make
1.88      wiz      6468:          print-index</strong></span>.  You can search in it with
1.110     hubertf  6469:          <span class="command"><strong>make search
1.88      wiz      6470:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   6471:          extract a list of all packages that depend on a particular
1.110     hubertf  6472:          one by running <span class="command"><strong>make show-deps
1.88      wiz      6473:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   6474: <p>Running this command takes a very long time, some
                   6475:          hours even on fast machines!</p>
                   6476: </dd>
1.75      rillig   6477: <dt><span class="term">readme</span></dt>
1.88      wiz      6478: <dd>
                   6479: <p>This target generates a
                   6480:          <code class="filename">README.html</code> file, which can be
1.250     leot     6481:          viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://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      6482:          contain references to any packages which are in the
                   6483:          <code class="varname">PACKAGES</code> directory on the local
                   6484:          host. The generated files can be made to refer to URLs
                   6485:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   6486:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   6487:          wanted to generate <code class="filename">README.html</code>
                   6488:          files which pointed to binary packages on the local
                   6489:          machine, in the directory
                   6490:          <code class="filename">/usr/packages</code>, set
                   6491:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   6492:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   6493:          <code class="varname">${PACKAGES}</code> directory and its
                   6494:          subdirectories will be searched for all the binary
                   6495:          packages.</p>
                   6496: <p>The target can be run at the toplevel or in category
                   6497:          directories, in which case it descends recursively.</p>
                   6498: </dd>
1.75      rillig   6499: <dt><span class="term">readme-all</span></dt>
1.88      wiz      6500: <dd><p>This is a top-level command, run it in
                   6501:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   6502:          file <code class="filename">README-all.html</code> which contains a
                   6503:          list of all packages currently available in the NetBSD
                   6504:          Packages Collection, together with the category they belong
                   6505:          to and a short description. This file is compiled from the
                   6506:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  6507:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      6508:          readme</strong></span>.</p></dd>
1.75      rillig   6509: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      6510: <dd><p>This is very much the same as the
1.128     wiz      6511:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.88      wiz      6512:          used when generating a pkgsrc tree to be written to a
                   6513:          CD-ROM.  This target also produces
                   6514:          <code class="filename">README.html</code> files, and can be made
                   6515:          to refer to URLs based on
                   6516:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      6517:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   6518: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      6519: <dd><p>This target shows which distfiles and patchfiles
                   6520:          are needed to build the package
                   6521:          (<code class="varname">ALLFILES</code>, which contains all
                   6522:          <code class="varname">DISTFILES</code> and
1.87      wiz      6523:          <code class="varname">PATCHFILES</code>, but not
                   6524:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   6525: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      6526: <dd><p>This target shows nothing if the package is not
                   6527:          installed. If a version of this package is installed,
                   6528:          but is not the version provided in this version of
                   6529:          pkgsrc, then a warning message is displayed. This target
                   6530:          can be used to show which of your installed packages are
                   6531:          downlevel, and so the old versions can be deleted, and
                   6532:          the current ones added.</p></dd>
1.75      rillig   6533: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      6534: <dd><p>This target shows the directory in the pkgsrc
                   6535:          hierarchy from which the package can be built and
                   6536:          installed. This may not be the same directory as the one
                   6537:          from which the package was installed. This target is
                   6538:          intended to be used by people who may wish to upgrade
                   6539:          many packages on a single host, and can be invoked from
                   6540:          the top-level pkgsrc Makefile by using the
1.128     wiz      6541:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.75      rillig   6542: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      6543: <dd><p>This target shows which installed packages match
                   6544:          the current package's <code class="varname">DEPENDS</code>. Useful
                   6545:          if out of date dependencies are causing build
                   6546:          problems.</p></dd>
1.205     wiz      6547: <dt><span class="term">print-build-depends-list</span></dt>
                   6548: <dd><p>This target shows the list of packages that the current package
                   6549:            depends on for building.</p></dd>
                   6550: <dt><span class="term">print-run-depends-list</span></dt>
                   6551: <dd><p>This target shows the list of packages that the current package
                   6552:            depends on for running.</p></dd>
1.75      rillig   6553: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      6554: <dd><p>After a package is installed, check all its
                   6555:          binaries and (on ELF platforms) shared libraries to see
                   6556:          if they find the shared libs they need.  Run by default
1.110     hubertf  6557:          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   6558: <dt><span class="term">print-PLIST</span></dt>
                   6559: <dd>
1.128     wiz      6560: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.88      wiz      6561:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  6562:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      6563:          -newer work/.extract_done</strong></span>.  An attempt is made
                   6564:          to care for shared libs etc., but it is
1.87      wiz      6565:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   6566:          result before putting it into
                   6567:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   6568:          diff the output of this command against an already
                   6569:          existing <code class="filename">PLIST</code> file.</p>
1.257     leot     6570: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88      wiz      6571:          other methods that don't update file access times, be
                   6572:          sure to add these files manually to your
1.128     wiz      6573:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   6574:          -newer</span>&#8221;</span> command used by this target won't catch
1.87      wiz      6575:          them!</p>
1.128     wiz      6576: <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      6577:          information on this target.</p>
1.75      rillig   6578: </dd>
                   6579: <dt><span class="term">bulk-package</span></dt>
                   6580: <dd>
1.88      wiz      6581: <p>Used to do bulk builds. If an appropriate binary
                   6582:          package already exists, no action is taken. If not, this
                   6583:          target will compile, install and package it (and its
                   6584:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174     asau     6585:          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
                   6586: builds)</i></a>).
1.88      wiz      6587:          After creating the binary package, the sources, the
                   6588:          just-installed package and its required packages are
                   6589:          removed, preserving free disk space.</p>
                   6590: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6591:          all packages installed on a system!</em></span></p>
1.75      rillig   6592: </dd>
                   6593: <dt><span class="term">bulk-install</span></dt>
                   6594: <dd>
1.88      wiz      6595: <p>Used during bulk-installs to install required
                   6596:          packages. If an up-to-date binary package is available,
1.257     leot     6597:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110     hubertf  6598:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      6599:          but the installed binary won't be removed.</p>
1.88      wiz      6600: <p>A binary package is considered
1.128     wiz      6601:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.257     leot     6602:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148     asau     6603: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6604: <li class="listitem"><p>None of the package's files
1.88      wiz      6605:              (<code class="filename">Makefile</code>, ...) were modified
                   6606:              since it was built.</p></li>
1.128     wiz      6607: <li class="listitem"><p>None of the package's required (binary)
1.88      wiz      6608:              packages were modified since it was built.</p></li>
1.75      rillig   6609: </ul></div>
1.88      wiz      6610: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6611:          all packages installed on a system!</em></span></p>
1.75      rillig   6612: </dd>
                   6613: </dl></div>
                   6614: </div>
                   6615: </div>
1.148     asau     6616: <div class="chapter">
1.75      rillig   6617: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6618: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   6619: <div class="toc">
                   6620: <p><b>Table of Contents</b></p>
1.210     leot     6621: <dl class="toc">
1.106     rillig   6622: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   6623: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   6624: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.75      rillig   6625: </dl>
                   6626: </div>
1.87      wiz      6627: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   6628: by pkgsrc and also for individual packages to define what commands
                   6629: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   6630: or for later run-time of an installed packaged (such as
                   6631: <code class="varname">DEPENDS</code>).
                   6632: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      6633: package will not be used.</p>
                   6634: <p>When building a package, the replacement tools are
1.75      rillig   6635: made available in a directory (as symlinks or wrapper scripts)
                   6636: that is early in the executable search path. Just like the buildlink
1.87      wiz      6637: system, this helps with consistent builds.</p>
                   6638: <p>A tool may be needed to help build a specific package. For example,
                   6639: perl, GNU make (gmake) or yacc may be needed.</p>
                   6640: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   6641: tool may be inefficient for building a package with pkgsrc.
                   6642: For example, a package may need GNU awk, bison (instead of
1.87      wiz      6643: yacc) or a better sed.</p>
                   6644: <p>The tools used by a package can be listed by running
1.110     hubertf  6645: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6646: <div class="sect1">
1.75      rillig   6647: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6648: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      6649: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   6650: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  6651: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6652: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   6653: These can be seen by running:
1.110     hubertf  6654: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      6655: <p>If a package needs a specific program to build
1.75      rillig   6656: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      6657: to define the tools needed.</p>
1.75      rillig   6658: </div>
1.148     asau     6659: <div class="sect1">
1.75      rillig   6660: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6661: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135     wiz      6662: <p>In the following examples, the :run means that it is needed at
                   6663: run-time (and becomes a DEPENDS).
1.75      rillig   6664: The default is a build dependency which can be set with
                   6665: :build. (So in this example, it is the same as gmake:build
1.87      wiz      6666: and pkg-config:build.)</p>
1.75      rillig   6667: <pre class="programlisting">
                   6668: USE_TOOLS+=     gmake perl:run pkg-config
                   6669: </pre>
1.87      wiz      6670: <p>When using the tools framework, a
1.75      rillig   6671: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6672: which contains the full path to the appropriate tool. For example,
1.128     wiz      6673: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.87      wiz      6674: on Linux systems.</p>
                   6675: <p>If you always need a pkgsrc version of the
1.75      rillig   6676: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6677: </p>
                   6678: </div>
1.148     asau     6679: <div class="sect1">
1.75      rillig   6680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6681: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      6682: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   6683: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   6684: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   6685: the name of the common tools. For example:</p>
                   6686: <pre class="programlisting">
                   6687: .if exists(/usr/bin/bzcat)
                   6688: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6689: .elif exists(/usr/bin/bzip2)
                   6690: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6691: .endif
1.69      rillig   6692: 
1.75      rillig   6693: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   6694: </pre>
                   6695: </div>
                   6696: </div>
1.148     asau     6697: <div class="chapter">
1.75      rillig   6698: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6699: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   6700: <div class="toc">
                   6701: <p><b>Table of Contents</b></p>
1.210     leot     6702: <dl class="toc">
1.106     rillig   6703: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   6704: <dd><dl>
1.218     rillig   6705: <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>
                   6706: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                   6707: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                   6708: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                   6709: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                   6710: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                   6711: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                   6712: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   6713: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                   6714: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   6715: <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   6716: </dl></dd>
1.218     rillig   6717: <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   6718: <dd><dl>
                   6719: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   6720: <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      6721: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig   6722: </dl></dd>
1.218     rillig   6723: <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   6724: <dd><dl>
                   6725: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   6726: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   6727: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   6728: </dl></dd>
                   6729: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   6730: <dd><dl>
                   6731: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   6732: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   6733: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      6734: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   6735: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   6736: </dl></dd>
1.218     rillig   6737: <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   6738: <dd><dl>
                   6739: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   6740: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      6741: <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   6742: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   6743: </dl></dd>
1.218     rillig   6744: <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   6745: <dd><dl>
                   6746: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   6747: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   6748: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   6749: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   6750: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   6751: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   6752: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   6753: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   6754: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   6755: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   6756: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   6757: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   6758: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   6759: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   6760: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   6761: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   6762: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   6763: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      6764:     emulation</a></span></dt>
1.106     rillig   6765: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   6766: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   6767: </dl></dd>
1.106     rillig   6768: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   6769: </dl>
                   6770: </div>
1.148     asau     6771: <div class="sect1">
1.75      rillig   6772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6773: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.78      rillig   6774: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   6775:   different platforms. As a result, it is important to ensure,
                   6776:   where possible, that packages in pkgsrc are portable. This
                   6777:   chapter mentions some particular details you should pay
                   6778:   attention to while working on pkgsrc.</p>
1.148     asau     6779: <div class="sect2">
1.78      rillig   6780: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6781: <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   6782: </h3></div></div></div>
1.78      rillig   6783: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      6784:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  6785:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      6786:     want to use those variables in the preprocessor directives of
1.257     leot     6787:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      6788:     <code class="literal">.for</code>), you need to include the file
                   6789:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   6790:     loads the user preferences.</p>
1.78      rillig   6791: <p>But note that some variables may not be completely defined
1.219     rillig   6792:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   6793:     included, as they may contain references to variables that are
                   6794:     not yet defined. In shell commands (the lines in
                   6795:     <code class="filename">Makefile</code> that are indented with a tab) this
                   6796:     is no problem, since variables are only expanded when they are
                   6797:     used. But in the preprocessor directives mentioned above and in
                   6798:     dependency lines (of the form <code class="literal">target:
                   6799:     dependencies</code>) the variables are expanded at load
                   6800:     time.</p>
1.148     asau     6801: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   6802: <h3 class="title">Note</h3>
1.218     rillig   6803: <p>To check whether a variable can be used at load time,
                   6804:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   6805: </div>
                   6806: </div>
1.148     asau     6807: <div class="sect2">
1.78      rillig   6808: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6809: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.88      wiz      6810: <p>Occasionally, packages require interaction from the user,
                   6811:     and this can be in a number of ways:</p>
1.148     asau     6812: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6813: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      6814:        interaction such as entering username/password or accepting a
                   6815:        license on a web page.</p></li>
1.128     wiz      6816: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      6817:        passwords.</p></li>
1.128     wiz      6818: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   6819: <li class="listitem"><p>help during the build process</p></li>
                   6820: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   6821: </ul></div>
1.218     rillig   6822: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   6823:     variable to define which stages need interaction. This should be
                   6824:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   6825: <pre class="programlisting">
1.100     rillig   6826: INTERACTIVE_STAGE=      configure install
1.222     sevan    6827: </pre>
1.88      wiz      6828: <p>The user can then decide to skip this package by setting the
1.218     rillig   6829:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   6830:     are also excluded from bulk builds.</p>
1.75      rillig   6831: </div>
1.148     asau     6832: <div class="sect2">
1.75      rillig   6833: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6834: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    6835: <p>Authors of software can choose the licence under which software
                   6836:     can be copied.  The Free Software Foundation has declared some
                   6837:     licenses "Free", and the Open Source Initiative has a definition of
                   6838:     "Open Source".</p>
                   6839: <p>By default, pkgsrc allows packages with Free or Open Source
                   6840:     licenses to be built.  To allow packages with other licenses to be
                   6841:     built as well, the pkgsrc user needs to add these licenses to the
                   6842:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   6843:     that this variable only affects which packages may be
                   6844:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   6845:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      6846: <p>One might want to only install packages with a BSD license,
1.218     rillig   6847:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    6848:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  6849:     user can override the default by setting the
                   6850:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    6851:     of "+=".  The licenses accepted by default are defined in the
                   6852:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   6853:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   6854: <p>The license tag mechanism is intended to address
1.87      wiz      6855:     copyright-related issues surrounding building, installing and
                   6856:     using a package, and not to address redistribution issues (see
                   6857:     <code class="varname">RESTRICTED</code> and
1.222     sevan    6858:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  6859:     Packages with redistribution restrictions should set these
                   6860:     tags.</p>
1.98      wiz      6861: <p>Denoting that a package may be copied according to a
                   6862:     particular license is done by placing the license in
1.87      wiz      6863:     <code class="filename">pkgsrc/licenses</code> and setting the
                   6864:     <code class="varname">LICENSE</code> variable to a string identifying the
1.250     leot     6865:     license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      6866: <pre class="programlisting">
1.100     rillig   6867: LICENSE=        xv-license
1.222     sevan    6868: </pre>
1.87      wiz      6869: <p>When trying to build, the user will get a notice that the
1.98      wiz      6870:     package is covered by a license which has not been placed in the
                   6871:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      6872: <pre class="programlisting">
1.100     rillig   6873: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   6874: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   6875: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   6876: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   6877: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   6878: *** Error code 1
1.222     sevan    6879: </pre>
1.110     hubertf  6880: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      6881:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  6882:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      6883:     convey to pkgsrc that it should not in the future fail because of
                   6884:     that license:</p>
1.78      rillig   6885: <pre class="programlisting">
1.100     rillig   6886: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    6887: </pre>
                   6888: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   6889:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   6890:     is deprecated because it does not crisply refer to a particular
                   6891:     license text.  Another problem with such usage is that it does not
                   6892:     enable a user to tell pkgsrc to proceed for a single package
                   6893:     without also telling pkgsrc to proceed for all packages with that
                   6894:     tag.</p>
                   6895: <div class="sect3">
                   6896: <div class="titlepage"><div><div><h4 class="title">
                   6897: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   6898: <p>When adding a package with a new license, the following steps
                   6899:     are required:</p>
                   6900: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6901: <li class="listitem">
1.222     sevan    6902: <p>Check whether the license qualifies as Free or Open
                   6903:     Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
                   6904:     and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
                   6905:     Open Source Initiative</a>.  If this is the case, the filename in
                   6906:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   6907:     <code class="filename">-license</code> suffix, and the license name should be
                   6908:     added to:</p>
1.154     rodent   6909: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6910: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   6911: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
                   6912: </ul></div>
                   6913: </li>
                   6914: <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>
                   6915: </ol></div>
1.222     sevan    6916: </div>
                   6917: <div class="sect3">
                   6918: <div class="titlepage"><div><div><h4 class="title">
                   6919: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      6920: <p>When the license changes (in a way other than formatting),
1.222     sevan    6921:     make sure that the new license has a different name (e.g.,
1.98      wiz      6922:     append the version number if it exists, or the date).  Just
                   6923:     because a user told pkgsrc to build programs under a previous
                   6924:     version of a license does not mean that pkgsrc should build
1.99      rillig   6925:     programs under the new licenses.  The higher-level point is that
1.98      wiz      6926:     pkgsrc does not evaluate licenses for reasonableness; the only
                   6927:     test is a mechanistic test of whether a particular text has been
1.222     sevan    6928:     approved by either of two bodies (FSF or OSI).</p>
                   6929: </div>
1.75      rillig   6930: </div>
1.148     asau     6931: <div class="sect2">
1.75      rillig   6932: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   6933: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   6934: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    6935:     By declaring the restrictions, package tools can
1.98      wiz      6936:     automatically refrain from e.g. placing binary packages on FTP
                   6937:     sites.</p>
1.222     sevan    6938: <p>There are four possible restrictions, which are
1.98      wiz      6939:     the cross product of sources (distfiles) and binaries not being
                   6940:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   6941:     language in any license, and because non-Free licenses tend to be
                   6942:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    6943:     CD-ROM.
                   6944: 
                   6945:     "FTP" means making the source or binary file available over the
                   6946:     Internet at no charge.
                   6947: 
                   6948:     "CD-ROM" means making the source or binary available on some kind of
                   6949:     media, together with other source and binary packages, which is sold
                   6950:     for a distribution charge.
1.98      wiz      6951:     </p>
                   6952: <p>In order to encode these restrictions, the package system
1.87      wiz      6953:     defines five make variables that can be set to note these
                   6954:     restrictions:</p>
1.148     asau     6955: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6956: <li class="listitem">
1.75      rillig   6957: <p><code class="varname">RESTRICTED</code></p>
                   6958: <p>This variable should be set whenever a restriction
1.87      wiz      6959:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      6960:        string containing the reason for the restriction.  It should
                   6961:        be understood that those wanting to understand the restriction
                   6962:        will have to read the license, and perhaps seek advice of
                   6963:        counsel.</p>
1.75      rillig   6964: </li>
1.128     wiz      6965: <li class="listitem">
1.75      rillig   6966: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      6967: <p>Binaries may not be placed on CD-ROM containing other
                   6968:        binary packages, for which a distribution charge may be made.
                   6969:        In this case, set this variable to
                   6970:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   6971: </li>
1.128     wiz      6972: <li class="listitem">
1.75      rillig   6973: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      6974: <p>Binaries may not made available on the Internet without
                   6975:        charge.  In this case, set this variable to
                   6976:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   6977:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   6978: </li>
1.128     wiz      6979: <li class="listitem">
1.75      rillig   6980: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      6981: <p>Distfiles may not be placed on CD-ROM, together with
                   6982:        other distfiles, for which a fee may be charged.  In this
                   6983:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   6984:        </p>
1.75      rillig   6985: </li>
1.128     wiz      6986: <li class="listitem">
1.75      rillig   6987: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      6988: <p>Distfiles may not made available via FTP at no charge.
                   6989:        In this case, set this variable to
                   6990:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   6991:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   6992: </li>
                   6993: </ul></div>
1.222     sevan    6994: <p>Please note that packages will be removed from pkgsrc when the
                   6995:     distfiles are not distributable and cannot be obtained for a period
                   6996:     of one full quarter branch. Packages with manual/interactive fetch
                   6997:     must have a maintainer and it is his/her responsibility to ensure
                   6998:     this.</p>
1.75      rillig   6999: </div>
1.148     asau     7000: <div class="sect2">
1.75      rillig   7001: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7002: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.75      rillig   7003: <p>Your package may depend on some other package being present
1.88      wiz      7004:     - and there are various ways of expressing this dependency.
                   7005:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7006:     <code class="varname">DEPENDS</code> definitions, the
                   7007:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7008:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7009:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  7010:     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   7011: <p>The basic difference between the two variables is as
1.87      wiz      7012:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7013:     that pre-requisite in the binary package so it will be pulled in
                   7014:     when the binary package is later installed, whilst the
                   7015:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7016:     dependency that is only needed for building the package.</p>
1.75      rillig   7017: <p>This means that if you only need a package present whilst
1.87      wiz      7018:     you are building, it should be noted as a
                   7019:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7020: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7021:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7022: <pre class="programlisting">
1.100     rillig   7023: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7024: </pre>
1.128     wiz      7025: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7026:     may include any of the wildcard version numbers recognized by
1.257     leot     7027:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7028: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7029: <li class="listitem">
1.75      rillig   7030: <p>If your package needs another package's binaries or
1.160     wiz      7031:        libraries to build and run, and if that package has a
1.87      wiz      7032:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7033: <pre class="programlisting">
1.100     rillig   7034: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7035: </pre>
1.75      rillig   7036: </li>
1.128     wiz      7037: <li class="listitem">
1.160     wiz      7038: <p>If your package needs another package's binaries or
                   7039:        libraries only for building, and if that package has a
                   7040:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7041: <pre class="programlisting">
                   7042: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7043: </pre>
1.160     wiz      7044: <p>but set
                   7045:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7046:        to make it a build dependency only. This case is rather
                   7047:        rare.</p>
                   7048: </li>
                   7049: <li class="listitem">
1.132     spz      7050: <p>If your package needs binaries from another package to build,
                   7051:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75      rillig   7052: <pre class="programlisting">
1.260     tnn      7053: BUILD_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7054: </pre>
1.75      rillig   7055: </li>
1.132     spz      7056: <li class="listitem"><p>If your package needs a library with which to link and
                   7057:        there is no <code class="filename">buildlink3.mk</code> file
                   7058:        available, create one. Using
                   7059:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7060:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7061: <li class="listitem">
1.132     spz      7062: <p>If your package needs some executable to be able to run
                   7063:        correctly and if there's no
                   7064:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7065:        using the <code class="varname">DEPENDS</code> variable. The
1.250     leot     7066:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.242     wiz      7067:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7068:        when it runs, and that is specified:</p>
1.75      rillig   7069: <pre class="programlisting">
1.242     wiz      7070: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7071: </pre>
1.132     spz      7072: </li>
                   7073: <li class="listitem">
                   7074: <p>You can use wildcards in package dependencies. Note that
                   7075:        such wildcard dependencies are retained when creating binary
                   7076:        packages. The dependency is checked when installing the binary
                   7077:        package and any package which matches the pattern will be
                   7078:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7079: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7080:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7081:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7082:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7083: <p>Wildcards can also be used to specify that a package
1.87      wiz      7084:        will only build against a certain minimum version of a
                   7085:        pre-requisite:</p>
1.75      rillig   7086: <pre class="programlisting">
1.132     spz      7087: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7088: </pre>
1.132     spz      7089: <p>This means that the package will build using version 6.0
                   7090:        of ImageMagick or newer. Such a dependency may be warranted
                   7091:        if, for example, the command line options of an executable
                   7092:        have changed.</p>
                   7093: <p>If you need to depend on minimum versions of libraries,
                   7094:        see the buildlink section of the pkgsrc guide.</p>
1.75      rillig   7095: <p>For security fixes, please update the package
1.218     rillig   7096:        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      7097:        information.</p>
1.75      rillig   7098: </li>
                   7099: </ol></div>
                   7100: <p>If your package needs files from another package to build,
1.87      wiz      7101:     add the relevant distribution files to
                   7102:     <code class="varname">DISTFILES</code>, so they will be extracted
1.250     leot     7103:     automatically. See the <a href="https://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      7104:     (It relies on the jpeg sources being present in source form
                   7105:     during the build.)</p>
1.75      rillig   7106: </div>
1.148     asau     7107: <div class="sect2">
1.75      rillig   7108: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7109: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7110: <p>Your package may conflict with other packages a user might
1.87      wiz      7111:     already have installed on his system, e.g. if your package
1.88      wiz      7112:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7113:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.255     leot     7114: <p>For example, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/libXaw3d/README.html" target="_top"><code class="filename">x11/libXaw3d</code></a>
                   7115:     and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
                   7116:     install the same shared library, thus you set in
                   7117:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7118: <pre class="programlisting">
                   7119: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7120:     </pre>
                   7121: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7122: <pre class="programlisting">
                   7123: CONFLICTS=      libXaw3d-[0-9]*
                   7124:     </pre>
1.257     leot     7125: <p><a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255     leot     7126:     that conflict with existing packages and abort. However, in many
                   7127:     situations this is too late in the process. Binary package managers
                   7128:     will not know about the conflict until they attempt to install the
                   7129:     package after already downloading it and all its dependencies.
                   7130:     Users may also waste time building a package and its dependencies
                   7131:     only to find out at the end that it conflicts with another package
                   7132:     they have installed.</p>
                   7133: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7134:     should be added in all cases where it is known that packages conflict
                   7135:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.257     leot     7136:     exported in <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255     leot     7137:     managers to inform users that packages cannot be installed onto
                   7138:     the target system.</p>
1.75      rillig   7139: </div>
1.148     asau     7140: <div class="sect2">
1.75      rillig   7141: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7142: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7143: <p>There are several reasons why a package might be
1.88      wiz      7144:     instructed to not build under certain circumstances.  If the
1.87      wiz      7145:     package builds and runs on most platforms, the exceptions
1.193     dholland 7146:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7147:     the package builds and runs on a small handful of platforms,
                   7148:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7149:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7150:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7151:     (OS-version-platform) that can use glob-style
                   7152:     wildcards.</p>
                   7153: <p>If a package is not appropriate for some platforms (as
1.225     maya     7154:     opposed to merely broken), a different set of variables should be
1.193     dholland 7155:     used as this affects failure reporting and statistics.
                   7156:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7157:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7158:     the package is appropriate for only a small handful of platforms
                   7159:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7160:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7161:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7162:     (OS-version-platform) that can use glob-style
                   7163:     wildcards.</p>
1.88      wiz      7164: <p>Some packages are tightly bound to a specific version of an
1.250     leot     7165:     operating system, e.g. LKMs or <a href="https://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      7166:     backwards compatible with other versions of the OS, and should be
                   7167:     uploaded to a version specific directory on the FTP server.  Mark
                   7168:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7169:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7170:     the package system internals, but may be used in the
                   7171:     future.</p>
1.75      rillig   7172: <p>If the package should be skipped (for example, because it
1.87      wiz      7173:     provides functionality already provided by the system), set
1.88      wiz      7174:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7175:     the package should fail because some preconditions are not met,
                   7176:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7177:     message.</p>
1.75      rillig   7178: </div>
1.148     asau     7179: <div class="sect2">
1.75      rillig   7180: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7181: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7182: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7183:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7184:     be set in the package Makefile. This will be carried into any
                   7185:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7186:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.257     leot     7187:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7188:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7189: </div>
1.148     asau     7190: <div class="sect2">
1.75      rillig   7191: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7192: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7193: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7194:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      7195:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7196:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7197: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7198:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7199:     course not necessary if the problem is fixed by using a newer
                   7200:     release of the software), and the pattern in the
                   7201:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7202: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7203:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7204: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7205:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7206: </div>
1.148     asau     7207: <div class="sect2">
1.75      rillig   7208: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7209: <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   7210: <p>When making fixes to an existing package it can be useful
1.87      wiz      7211:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7212:     avoid conflicting with future versions by the original author, a
1.128     wiz      7213:     <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      7214:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7215:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7216:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7217: <pre class="programlisting">
1.100     rillig   7218: DISTNAME=       foo-17.42
                   7219: PKGREVISION=    9
1.222     sevan    7220: </pre>
1.75      rillig   7221: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7222:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7223:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7224:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7225:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7226: <p>When a new release of the package is released, the
1.87      wiz      7227:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7228:     minor release of the above package, things should be like:</p>
1.75      rillig   7229: <pre class="programlisting">
1.100     rillig   7230: DISTNAME=       foo-17.43
1.222     sevan    7231: </pre>
1.87      wiz      7232: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7233:     non-trivial change in the resulting binary package.  Without a
                   7234:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7235:     version installed has no way of knowing that their package is out
                   7236:     of date.  Thus, changes without increasing
                   7237:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7238:     trivial that no reasonable person would want to upgrade", and this
                   7239:     is the rough test for when increasing
                   7240:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7241:     changes that do not merit increasing
                   7242:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7243: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7244: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114     jmcneill 7245:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   7246:       or comments in Makefile.</p></li>
1.128     wiz      7247: <li class="listitem"><p>
1.100     rillig   7248:       Changing build variables if the resulting binary package is the same.</p></li>
1.128     wiz      7249: <li class="listitem"><p>
1.100     rillig   7250:       Changing <code class="filename">DESCR</code>.</p></li>
1.128     wiz      7251: <li class="listitem"><p>
1.100     rillig   7252:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   7253: </ul></div>
1.87      wiz      7254: <p>Examples of changes that do merit an increase to
                   7255:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7256: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7257: <li class="listitem"><p>
1.100     rillig   7258:       Security fixes</p></li>
1.128     wiz      7259: <li class="listitem"><p>
1.100     rillig   7260:       Changes or additions to a patch file</p></li>
1.128     wiz      7261: <li class="listitem"><p>
1.100     rillig   7262:       Changes to the <code class="filename">PLIST</code></p></li>
1.128     wiz      7263: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100     rillig   7264: </ul></div>
1.78      rillig   7265: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7266:     changes.</p>
1.75      rillig   7267: </div>
1.148     asau     7268: <div class="sect2">
1.79      rillig   7269: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7270: <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   7271: <p>When you want to replace the same text in multiple files
1.87      wiz      7272:     or when the replacement text varies, patches alone cannot help.
                   7273:     This is where the SUBST framework comes in. It provides an
                   7274:     easy-to-use interface for replacing text in files.
                   7275:     Example:</p>
                   7276: <pre class="programlisting">
1.100     rillig   7277: SUBST_CLASSES+=                 fix-paths
                   7278: SUBST_STAGE.fix-paths=          pre-configure
                   7279: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   7280: SUBST_FILES.fix-paths=          src/*.c
                   7281: SUBST_FILES.fix-paths+=         scripts/*.sh
                   7282: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   7283: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.222     sevan    7284: </pre>
1.79      rillig   7285: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      7286:     that are used to identify the different SUBST blocks that are
                   7287:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   7288:     important to always use the <code class="literal">+=</code> operator with
                   7289:     this variable. Otherwise some substitutions may be
                   7290:     skipped.</p>
1.79      rillig   7291: <p>The remaining variables of each SUBST block are
1.87      wiz      7292:     parameterized with the identifier from the first line
                   7293:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   7294:     parameters to a function call.</p>
1.79      rillig   7295: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      7296:     which the replacement will take place. All combinations of
                   7297:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   7298:     <code class="literal">post-</code> together with a phase name are
                   7299:     possible, though only few are actually used. Most commonly used
                   7300:     are <code class="literal">post-patch</code> and
                   7301:     <code class="literal">pre-configure</code>. Of these two,
                   7302:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  7303:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      7304:     have the state after applying the patches but before making any
                   7305:     other changes. This is especially useful when you are debugging
                   7306:     a package in order to create new patches for it. Similarly,
                   7307:     <code class="literal">post-build</code> is preferred over
                   7308:     <code class="literal">pre-install</code>, because the install phase should
                   7309:     generally be kept as simple as possible. When you use
                   7310:     <code class="literal">post-build</code>, you have the same files in the
                   7311:     working directory that will be installed later, so you can check
                   7312:     if the substitution has succeeded.</p>
1.79      rillig   7313: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      7314:     that is printed just before the substitution is done.</p>
1.79      rillig   7315: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      7316:     globbing patterns that specifies the files in which the
                   7317:     substitution will take place. The patterns are interpreted
                   7318:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   7319: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.257     leot     7320:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87      wiz      7321:     command should be prefixed with <code class="literal">-e</code>, so that
                   7322:     all SUBST blocks look uniform.</p>
1.79      rillig   7323: <p>There are some more variables, but they are so seldomly
1.87      wiz      7324:     used that they are only documented in the
                   7325:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   7326: </div>
1.75      rillig   7327: </div>
1.148     asau     7328: <div class="sect1">
1.75      rillig   7329: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7330: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     7331: <div class="sect2">
1.75      rillig   7332: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7333: <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   7334: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  7335:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      7336:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   7337:     with the name of each file to download as an argument, expecting
                   7338:     it to output the URL of the directory from which to download
1.250     leot     7339:     it. <a href="https://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      7340:     example of this usage.</p>
1.75      rillig   7341: <p>If the download can't be automated, because the user must
1.87      wiz      7342:     submit personal information to apply for a password, or must pay
                   7343:     for the source, or whatever, you can set
                   7344:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   7345:     displayed to the user before aborting the build. Example:</p>
                   7346: <pre class="programlisting">
1.100     rillig   7347: FETCH_MESSAGE=  "Please download the files"
                   7348: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   7349: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    7350: </pre>
1.75      rillig   7351: </div>
1.148     asau     7352: <div class="sect2">
1.75      rillig   7353: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7354: <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   7355: <p>Sometimes authors of a software package make some
1.87      wiz      7356:     modifications after the software was released, and they put up a
                   7357:     new distfile without changing the package's version number. If a
                   7358:     package is already in pkgsrc at that time, the checksum will
                   7359:     no longer match. The contents of the new distfile should be
                   7360:     compared against the old one before changing anything, to make
                   7361:     sure the distfile was really updated on purpose, and that
                   7362:     no trojan horse or so crept in.
1.97      rillig   7363:     Please mention that the distfiles were compared and what was found
1.159     rodent   7364:     in your commit message.</p>
1.220     wiz      7365: <p>Then, the correct way to work around this is to set
                   7366:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   7367:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   7368:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   7369:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   7370:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.220     wiz      7371:     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      7372:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      7373:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   7374:     be appended, like
                   7375:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.159     rodent   7376: <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>
                   7377: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      7378:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   7379:     path in the filenames.
1.159     rodent   7380:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      7381:     Furthermore, a mail to the package's authors seems appropriate
                   7382:     telling them that changing distfiles after releases without
                   7383:     changing the file names is not good practice.</p>
1.75      rillig   7384: </div>
1.199     tnn      7385: <div class="sect2">
                   7386: <div class="titlepage"><div><div><h3 class="title">
                   7387: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.200     tnn      7388: <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:
                   7389:     </p>
1.199     tnn      7390: <div class="sect3">
                   7391: <div class="titlepage"><div><div><h4 class="title">
                   7392: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
                   7393: <p>
                   7394:         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.
                   7395:       </p>
                   7396: <pre class="programlisting">
                   7397: DISTNAME=       exampleproject-1.0
1.200     tnn      7398: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7399: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7400: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      7401: EXTRACT_SUFX=   .zip
                   7402: </pre>
                   7403: </div>
                   7404: <div class="sect3">
                   7405: <div class="titlepage"><div><div><h4 class="title">
                   7406: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
                   7407: <p>
                   7408:         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.
                   7409:       </p>
                   7410: <pre class="programlisting">
                   7411: DISTNAME=       example-1.0
1.217     jnemeth  7412: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.200     tnn      7413: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7414: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    7415: </pre>
1.199     tnn      7416: </div>
                   7417: <div class="sect3">
                   7418: <div class="titlepage"><div><div><h4 class="title">
                   7419: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
                   7420: <p>
                   7421:         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.
                   7422:       </p>
                   7423: <pre class="programlisting">
                   7424: DISTNAME=       offensive-1.6
1.200     tnn      7425: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   7426: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7427: GITHUB_PROJECT= exampleproject
                   7428: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   7429: EXTRACT_SUFX=   .zip
1.222     sevan    7430: </pre>
1.199     tnn      7431: </div>
                   7432: </div>
1.75      rillig   7433: </div>
1.148     asau     7434: <div class="sect1">
1.75      rillig   7435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7436: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     7437: <div class="sect2">
1.75      rillig   7438: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7439: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   7440: <p>pkgsrc supports many different machines, with different
1.87      wiz      7441:     object formats like a.out and ELF, and varying abilities to do
                   7442:     shared library and dynamic loading at all. To accompany this,
                   7443:     varying commands and options have to be passed to the
                   7444:     compiler, linker, etc. to get the Right Thing, which can be
                   7445:     pretty annoying especially if you don't have all the machines
                   7446:     at your hand to test things.  The
1.250     leot     7447:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128     wiz      7448:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      7449:     both static and dynamic libraries from a set of source files,
                   7450:     thus being platform-independent.</p>
                   7451: <p>Here's how to use libtool in a package in seven simple
                   7452:     steps:</p>
1.128     wiz      7453: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7454: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      7455:        Makefile.</p></li>
1.128     wiz      7456: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   7457:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      7458:        add it to the definition of <code class="varname">CC</code>, if only
                   7459:        libraries are being built in a given Makefile. This one command
                   7460:        will build both PIC and non-PIC library objects, so you need not
                   7461:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      7462: <li class="listitem">
1.75      rillig   7463: <p>For the linking of the library, remove any
1.128     wiz      7464:        <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
                   7465:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   7466: <pre class="programlisting">
1.100     rillig   7467: ${LIBTOOL} --mode=link \
                   7468:     ${CC} -o ${.TARGET:.a=.la} \
                   7469:         ${OBJS:.o=.lo} \
                   7470:         -rpath ${PREFIX}/lib \
                   7471:         -version-info major:minor
1.222     sevan    7472: </pre>
1.75      rillig   7473: <p>Note that the library is changed to have a
1.87      wiz      7474:        <code class="filename">.la</code> extension, and the objects are
                   7475:        changed to have a <code class="filename">.lo</code>
                   7476:        extension. Change <code class="varname">OBJS</code> as
                   7477:        necessary. This automatically creates all of the
                   7478:        <code class="filename">.a</code>,
                   7479:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   7480:        necessary) in the build directory. Be sure to include
1.128     wiz      7481:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      7482:        minor are zero, as libtool will otherwise strip off the
                   7483:        shared library version.</p>
1.75      rillig   7484: <p>From the libtool manual:</p>
                   7485: <pre class="programlisting">
1.100     rillig   7486: So, libtool library versions are described by three integers:
1.69      rillig   7487: 
1.100     rillig   7488: CURRENT
                   7489: The most recent interface number that this library implements.
1.69      rillig   7490: 
1.100     rillig   7491: REVISION
                   7492: The implementation number of the CURRENT interface.
1.69      rillig   7493: 
1.100     rillig   7494: AGE
                   7495: The difference between the newest and oldest interfaces that
                   7496: this library implements.  In other words, the library implements
                   7497: all the interface numbers in the range from number `CURRENT -
                   7498: AGE' to `CURRENT'.
1.1       grant    7499: 
1.100     rillig   7500: If two libraries have identical CURRENT and AGE numbers, then the
                   7501: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    7502: </pre>
1.128     wiz      7503: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      7504:        different results for a.out and ELF (excluding symlinks)
                   7505:        in only one case. An ELF library of the form
1.128     wiz      7506:        <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      7507:        will have a symlink of
1.128     wiz      7508:        <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      7509:        on an a.out platform. This is handled
                   7510:        automatically.</p>
1.128     wiz      7511: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      7512:        directory of the library being built.</p>
1.76      rillig   7513: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      7514:        <code class="filename">.la</code> file, the other files will be
                   7515:        added automatically.</p>
1.75      rillig   7516: </li>
1.128     wiz      7517: <li class="listitem">
1.76      rillig   7518: <p>When linking shared object (<code class="filename">.so</code>)
1.257     leot     7519:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      7520:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   7521:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      7522:        tacked on.</p>
1.76      rillig   7523: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      7524:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   7525: </li>
1.128     wiz      7526: <li class="listitem">
1.75      rillig   7527: <p>When linking programs that depend on these libraries
1.87      wiz      7528:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.257     leot     7529:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-8.0"><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-8.0"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      7530:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      7531:        libraries (static or shared), but please be aware that
                   7532:        libtool will not allow you to specify a relative path in
1.128     wiz      7533:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      7534:        expects you to change that argument to be the
                   7535:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   7536: <pre class="programlisting">
1.100     rillig   7537: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    7538: </pre>
1.75      rillig   7539: <p>should be changed to:</p>
                   7540: <pre class="programlisting">
1.100     rillig   7541: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    7542: </pre>
1.75      rillig   7543: <p>and it will do the right thing with the libraries.</p>
                   7544: </li>
1.128     wiz      7545: <li class="listitem">
1.257     leot     7546: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   7547:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      7548:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      7549:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   7550: <pre class="programlisting">
1.126     jakllsch 7551: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    7552: </pre>
1.76      rillig   7553: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      7554:        shared library, any needed symlinks, and run
1.257     leot     7555:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   7556: </li>
1.128     wiz      7557: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      7558:        the <code class="filename">.la</code>
                   7559:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   7560: </ol></div>
                   7561: </div>
1.148     asau     7562: <div class="sect2">
1.75      rillig   7563: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7564: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   7565: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      7566:     package Makefile. This will override the package's own libtool
                   7567:     in most cases.  For older libtool using packages,  libtool is
                   7568:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  7569:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      7570:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   7571: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      7572:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      7573:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   7574:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      7575:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   7576: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      7577:     libraries built and installed, then use
                   7578:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   7579: <p>If your package makes use of the platform-independent library
1.87      wiz      7580:     for loading dynamic shared objects, that comes with libtool
                   7581:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   7582: <p>Some packages use libtool incorrectly so that the package
                   7583:     may not work or build in some circumstances. Some of the more
                   7584:     common errors are:</p>
1.148     asau     7585: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7586: <li class="listitem">
1.75      rillig   7587: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      7588:        executable or library. This in itself isn't a problem if one of two things
                   7589:        has been done:</p>
1.128     wiz      7590: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7591: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      7592:            <code class="filename">libfoo.la</code>, not
                   7593:            <code class="filename">foo.la</code></p></li>
1.128     wiz      7594: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   7595: </ol></div>
                   7596: </li>
1.128     wiz      7597: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      7598:        The function lt_dlinit() should be called and the macro
                   7599:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   7600:        executables.</p></li>
1.75      rillig   7601: </ul></div>
                   7602: </div>
1.148     asau     7603: <div class="sect2">
1.75      rillig   7604: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7605: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   7606: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      7607:     to regenerate the configure script and Makefile.in makefile
                   7608:     templates, then they should be executed in a pre-configure
                   7609:     target.</p>
1.75      rillig   7610: <p>For packages that need only autoconf:</p>
                   7611: <pre class="programlisting">
1.100     rillig   7612: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   7613: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   7614: ...
1.1       grant    7615: 
1.100     rillig   7616: pre-configure:
                   7617:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    7618: 
1.100     rillig   7619: ...
1.222     sevan    7620: </pre>
1.75      rillig   7621: <p>and for packages that need automake and autoconf:</p>
                   7622: <pre class="programlisting">
1.100     rillig   7623: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   7624: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   7625: ...
                   7626: 
                   7627: pre-configure:
                   7628:         set -e; cd ${WRKSRC}; \
                   7629:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    7630: 
1.100     rillig   7631: ...
1.222     sevan    7632: </pre>
1.75      rillig   7633: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      7634:     require GNU Make.</p>
1.75      rillig   7635: <p>There are times when the configure process makes
1.87      wiz      7636:     additional changes to the generated files, which then causes
                   7637:     the build process to try to re-execute the automake sequence.
                   7638:     This is prevented by touching various files in the configure
                   7639:     stage. If this causes problems with your package you can set
                   7640:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   7641:     Makefile.</p>
1.75      rillig   7642: </div>
                   7643: </div>
1.148     asau     7644: <div class="sect1">
1.75      rillig   7645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7646: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148     asau     7647: <div class="sect2">
1.87      wiz      7648: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7649: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      7650: <p>Compilers for the C, C++, and Fortran languages comes with
                   7651:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   7652:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  7653:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      7654: <p>To declare which language's compiler a package needs, set
                   7655:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      7656:     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
                   7657:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   7658:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      7659:     written in C++, usually need a C compiler for the configure
                   7660:     phase.</p>
                   7661: </div>
1.148     asau     7662: <div class="sect2">
1.87      wiz      7663: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7664: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      7665: <p>If a program is written in Java, use the Java framework in
                   7666:     pkgsrc.  The package must include
                   7667:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   7668:     provides the following variables:</p>
1.148     asau     7669: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7670: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      7671:       dependency on the JDK is added.  If
1.128     wiz      7672:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      7673:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      7674:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      7675:       JDK.</p></li>
1.128     wiz      7676: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      7677:       a package needs a Java2 implementation.  The supported values
1.128     wiz      7678:       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
                   7679:       <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
                   7680:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   7681:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      7682:       above. This variable is not set by default.</p></li>
1.130     wiz      7683: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   7684:       automatically set to the runtime location of the used Java
                   7685:       implementation dependency. It may be used to set
                   7686:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   7687:       needs this variable to be defined.
                   7688:       </p></li>
1.87      wiz      7689: </ul></div>
                   7690: </div>
1.148     asau     7691: <div class="sect2">
1.87      wiz      7692: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7693: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      7694: <p>If your package contains interpreted perl scripts, add
1.128     wiz      7695:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      7696:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   7697:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   7698:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      7699:     that you want adjusted. Every occurrence of
                   7700:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   7701:     replaced with the full path to the perl executable.</p>
1.87      wiz      7702: <p>If a particular version of perl is needed, set the
                   7703:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      7704:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.110     hubertf  7705: <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      7706:     about handling perl modules.</p>
                   7707: </div>
1.148     asau     7708: <div class="sect2">
1.87      wiz      7709: <div class="titlepage"><div><div><h3 class="title">
1.147     wiz      7710: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
                   7711: <p><code class="varname">REPLACE_SH</code>,
                   7712:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   7713:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   7714:     hash bangs in files. Please use the appropriate one, prefering
                   7715:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      7716:     Each should contain a list of scripts, relative to
                   7717:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   7718:     occurrence of the matching shell in a she-bang line will be
                   7719:     replaced with the full path to the shell executable.
1.147     wiz      7720:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   7721:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   7722: </div>
1.148     asau     7723: <div class="sect2">
1.147     wiz      7724: <div class="titlepage"><div><div><h3 class="title">
                   7725: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      7726: <p>Currently, there is no special handling for other languages
                   7727:     in pkgsrc.  If a compiler package provides a
                   7728:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   7729:     just add a (build) dependency on the appropriate compiler
                   7730:     package.</p>
                   7731: </div>
                   7732: </div>
1.148     asau     7733: <div class="sect1">
1.87      wiz      7734: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7735: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   7736: <p>The most common failures when building a package are that
                   7737:        some platforms do not provide certain header files, functions or
                   7738:        libraries, or they provide the functions in a library that the
                   7739:        original package author didn't know. To work around this, you
                   7740:        can rewrite the source code in most cases so that it does not
                   7741:        use the missing functions or provides a replacement function.</p>
1.148     asau     7742: <div class="sect2">
1.77      rillig   7743: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7744: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   7745: <p>If a package already comes with a GNU configure script, the
                   7746:        preferred way to fix the build failure is to change the
                   7747:        configure script, not the code. In the other cases, you can
                   7748:        utilize the C preprocessor, which defines certain macros
                   7749:        depending on the operating system and hardware architecture it
                   7750:        compiles for. These macros can be queried using for example
                   7751:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   7752:        system, hardware architecture and compiler has its own macro.
                   7753:        For example, if the macros <code class="varname">__GNUC__</code>,
                   7754:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   7755:        are all defined, you know that you are using NetBSD on an i386
                   7756:        compatible CPU, and your compiler is GCC.</p>
                   7757: <p>The list of the following macros for hardware and
                   7758:        operating system depends on the compiler that is used. For
                   7759:        example, if you want to conditionally compile code on Solaris,
                   7760:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   7761:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     7762: <div class="sect3">
1.75      rillig   7763: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7764: <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   7765: <p>To distinguish between 4.4 BSD-derived systems and the
                   7766:         rest of the world, you should use the following code.</p>
                   7767: <pre class="programlisting">
1.100     rillig   7768: #include &lt;sys/param.h&gt;
                   7769: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   7770: /* BSD-specific code goes here */
                   7771: #else
                   7772: /* non-BSD-specific code goes here */
                   7773: #endif
1.75      rillig   7774: </pre>
1.77      rillig   7775: <p>If this distinction is not fine enough, you can also test
                   7776:        for the following macros.</p>
1.75      rillig   7777: <pre class="programlisting">
1.151     obache   7778: Cygwin      __CYGWIN__
                   7779: DragonFly   __DragonFly__
1.100     rillig   7780: FreeBSD     __FreeBSD__
1.151     obache   7781: Haiku       __HAIKU__
1.100     rillig   7782: Interix     __INTERIX
                   7783: IRIX        __sgi (TODO: get a definite source for this)
                   7784: Linux       linux, __linux, __linux__
1.193     dholland 7785: Mac OS X    __APPLE__
1.151     obache   7786: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   7787: Minix3      __minix
1.100     rillig   7788: NetBSD      __NetBSD__
                   7789: OpenBSD     __OpenBSD__
                   7790: Solaris     sun, __sun
1.75      rillig   7791: </pre>
                   7792: </div>
1.148     asau     7793: <div class="sect3">
1.75      rillig   7794: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7795: <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   7796: <pre class="programlisting">
1.100     rillig   7797: i386        i386, __i386, __i386__
                   7798: MIPS        __mips
                   7799: SPARC       sparc, __sparc
1.75      rillig   7800: </pre>
                   7801: </div>
1.148     asau     7802: <div class="sect3">
1.75      rillig   7803: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7804: <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   7805: <pre class="programlisting">
1.100     rillig   7806: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   7807: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   7808: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   7809: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   7810: </pre>
                   7811: </div>
                   7812: </div>
1.148     asau     7813: <div class="sect2">
1.78      rillig   7814: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7815: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   7816: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      7817:         combinations of compiler version and architecture and almost
                   7818:         always relation to optimisation being enabled.  Common symptoms
                   7819:         are gcc internal errors or never finishing compiling a
1.78      rillig   7820:        file.</p>
                   7821: <p>Typically, a workaround involves testing the
                   7822:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   7823:         optimisation for that combination of file,
1.198     tnn      7824:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   7825: <p>This used to be a big problem in the past, but is rarely
                   7826:        needed now as compiler technology has matured. If you still need
                   7827:        to add a compiler specific workaround, please do so in the file
                   7828:        <code class="filename">hacks.mk</code> and describe the symptom and
                   7829:        compiler version as detailed as possible.</p>
1.78      rillig   7830: </div>
1.148     asau     7831: <div class="sect2">
1.78      rillig   7832: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz      7833: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   7834: </h3></div></div></div>
1.92      rillig   7835: <p>This error message often means that a package did not
1.78      rillig   7836:        link to a shared library it needs. The following functions are
                   7837:        known to cause this error message over and over.</p>
                   7838: <div class="informaltable">
1.216     tnn      7839: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   7840: <colgroup>
                   7841: <col>
                   7842: <col>
                   7843: <col>
                   7844: </colgroup>
                   7845: <thead><tr>
                   7846: <th>Function</th>
                   7847: <th>Library</th>
                   7848: <th>Affected platforms</th>
                   7849: </tr></thead>
                   7850: <tbody>
                   7851: <tr>
                   7852: <td>accept, bind, connect</td>
                   7853: <td>-lsocket</td>
                   7854: <td>Solaris</td>
                   7855: </tr>
                   7856: <tr>
                   7857: <td>crypt</td>
                   7858: <td>-lcrypt</td>
                   7859: <td>DragonFly, NetBSD</td>
                   7860: </tr>
                   7861: <tr>
                   7862: <td>dlopen, dlsym</td>
                   7863: <td>-ldl</td>
                   7864: <td>Linux</td>
                   7865: </tr>
                   7866: <tr>
                   7867: <td>gethost*</td>
                   7868: <td>-lnsl</td>
                   7869: <td>Solaris</td>
                   7870: </tr>
                   7871: <tr>
                   7872: <td>inet_aton</td>
                   7873: <td>-lresolv</td>
                   7874: <td>Solaris</td>
                   7875: </tr>
                   7876: <tr>
                   7877: <td>nanosleep, sem_*, timer_*</td>
                   7878: <td>-lrt</td>
                   7879: <td>Solaris</td>
                   7880: </tr>
                   7881: <tr>
                   7882: <td>openpty</td>
                   7883: <td>-lutil</td>
                   7884: <td>Linux</td>
                   7885: </tr>
                   7886: </tbody>
                   7887: </table>
                   7888: </div>
                   7889: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      7890:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   7891:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  7892:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      7893:     bmake</strong></span>.</p>
1.148     asau     7894: <div class="sect3">
1.92      rillig   7895: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   7896: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   7897: <p>When you are using the SunPro compiler, there is another
                   7898: possibility. That compiler cannot handle the following code:</p>
                   7899: <pre class="programlisting">
1.100     rillig   7900: extern int extern_func(int);
1.93      rillig   7901: 
1.100     rillig   7902: static inline int
                   7903: inline_func(int x)
                   7904: {
1.92      rillig   7905:         return extern_func(x);
1.100     rillig   7906: }
1.93      rillig   7907: 
1.100     rillig   7908: int main(void)
                   7909: {
1.92      rillig   7910:         return 0;
1.100     rillig   7911: }
1.92      rillig   7912: </pre>
                   7913: <p>It generates the code for <code class="function">inline_func</code> even if
                   7914: that function is never used. This code then refers to
                   7915: <code class="function">extern_func</code>, which can usually not be resolved. To
                   7916: solve this problem you can try to tell the package to disable inlining
                   7917: of functions.</p>
                   7918: </div>
1.87      wiz      7919: </div>
1.148     asau     7920: <div class="sect2">
1.87      wiz      7921: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7922: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      7923: <p>Sometimes packages fail to build because the compiler runs
                   7924:     into an operating system specific soft limit.  With the
                   7925:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      7926:     to unlimit the resources.  Currently, the allowed values are any combination of
                   7927:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   7928:     <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      7929:     Setting this variable is similar to running the shell builtin
1.110     hubertf  7930:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      7931:     segment size or maximum stack size of a process, respectively, to
                   7932:     their hard limits.</p>
1.78      rillig   7933: </div>
1.75      rillig   7934: </div>
1.148     asau     7935: <div class="sect1">
1.75      rillig   7936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7937: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     7938: <div class="sect2">
1.75      rillig   7939: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7940: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  7941: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      7942:     with some operating systems cannot create more than one
                   7943:     directory at a time. As such, you should call
                   7944:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   7945: <pre class="programlisting">
1.100     rillig   7946: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   7947: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    7948: </pre>
1.128     wiz      7949: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   7950:     dir2</code></span>&#8221;</span> to the
1.87      wiz      7951:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   7952:     automatically do the right thing.</p>
1.75      rillig   7953: </div>
1.148     asau     7954: <div class="sect2">
1.75      rillig   7955: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7956: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      7957: <p>In general, documentation should be installed into
1.87      wiz      7958:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   7959:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   7960:     includes the version number of the package).</p>
1.84      wiz      7961: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      7962:     directory where HTML documentation is installed with the
1.128     wiz      7963:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      7964:     is needed because otherwise the documentation ends up in
                   7965:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   7966:     places.</p>
                   7967: <p>An exception to the above is that library API documentation
1.250     leot     7968:     generated with the <a href="https://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      7969:     browsers (devhelp) should be left at their default location, which
                   7970:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   7971:     documentation can be recognized from files ending in
                   7972:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   7973:     (It is also acceptable to install such files in
                   7974:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   7975:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   7976:     <code class="filename">.devhelp*</code> file must be directly in that
                   7977:     directory then, no additional subdirectory level is allowed in
                   7978:     this case. This is usually achieved by using
1.128     wiz      7979:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      7980:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   7981:     though.)</p>
1.75      rillig   7982: </div>
1.148     asau     7983: <div class="sect2">
1.75      rillig   7984: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7985: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   7986: <p>Certain packages, most of them in the games category, install
1.87      wiz      7987:     a score file that allows all users on the system to record their
                   7988:     highscores.  In order for this to work, the binaries need to be
                   7989:     installed setgid and the score files owned by the appropriate
1.142     wiz      7990:     group and/or owner (traditionally the "games" user/group).  Set
                   7991:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      7992:     following variables, documented in more detail in
                   7993:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      7994:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   7995:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     7996:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   7997:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   7998:     <code class="varname">GAMEDATA_PERMS</code> and
                   7999:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8000: <p>An example that illustrates some of the variables described above is
                   8001:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8002:     used to properly set directory permissions of the directory where the
                   8003:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8004:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8005:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8006:     binary:</p>
                   8007: <pre class="programlisting">
1.223     rillig   8008: USE_GAMESGROUP=         yes
1.210     leot     8009: 
1.223     rillig   8010: BUILD_DEFS+=            VARBASE
1.210     leot     8011: 
1.223     rillig   8012: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8013: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8014: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    8015: </pre>
1.210     leot     8016: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8017:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8018:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8019:     needed to be accessed by setgid games and
                   8020:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 8021: <p>A package should therefore never hard code file ownership or
1.210     leot     8022:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8023:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8024:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8025:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   8026: </div>
1.148     asau     8027: <div class="sect2">
1.75      rillig   8028: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8029: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8030: <p><code class="varname">DESTDIR</code> support means that a package
                   8031:     installs into a staging directory, not the final location of the
                   8032:     files. Then a binary package is created which can be used for
                   8033:     installation as usual. There are two ways: Either the package must
1.128     wiz      8034:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8035:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     8036: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8037: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     8038:       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>.
                   8039:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      8040:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8041:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 8042:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8043:       the inclusion.</p></li>
1.128     wiz      8044: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      8045:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      8046: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      8047:       automatically. Many manual rules and pre/post-install often are
                   8048:       incorrect; fix them.</p></li>
1.128     wiz      8049: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     8050:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      8051: <li class="listitem"><p>In general, packages should support
1.103     wiz      8052:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8053:       DESTDIR.</p></li>
                   8054: </ul></div>
                   8055: </div>
1.148     asau     8056: <div class="sect2">
1.103     wiz      8057: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8058: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8059: <p>Your package may also contain scripts with hardcoded paths to
                   8060:       other interpreters besides (or as well as) perl.  To correct the
                   8061:       full pathname to the script interpreter, you need to set the
                   8062:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8063:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8064: <pre class="programlisting">
1.100     rillig   8065: REPLACE_INTERPRETER+=   tcl
                   8066: REPLACE.tcl.old=        .*/bin/tclsh
                   8067: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8068: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8069: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    8070: </pre>
1.148     asau     8071: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8072: <h3 class="title">Note</h3>
                   8073: <p>Before March 2006, these variables were called
1.87      wiz      8074:     <code class="varname">_REPLACE.*</code> and
                   8075:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8076: </div>
                   8077: </div>
1.148     asau     8078: <div class="sect2">
1.75      rillig   8079: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8080: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8081: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8082:     the Makefile fragment
                   8083:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8084:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8085:     configuration for such modules as well as various hooks to tune
                   8086:     this configuration.  See comments in this file for
                   8087:     details.</p>
1.75      rillig   8088: <p>Perl5 modules will install into different places depending
1.87      wiz      8089:     on the version of perl used during the build process.  To
                   8090:     address this, pkgsrc will append lines to the
                   8091:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8092:     the installed <code class="filename">.packlist</code> file generated by
                   8093:     most perl5 modules.  This is invoked by defining
                   8094:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      8095:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8096:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8097:     e.g.:</p>
1.75      rillig   8098: <pre class="programlisting">
1.153     wiz      8099: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    8100: </pre>
1.153     wiz      8101: <p>The perl5 config variables
                   8102:     <code class="varname">installarchlib</code>,
                   8103:     <code class="varname">installscript</code>,
                   8104:     <code class="varname">installvendorbin</code>,
                   8105:     <code class="varname">installvendorscript</code>,
                   8106:     <code class="varname">installvendorarch</code>,
                   8107:     <code class="varname">installvendorlib</code>,
                   8108:     <code class="varname">installvendorman1dir</code>, and
                   8109:     <code class="varname">installvendorman3dir</code> represent those
                   8110:     locations in which components of perl5 modules may be installed,
                   8111:     provided as variable with uppercase and prefixed with
                   8112:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8113:     and may be used by perl5 packages that don't have a packlist.
                   8114:     These variables are also substituted for in the
                   8115:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8116:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   8117: </div>
1.148     asau     8118: <div class="sect2">
1.75      rillig   8119: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8120: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8121: <p>Some packages install info files or use the
1.128     wiz      8122:     <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      8123:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8124:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8125:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8126:     handle registration of the info files in the Info directory
1.128     wiz      8127:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      8128:     files registration is either provided by the system, or by a
                   8129:     special purpose package automatically added as dependency if
                   8130:     needed.</p>
1.75      rillig   8131: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8132:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8133:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      8134:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   8135: <p>The info files for the package should be listed in the
1.87      wiz      8136:     package <code class="filename">PLIST</code>; however any split info files
                   8137:     need not be listed.</p>
1.128     wiz      8138: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8139:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      8140:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      8141:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      8142:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8143:     variable in the package <code class="filename">Makefile</code>. By
                   8144:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  8145:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      8146:     does not match the required minimum, a build dependency on the
1.250     leot     8147:     <a href="https://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      8148:     be added automatically.</p>
1.75      rillig   8149: <p>The build and installation process of the software provided
1.87      wiz      8150:     by the package should not use the
1.110     hubertf  8151:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      8152:     info files is the task of the package
                   8153:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  8154:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   8155: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  8156:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8157:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      8158:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  8159: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      8160:     no effect except the logging of a message. The script overriding
1.110     hubertf  8161:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      8162:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  8163:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8164: </div>
1.148     asau     8165: <div class="sect2">
1.75      rillig   8166: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8167: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8168: <p>All packages that install manual pages should install them
1.87      wiz      8169:     into the same directory, so that there is one common place to look
                   8170:     for them. In pkgsrc, this place is
                   8171:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8172:     should be used in packages. The default for
                   8173:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      8174:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8175:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     8176: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8177: <h3 class="title">Note</h3>
1.87      wiz      8178: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8179:     is far from complete.</p>
1.75      rillig   8180: </div>
1.81      rillig   8181: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8182:     <code class="filename">man/</code> as the top level directory for the man
                   8183:     page file entries, and the pkgsrc framework will convert as
                   8184:     needed. In all other places, the correct
                   8185:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8186: <p>Packages that are
                   8187:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      8188:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      8189:     <code class="filename">./configure</code>
                   8190:     --mandir switch to set where the man pages should be installed.
                   8191:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8192:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8193: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8194:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      8195:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      8196:     Or if the <code class="filename">./configure</code> script uses
                   8197:     a non-standard use of --mandir, you can set
                   8198:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  8199: <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      8200:     information on installation of compressed manual pages.</p>
1.75      rillig   8201: </div>
1.148     asau     8202: <div class="sect2">
1.75      rillig   8203: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   8204: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      8205: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   8206:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      8207:     you need to take some extra steps to make sure they get registered
                   8208:     in the database:</p>
1.128     wiz      8209: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8210: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      8211:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   8212:        takes care of rebuilding the GConf database at installation and
1.87      wiz      8213:        deinstallation time, and tells the package where to install
1.107     rillig   8214:        GConf data files using some standard configure arguments.  It
1.87      wiz      8215:        also disallows any access to the database directly from the
                   8216:        package.</p></li>
1.128     wiz      8217: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      8218:        <code class="filename">.schemas</code> files under
                   8219:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8220:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8221:        need to manually patch the package.</p></li>
1.128     wiz      8222: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8223:        directory, as they will be handled automatically.  See
1.194     bsiegert 8224:        <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      8225: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      8226:        your <code class="filename">Makefile</code> with a list of all
                   8227:        <code class="filename">.schemas</code> files installed by the package, if
                   8228:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      8229: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      8230:        your <code class="filename">Makefile</code> with a
                   8231:        list of all <code class="filename">.entries</code> files installed by the
                   8232:        package, if any. Names must not contain any directories in
                   8233:        them.</p></li>
1.75      rillig   8234: </ol></div>
                   8235: </div>
1.148     asau     8236: <div class="sect2">
1.75      rillig   8237: <div class="titlepage"><div><div><h3 class="title">
1.119     mishka   8238: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      8239: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   8240:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      8241:     get registered in the database:</p>
1.128     wiz      8242: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8243: <li class="listitem"><p>Include
1.119     mishka   8244:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   8245:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      8246:        takes care of rebuilding the scrollkeeper database at
                   8247:        installation and deinstallation time, and disallows any access
                   8248:        to it directly from the package.</p></li>
1.128     wiz      8249: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8250:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8251:        will be handled automatically.</p></li>
1.128     wiz      8252: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   8253:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   8254:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   8255: </ol></div>
                   8256: </div>
1.148     asau     8257: <div class="sect2">
1.75      rillig   8258: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8259: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   8260: <p>If a package installs font files, you will need to rebuild
1.87      wiz      8261:     the fonts database in the directory where they get installed at
                   8262:     installation and deinstallation time.  This can be automatically
                   8263:     done by using the pkginstall framework.</p>
1.75      rillig   8264: <p>You can list the directories where fonts are installed in the
1.87      wiz      8265:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8266:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      8267:     <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      8268:     Also make sure that the database file
                   8269:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   8270: <p>Note that you should not create new directories for fonts;
1.87      wiz      8271:     instead use the standard ones to avoid that the user needs to
                   8272:     manually configure his X server to find them.</p>
1.75      rillig   8273: </div>
1.148     asau     8274: <div class="sect2">
1.75      rillig   8275: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8276: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   8277: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      8278:     take some extra steps to get them registered in the GTK2 database
                   8279:     properly:</p>
1.128     wiz      8280: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8281: <li class="listitem"><p>Include
1.87      wiz      8282:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8283:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8284:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      8285: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      8286:       your package installs GTK2 immodules.</p></li>
1.128     wiz      8287: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      8288:       GTK2 loaders.</p></li>
1.128     wiz      8289: <li class="listitem">
1.87      wiz      8290: <p>Patch the package to not touch any of the GTK2
                   8291:       databases directly.  These are:</p>
1.148     asau     8292: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8293: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8294: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   8295: </ul></div>
                   8296: </li>
1.128     wiz      8297: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      8298:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8299:       directory, as they will be handled automatically.</p></li>
1.75      rillig   8300: </ol></div>
                   8301: </div>
1.148     asau     8302: <div class="sect2">
1.75      rillig   8303: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8304: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   8305: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      8306:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8307:     etc.), you need to take some extra steps:</p>
1.128     wiz      8308: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8309: <li class="listitem"><p>Include
1.87      wiz      8310:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8311:        your <code class="filename">Makefile</code>, which takes care of
                   8312:        registering those files in system-wide catalogs at
                   8313:        installation and deinstallation time.</p></li>
1.128     wiz      8314: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      8315:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      8316: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      8317:        any XML catalogs installed by the package.</p></li>
1.128     wiz      8318: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      8319:        to be added to the SGML catalog.  These come in groups of
                   8320:        three strings; see xmlcatmgr(1) for more information
                   8321:        (specifically, arguments recognized by the 'add' action).
                   8322:        Note that you will normally not use this variable.</p></li>
1.128     wiz      8323: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      8324:        to be added to the XML catalog.  These come in groups of three
                   8325:        strings; see xmlcatmgr(1) for more information (specifically,
                   8326:        arguments recognized by the 'add' action).  Note that you will
                   8327:        normally not use this variable.</p></li>
1.75      rillig   8328: </ol></div>
                   8329: </div>
1.148     asau     8330: <div class="sect2">
1.75      rillig   8331: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8332: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   8333: <p>If a package provides extensions to the MIME database by
1.87      wiz      8334:     installing <code class="filename">.xml</code> files inside
                   8335:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8336:     need to take some extra steps to ensure that the database is kept
                   8337:     consistent with respect to these new files:</p>
1.128     wiz      8338: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8339: <li class="listitem"><p>Include
1.87      wiz      8340:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   8341:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   8342:        this same directory, which is reserved for inclusion from
                   8343:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   8344:        care of rebuilding the MIME database at installation and
                   8345:        deinstallation time, and disallows any access to it directly
                   8346:        from the package.</p></li>
1.128     wiz      8347: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8348:        <code class="filename">share/mime</code> directory,
                   8349:        <span class="emphasis"><em>except</em></span> for files saved under
                   8350:        <code class="filename">share/mime/packages</code>.  The former are
                   8351:        handled automatically by
                   8352:        the update-mime-database program, but the latter are
                   8353:        package-dependent and must be removed by the package that
                   8354:        installed them in the first place.</p></li>
1.128     wiz      8355: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      8356:        from the PLIST.  They will be handled by the shared-mime-info
                   8357:        package.</p></li>
1.75      rillig   8358: </ol></div>
                   8359: </div>
1.148     asau     8360: <div class="sect2">
1.75      rillig   8361: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8362: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   8363: <p>If a package uses intltool during its build, add
                   8364:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      8365:     which forces it to use the intltool package provided by pkgsrc,
                   8366:     instead of the one bundled with the distribution file.</p>
1.75      rillig   8367: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      8368:     latest available version; this way, the package benefits of any
                   8369:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   8370: </div>
1.148     asau     8371: <div class="sect2">
1.75      rillig   8372: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8373: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   8374: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      8375:     the startup directory by default, but you can enable it, by adding
                   8376:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  8377:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      8378:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   8379:     it will automatically remove the scripts when the package is
                   8380:     deinstalled.</p>
1.75      rillig   8381: </div>
1.148     asau     8382: <div class="sect2">
1.75      rillig   8383: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8384: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   8385: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      8386:     the <code class="filename">ls-R</code> database of the tree needs to be
                   8387:     updated.</p>
1.148     asau     8388: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8389: <h3 class="title">Note</h3>
1.125     wiz      8390: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      8391:     packages should install files
1.125     wiz      8392:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8393:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   8394: </div>
1.128     wiz      8395: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8396: <li class="listitem"><p>Include
1.125     wiz      8397:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      8398:       takes care of rebuilding the <code class="filename">ls-R</code>
                   8399:       database at installation and deinstallation time.</p></li>
1.128     wiz      8400: <li class="listitem">
1.75      rillig   8401: <p>If your package installs files into a texmf
1.87      wiz      8402:       tree other than the one
1.125     wiz      8403:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8404:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      8405:       trees that need database update.</p>
1.75      rillig   8406: <p>If your package also installs font map files that need
1.110     hubertf  8407:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 8408:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      8409:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   8410:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  8411:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      8412:       be run automatically at installation/deinstallation to
                   8413:       enable/disable font map files for TeX output
                   8414:       drivers.</p>
1.75      rillig   8415: </li>
1.128     wiz      8416: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      8417:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 8418:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   8419: </ol></div>
                   8420: </div>
1.148     asau     8421: <div class="sect2">
1.85      jmmv     8422: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8423: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      8424:     emulation</h3></div></div></div>
                   8425: <p>There are some packages that provide libraries and
                   8426:     executables for running binaries from a one operating system
                   8427:     on a different one (if the latter supports it).  One example
                   8428:     is running Linux binaries on NetBSD.</p>
1.250     leot     8429: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      8430:     helps in extracting and packaging Linux rpm packages.</p>
                   8431: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  8432:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      8433:     if all libraries for each installed executable can be found by
                   8434:     the dynamic linker.  Since the standard dynamic linker is run,
                   8435:     this fails for emulation packages, because the libraries used
                   8436:     by the emulation are not in the standard directories.</p>
                   8437: </div>
1.148     asau     8438: <div class="sect2">
1.87      wiz      8439: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8440: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     8441: <p>If a package installs images under the
1.87      wiz      8442:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   8443:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   8444:     database, you need to take some extra steps to make sure that the
                   8445:     shared theme directory is handled appropriately and that the cache
                   8446:     database is rebuilt:</p>
1.128     wiz      8447: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8448: <li class="listitem"><p>Include
1.87      wiz      8449:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128     wiz      8450: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87      wiz      8451:        entry that refers to the theme cache.</p></li>
1.128     wiz      8452: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85      jmmv     8453:          directories from the <code class="filename">share/icons/hicolor</code>
                   8454:          hierarchy because they will be handled automatically.</p></li>
                   8455: </ol></div>
                   8456: <p>The best way to verify that the PLIST is correct with
                   8457:       respect to the last two points is to regenerate it using
1.110     hubertf  8458:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     8459: </div>
1.148     asau     8460: <div class="sect2">
1.85      jmmv     8461: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8462: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     8463: <p>If a package installs <code class="filename">.desktop</code> files
                   8464:       under <code class="filename">share/applications</code> and these include
1.159     rodent   8465:       MIME information (MimeType key), you need to take extra steps to
                   8466:       ensure that they are registered into the MIME database:</p>
1.128     wiz      8467: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8468: <li class="listitem"><p>Include
1.85      jmmv     8469:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128     wiz      8470: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85      jmmv     8471:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   8472:          It will be handled automatically.</p></li>
                   8473: </ol></div>
                   8474: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  8475:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     8476:       print-PLIST</strong></span>.</p>
1.75      rillig   8477: </div>
                   8478: </div>
1.148     asau     8479: <div class="sect1">
1.87      wiz      8480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8481: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      8482: <p>In some cases one does not have the time to solve a problem
1.125     wiz      8483:   immediately. In this case, one can plainly mark a package as broken.  For
                   8484:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   8485:   reason why the package is broken (similar to the
                   8486:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   8487:   the package will immediately be shown this message, and the build
                   8488:   will not be even tried.</p>
                   8489: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87      wiz      8490:   intervals.</p>
                   8491: </div>
1.75      rillig   8492: </div>
1.148     asau     8493: <div class="chapter">
1.75      rillig   8494: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   8495: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      8496: <p>To check out all the gotchas when building a package, here are
                   8497:   the steps that I do in order to get a package working.  Please note
                   8498:   this is basically the same as what was explained in the previous
                   8499:   sections, only with some debugging aids.</p>
1.148     asau     8500: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8501: <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>
                   8502: <li class="listitem">
1.250     leot     8503: <p>Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88      wiz      8504:       create a directory for a new package, change into it, then run
1.110     hubertf  8505:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   8506: <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>
                   8507: <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>
                   8508: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   8509: </li>
1.128     wiz      8510: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   8511: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   8512: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   8513: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      8514:       configure step to the package's
                   8515:       <code class="filename">Makefile</code>.</p></li>
1.128     wiz      8516: <li class="listitem">
1.75      rillig   8517: <p>Make the package compile, doing multiple rounds of</p>
                   8518: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   8519: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   8520: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   8521: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   8522: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   8523: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   8524: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      8525: <p>Doing this step as non-root user will ensure that no files
                   8526:       are modified that shouldn't be, especially during the build
1.110     hubertf  8527:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   8528:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.250     leot     8529:       from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88      wiz      8530:       package.</p>
1.75      rillig   8531: </li>
1.128     wiz      8532: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   8533:       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>
                   8534: <li class="listitem">
1.76      rillig   8535: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   8536: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8537: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   8538: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   8539: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8540: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      8541: <p>You usually need to be <code class="username">root</code> to do
                   8542:       this.  Look if there are any files left:</p>
1.75      rillig   8543: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8544: <p>If this reveals any files that are missing in
1.88      wiz      8545:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   8546: </li>
1.128     wiz      8547: <li class="listitem">
1.88      wiz      8548: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   8549:       package again and make a binary package:</p>
1.75      rillig   8550: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   8551: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   8552: </li>
1.128     wiz      8553: <li class="listitem">
1.75      rillig   8554: <p>Delete the installed package:</p>
1.88      wiz      8555: <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   8556: </li>
1.128     wiz      8557: <li class="listitem">
1.110     hubertf  8558: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      8559:       command, which shouldn't find anything now:</p>
1.75      rillig   8560: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8561: </li>
1.128     wiz      8562: <li class="listitem">
1.75      rillig   8563: <p>Reinstall the binary package:</p>
1.93      rillig   8564: <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   8565: </li>
1.128     wiz      8566: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   8567: <li class="listitem">
1.250     leot     8568: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="https://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      8569:       reports:</p>
1.75      rillig   8570: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   8571: </li>
1.128     wiz      8572: <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   8573: </ul></div>
                   8574: </div>
1.148     asau     8575: <div class="chapter">
1.75      rillig   8576: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   8577: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   8578: <div class="toc">
                   8579: <p><b>Table of Contents</b></p>
1.210     leot     8580: <dl class="toc">
1.106     rillig   8581: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   8582: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   8583: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.243     wiz      8584: <dt><span class="sect1"><a href="#commit-messages">21.4. Commit Messages</a></span></dt>
                   8585: <dt><span class="sect1"><a href="#committing-importing">21.5. Committing: Adding a package to CVS</a></span></dt>
                   8586: <dt><span class="sect1"><a href="#updating-package">21.6. Updating a package to a newer version</a></span></dt>
                   8587: <dt><span class="sect1"><a href="#renaming-package">21.7. Renaming a package in pkgsrc</a></span></dt>
                   8588: <dt><span class="sect1"><a href="#moving-package">21.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   8589: </dl>
                   8590: </div>
1.148     asau     8591: <div class="sect1">
1.75      rillig   8592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8593: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   8594: <p>Our policy is that we accept binaries only from pkgsrc
                   8595:        developers to guarantee that the packages don't contain any
                   8596:        trojan horses etc. This is not to annoy anyone but rather to
                   8597:        protect our users! You're still free to put up your home-made
                   8598:        binary packages and tell the world where to get them. NetBSD
                   8599:        developers doing bulk builds and wanting to upload them please
1.174     asau     8600:        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
                   8601: builds)</i></a>.</p>
1.75      rillig   8602: </div>
1.148     asau     8603: <div class="sect1">
1.75      rillig   8604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8605: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   8606: <p>First, check that your package is complete, compiles and
1.110     hubertf  8607:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.257     leot     8608:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   8609:        archive that contains all files that make up the package.
1.87      wiz      8610:        Finally, send this package to the pkgsrc bug tracking system,
1.257     leot     8611:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      8612:        that, go to the web page
1.110     hubertf  8613:        <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      8614:        which contains some instructions and a link to a form where you
                   8615:        can submit packages.  The
1.250     leot     8616:        <a href="https://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      8617:        also available as a substitute for either of the above two tools.
                   8618:        </p>
1.87      wiz      8619: <p>In the form of the problem report, the category should be
1.128     wiz      8620:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      8621:        and version number, and the description field should contain a
                   8622:        short description of your package (contents of the COMMENT
                   8623:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      8624:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   8625: <p>If you want to submit several packages, please send a
                   8626:        separate PR for each one, it's easier for us to track things
                   8627:        that way.</p>
                   8628: <p>Alternatively, you can also import new packages into
1.128     wiz      8629:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.215     wiz      8630:        homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.75      rillig   8631:        for details.</p>
                   8632: </div>
1.148     asau     8633: <div class="sect1">
1.75      rillig   8634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8635: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   8636: <p>Please note all package additions, updates, moves, and
1.93      rillig   8637:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   8638:        important to keep this file up to date and conforming to the
                   8639:        existing format, because it will be used by scripts to
1.110     hubertf  8640:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   8641:        sites. Additionally, check the
1.76      rillig   8642:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   8643:        for the package you updated or removed, in case it was mentioned
                   8644:        there.</p>
                   8645: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   8646:        bumped, the change should appear in
1.93      rillig   8647:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   8648:        related or otherwise relevant. Mass bumps that result from a
                   8649:        dependency being updated should not be mentioned. In all other
                   8650:        cases it's the developer's decision.</p>
                   8651: <p>There is a make target that helps in creating proper
1.110     hubertf  8652:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   8653:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   8654:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   8655:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   8656:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  8657:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   8658:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   8659:   For new packages, or package moves or removals, set the
                   8660:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   8661:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  8662:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      8663:   not the same as your NetBSD login name. The target also automatically
                   8664:   removes possibly existing entries for the package in the
                   8665:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     8666:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 8667:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      8668:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   8669:   makes the cvs commands use the main repository.
                   8670:   </p>
1.75      rillig   8671: </div>
1.148     asau     8672: <div class="sect1">
1.75      rillig   8673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.243     wiz      8674: <a name="commit-messages"></a>21.4. Commit Messages</h2></div></div></div>
                   8675: <p>For several years, there have been mirrors of pkgsrc in
                   8676:   fossil, git, and hg. Standard practise when using these tools is to
                   8677:   make the first line of a commit message function as a summary that
                   8678:   can be read without the rest, such as is commonly done with "git log
                   8679:   --oneline". For this reason, we have the following guidelines for
                   8680:   pkgsrc commit messages:</p>
                   8681: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8682: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      8683:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      8684:     package, include the name of the package. For updates, include the
                   8685:     version to which it is updated.</p></li>
                   8686: <li class="listitem"><p>Leave the next line empty.</p></li>
                   8687: <li class="listitem"><p>Then come the details for the commit (changes in that
                   8688:     package, reason for a change) and any relevant PRs. Wrap this
                   8689:     section.</p></li>
                   8690: </ul></div>
                   8691: <p>Here is an example:
                   8692:   </p>
                   8693: <pre class="programlisting">
                   8694:   libxslt: update to 1.0.30
                   8695: 
                   8696:   Changes since 1.0.29:
                   8697:   ...
                   8698:   </pre>
                   8699: <p>
                   8700:   </p>
                   8701: <p>Here is another example:
                   8702:   </p>
                   8703: <pre class="programlisting">
                   8704:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   8705: 
                   8706:   (rationale)
                   8707:   </pre>
                   8708: <p>
                   8709:   </p>
                   8710: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   8711:   allowed on the pkgsrc repository to change commit messages.</p>
                   8712: </div>
                   8713: <div class="sect1">
                   8714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   8715: <a name="committing-importing"></a>21.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      8716: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      8717:   access to the pkgsrc repository.</p>
                   8718: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   8719: Start by adding the directory and then files in the directory. Don't
                   8720: forget to add the new package to the category's
                   8721: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   8722: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   8723: <pre class="programlisting">
                   8724: <code class="prompt">$</code> cd .../pkgsrc/category
                   8725: <code class="prompt">$</code> cvs add pkgname
                   8726: <code class="prompt">$</code> cd pkgname
                   8727: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   8728: <code class="prompt">$</code> cvs add patches/p*
                   8729: <code class="prompt">$</code> cvs status | less
1.141     wiz      8730: <code class="prompt">$</code> cvs commit
1.140     wiz      8731: <code class="prompt">$</code> cd ..
                   8732: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      8733: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     8734: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  8735: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      8736: </pre>
1.87      wiz      8737: <p>The commit message of the initial import should include part of the
1.76      rillig   8738:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      8739:   what the package is/does.</p>
1.140     wiz      8740: <p>Also mention the new package in
                   8741: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   8742: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   8743: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   8744: </div>
1.148     asau     8745: <div class="sect1">
1.75      rillig   8746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.243     wiz      8747: <a name="updating-package"></a>21.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      8748: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   8749:   changes between old and new versions into the commit log when updating
1.87      wiz      8750:   a package. There are various reasons for this:</p>
1.148     asau     8751: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8752: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      8753:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      8754: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      8755:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      8756: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   8757:   repository is very useful for people who read the pkgsrc-changes mailing
                   8758:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      8759:   the package.</p></li>
1.75      rillig   8760: </ul></div>
1.87      wiz      8761: <p>Please also recognize that, just because a new version of a package
1.75      rillig   8762:   has been released, it should not automatically be upgraded in the CVS
                   8763:   repository.  We prefer to be conservative in the packages that are
                   8764:   included in pkgsrc - development or beta packages are not really the
                   8765:   best thing for most places in which pkgsrc is used. Please use your
                   8766:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      8767:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   8768: </div>
1.148     asau     8769: <div class="sect1">
1.75      rillig   8770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.243     wiz      8771: <a name="renaming-package"></a>21.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     8772: <p>Renaming packages is not recommended.</p>
                   8773: <p>When renaming packages, be sure to fix any references to old name
                   8774:   in other Makefiles, options, buildlink files, etc.</p>
                   8775: <p>Also When renaming a package, please define
                   8776:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   8777:   pattern(s) of the previous package name.
                   8778:   This may be repeated for multiple renames.
                   8779:   The new package would be an exact replacement.
                   8780: </p>
1.128     wiz      8781: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     8782:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   8783:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   8784:   not be an exact replacement but is a suggestion for the replaced
                   8785:   functionality.</p>
                   8786: </div>
1.148     asau     8787: <div class="sect1">
1.122     reed     8788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.243     wiz      8789: <a name="moving-package"></a>21.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     8790: <p>It is preferred that packages are not renamed or moved, but if needed
                   8791:   please follow these steps.
                   8792: </p>
1.128     wiz      8793: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8794: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   8795: <li class="listitem">
1.75      rillig   8796: <p>Remove all CVS dirs.</p>
1.87      wiz      8797: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   8798: <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      8799: <p>and use that for further work.</p>
1.75      rillig   8800: </li>
1.128     wiz      8801: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   8802: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   8803: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   8804: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     8805: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   8806: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   8807: for doing an update using pkgsrc building; for example, it can
1.257     leot     8808: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     8809: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   8810: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   8811: it may have multiple matches, so the tool should also check on the
                   8812: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   8813: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   8814: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      8815: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   8816: place.</p></li>
1.128     wiz      8817: <li class="listitem">
1.75      rillig   8818: <p>Check if any package depends on it:
                   8819: </p>
                   8820: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   8821: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   8822: </li>
1.128     wiz      8823: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   8824: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   8825: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   8826: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   8827: <li class="listitem">
1.75      rillig   8828: <p>Commit the changed and removed files:</p>
                   8829: <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      8830: <p>(and any packages from step 5, of course).</p>
1.75      rillig   8831: </li>
                   8832: </ol></div>
                   8833: </div>
                   8834: </div>
1.148     asau     8835: <div class="chapter">
1.75      rillig   8836: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   8837: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   8838: <p>This section contains the answers to questions that may
                   8839:        arise when you are writing a package. If you don't find your
                   8840:        question answered here, first have a look in the other chapters,
                   8841:        and if you still don't have the answer, ask on the
                   8842:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     8843: <div class="qandaset">
1.263   ! leot     8844: <a name="idm79141968"></a><dl>
1.106     rillig   8845: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   8846:        MAKEFLAGS, .MAKEFLAGS and
                   8847:        MAKE_FLAGS?</a>
                   8848: </dt>
1.106     rillig   8849: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   8850:        MAKE, GMAKE and
                   8851:        MAKE_PROGRAM?</a>
                   8852: </dt>
1.106     rillig   8853: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   8854:        CC, PKG_CC and
                   8855:        PKGSRC_COMPILER?</a>
                   8856: </dt>
1.106     rillig   8857: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   8858:        BUILDLINK_LDFLAGS,
                   8859:        BUILDLINK_LDADD and
                   8860:        BUILDLINK_LIBS?</a>
                   8861: </dt>
1.106     rillig   8862: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   8863:        VARNAME=BUILDLINK_PREFIX.foo
                   8864:        say it's empty?</a>
                   8865: </dt>
1.106     rillig   8866: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   8867:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   8868:        don't understand the := inside
                   8869:        it.</a>
                   8870: </dt>
1.106     rillig   8871: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   8872:        developers?</a>
                   8873: </dt>
1.106     rillig   8874: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   8875:        documentation?</a>
                   8876: </dt>
1.106     rillig   8877: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   8878: do?</a>
                   8879: </dt>
1.75      rillig   8880: </dl>
1.148     asau     8881: <table border="0" style="width: 100%;">
                   8882: <colgroup>
1.75      rillig   8883: <col align="left" width="1%">
1.128     wiz      8884: <col>
1.148     asau     8885: </colgroup>
1.75      rillig   8886: <tbody>
1.148     asau     8887: <tr class="question">
1.75      rillig   8888: <td align="left" valign="top">
1.263   ! leot     8889: <a name="devfaq.makeflags"></a><a name="idm79141584"></a><p><b>22.1.</b></p>
1.75      rillig   8890: </td>
                   8891: <td align="left" valign="top"><p>What is the difference between
                   8892:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   8893:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   8894: </tr>
                   8895: <tr class="answer">
1.91      rillig   8896: <td align="left" valign="top"></td>
1.75      rillig   8897: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.257     leot     8898:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   8899:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   8900:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   8901:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   8902: </tr>
1.148     asau     8903: <tr class="question">
1.75      rillig   8904: <td align="left" valign="top">
1.263   ! leot     8905: <a name="devfaq.make"></a><a name="idm79137488"></a><p><b>22.2.</b></p>
1.75      rillig   8906: </td>
                   8907: <td align="left" valign="top"><p>What is the difference between
                   8908:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   8909:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   8910: </tr>
                   8911: <tr class="answer">
1.91      rillig   8912: <td align="left" valign="top"></td>
1.75      rillig   8913: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.257     leot     8914:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   8915:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   8916:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   8917:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   8918:        Make program that is used for building the
                   8919:        package.</p></td>
                   8920: </tr>
1.148     asau     8921: <tr class="question">
1.75      rillig   8922: <td align="left" valign="top">
1.263   ! leot     8923: <a name="devfaq.cc"></a><a name="idm79133136"></a><p><b>22.3.</b></p>
1.75      rillig   8924: </td>
                   8925: <td align="left" valign="top"><p>What is the difference between
                   8926:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   8927:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   8928: </tr>
                   8929: <tr class="answer">
1.91      rillig   8930: <td align="left" valign="top"></td>
1.75      rillig   8931: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   8932:        compiler, which can be configured by the pkgsrc user.
                   8933:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   8934:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   8935:        path to a compiler, but the type of compiler that should be
1.76      rillig   8936:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   8937:        information about the latter variable.</p></td>
                   8938: </tr>
1.148     asau     8939: <tr class="question">
1.75      rillig   8940: <td align="left" valign="top">
1.263   ! leot     8941: <a name="devfaq.bl3flags"></a><a name="idm79128912"></a><p><b>22.4.</b></p>
1.75      rillig   8942: </td>
                   8943: <td align="left" valign="top"><p>What is the difference between
                   8944:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   8945:        <code class="varname">BUILDLINK_LDADD</code> and
                   8946:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   8947: </tr>
                   8948: <tr class="answer">
1.91      rillig   8949: <td align="left" valign="top"></td>
1.75      rillig   8950: <td align="left" valign="top"><p>[FIXME]</p></td>
                   8951: </tr>
1.148     asau     8952: <tr class="question">
1.75      rillig   8953: <td align="left" valign="top">
1.263   ! leot     8954: <a name="devfaq.bl3prefix"></a><a name="idm79126736"></a><p><b>22.5.</b></p>
1.75      rillig   8955: </td>
1.110     hubertf  8956: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   8957:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   8958:        say it's empty?</p></td>
                   8959: </tr>
                   8960: <tr class="answer">
1.91      rillig   8961: <td align="left" valign="top"></td>
1.75      rillig   8962: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      8963:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   8964:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  8965:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   8966:        command.</p></td>
                   8967: </tr>
1.148     asau     8968: <tr class="question">
1.78      rillig   8969: <td align="left" valign="top">
1.263   ! leot     8970: <a name="devfaq.master_sites"></a><a name="idm79115344"></a><p><b>22.6.</b></p>
1.78      rillig   8971: </td>
                   8972: <td align="left" valign="top"><p>What does
1.220     wiz      8973:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   8974:        don't understand the <code class="code">:=</code> inside
1.78      rillig   8975:        it.</p></td>
                   8976: </tr>
                   8977: <tr class="answer">
1.91      rillig   8978: <td align="left" valign="top"></td>
1.220     wiz      8979: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   8980:        assignment operator, although it looks like it.
1.78      rillig   8981:        Instead, it is a degenerate form of
1.220     wiz      8982:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.257     leot     8983:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      8984:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   8985:        case of <code class="varname">MASTER_SITE_*</code>,
                   8986:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   8987:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      8988:        <code class="code">package/</code>. That's where the
                   8989:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   8990:        together.</p></td>
                   8991: </tr>
1.148     asau     8992: <tr class="question">
1.78      rillig   8993: <td align="left" valign="top">
1.263   ! leot     8994: <a name="devfaq.mailinglists"></a><a name="idm79108560"></a><p><b>22.7.</b></p>
1.78      rillig   8995: </td>
                   8996: <td align="left" valign="top"><p>Which mailing lists are there for package
                   8997:        developers?</p></td>
                   8998: </tr>
                   8999: <tr class="answer">
1.91      rillig   9000: <td align="left" valign="top"></td>
1.148     asau     9001: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110     hubertf  9002: <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   9003: <dd><p>This is a list for technical discussions related
                   9004:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9005:        pkgsrc infrastructure, proposed new features, questions related
                   9006:        to porting pkgsrc to a new platform, advice for maintaining a
                   9007:        package, patches that affect many packages, help requests moved
                   9008:        from pkgsrc-users when an infrastructure bug is found,
                   9009:        etc.</p></dd>
1.110     hubertf  9010: <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   9011: <dd><p>All bug reports in category "pkg" sent with
1.257     leot     9012:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   9013:        directly; use one of the other mailing
                   9014:        lists.</p></dd>
                   9015: </dl></div></td>
                   9016: </tr>
1.148     asau     9017: <tr class="question">
1.80      rillig   9018: <td align="left" valign="top">
1.263   ! leot     9019: <a name="devfaq.documentation"></a><a name="idm79104720"></a><p><b>22.8.</b></p>
1.80      rillig   9020: </td>
                   9021: <td align="left" valign="top"><p>Where is the pkgsrc
                   9022:        documentation?</p></td>
                   9023: </tr>
                   9024: <tr class="answer">
1.91      rillig   9025: <td align="left" valign="top"></td>
1.80      rillig   9026: <td align="left" valign="top">
                   9027: <p>There are many places where you can find
                   9028:        documentation about pkgsrc:</p>
1.148     asau     9029: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9030: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   9031:        of chapters that explain large parts of pkgsrc, but some
                   9032:        chapters tend to be outdated. Which ones they are is hard to
                   9033:        say.</p></li>
1.128     wiz      9034: <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   9035:        about certain features, announcements of new parts of the pkgsrc
                   9036:        infrastructure and sometimes even announcements that a certain
                   9037:        feature has been marked as obsolete. The benefit here is that
                   9038:        each message has a date appended to it.</p></li>
1.128     wiz      9039: <li class="listitem"><p>Many of the files in the
1.80      rillig   9040:        <code class="filename">mk/</code> directory start with a comment that
                   9041:        describes the purpose of the file and how it can be used by the
1.92      rillig   9042:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9043:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9044:        help</strong></span>.</p></li>
1.128     wiz      9045: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   9046:        information, but they tend to be highly abbreviated, especially
                   9047:        for actions that occur often. Some contain a detailed
                   9048:        description of what has changed, but they are geared towards the
                   9049:        other pkgsrc developers, not towards an average pkgsrc user.
                   9050:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9051:        don't know what has been before, these messages may not be worth
                   9052:        too much to you.</p></li>
1.128     wiz      9053: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9054:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   9055:        mind of the developer who wrote the code. To get this
1.110     hubertf  9056:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9057:        to see who has written it and ask on the
                   9058:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9059:        find your questions later (see above). To be sure that the
                   9060:        developer in charge reads the mail, you may CC him or
                   9061:        her.</p></li>
                   9062: </ul></div>
                   9063: </td>
                   9064: </tr>
1.148     asau     9065: <tr class="question">
1.92      rillig   9066: <td align="left" valign="top">
1.263   ! leot     9067: <a name="devfaq.too-much-time"></a><a name="idm79098192"></a><p><b>22.9.</b></p>
1.92      rillig   9068: </td>
                   9069: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9070: do?</p></td>
                   9071: </tr>
                   9072: <tr class="answer">
                   9073: <td align="left" valign="top"></td>
                   9074: <td align="left" valign="top">
1.93      rillig   9075: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9076: anyway.</p>
1.148     asau     9077: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9078: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.250     leot     9079:     <a href="https://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   9080:     will tell you about newer versions of installed packages that are
                   9081:     available, but not yet updated in pkgsrc.</p></li>
1.128     wiz      9082: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126     jakllsch 9083:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   9084:     cleanups and enhancements for pkgsrc that would be nice to
                   9085:     have.</p></li>
1.128     wiz      9086: <li class="listitem"><p>Review packages for which review was requested on
1.180     wiz      9087:     the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92      rillig   9088:     mailing list.</p></li>
                   9089: </ul></div>
                   9090: </td>
                   9091: </tr>
1.75      rillig   9092: </tbody>
                   9093: </table>
                   9094: </div>
                   9095: </div>
1.148     asau     9096: <div class="chapter">
1.85      jmmv     9097: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9098: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9099: <div class="toc">
                   9100: <p><b>Table of Contents</b></p>
1.210     leot     9101: <dl class="toc">
1.106     rillig   9102: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9103: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9104: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9105: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     9106: </dl>
                   9107: </div>
1.110     hubertf  9108: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9109: site</a>:</p>
                   9110: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9111:   environment, an intuitive and attractive desktop for users, and the
                   9112:   GNOME development platform, an extensive framework for building
                   9113:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9114: <p>pkgsrc provides a seamless way to automatically build and install
                   9115: a complete GNOME environment <span class="emphasis"><em>under many different
                   9116: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9117: the most advanced build and packaging systems for GNOME due to its
                   9118: included technologies buildlink3, the wrappers and tools framework and
                   9119: automatic configuration file management.  Lots of efforts are put into
                   9120: achieving a completely clean deinstallation of installed software
                   9121: components.</p>
1.110     hubertf  9122: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9123: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9124: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9125: pkgsrc as its preferred packaging system, contributing lots of
                   9126: portability fixes to make GNOME build and install under it.</p>
                   9127: <p>This chapter is aimed at pkgsrc developers and other people
                   9128: interested in helping our GNOME porting and packaging efforts.  It
                   9129: provides instructions on how to manage the existing packages and some
                   9130: important information regarding their internals.</p>
1.148     asau     9131: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85      jmmv     9132: <h3 class="title">We need your help!</h3>
                   9133: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9134:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9135:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9136:   work</a> list!  There is still a long way to go to get a
                   9137:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9138:   achieve it!</p>
                   9139: </div>
1.148     asau     9140: <div class="sect1">
1.85      jmmv     9141: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9142: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     9143: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148     asau     9144: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     9145: <li class="listitem"><p><a href="https://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     9146:     the core GNOME desktop environment.  It only includes the necessary
                   9147:     bits to get it to boot correctly, although it may lack important
                   9148:     functionality for daily operation.  The idea behind this package is
                   9149:     to let end users build their own configurations on top of this one,
                   9150:     first installing this meta package to achieve a functional setup and
                   9151:     then adding individual applications.</p></li>
1.250     leot     9152: <li class="listitem"><p><a href="https://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     9153:     complete installation of the GNOME platform and desktop as defined
                   9154:     by the GNOME project; this is based on the components distributed in
                   9155:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9156:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9157:     official FTP server.  Developer-only tools found in those
                   9158:     directories are not installed unless required by some other
                   9159:     component to work properly.  Similarly, packages from the bindings
                   9160:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9161:     in unless required as a dependency for an end-user component.  This
1.250     leot     9162:     package "extends" <a href="https://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>
                   9163: <li class="listitem"><p><a href="https://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     9164:     Installs all the tools required to build a GNOME component when
                   9165:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9166:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9167: </ul></div>
                   9168: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9169: sorted in a way that eases updates: a package may depend on other
                   9170: packages listed before it but not on any listed after it.  It is very
                   9171: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9172: change it to alphabetical sorting!</em></span></p>
                   9173: </div>
1.148     asau     9174: <div class="sect1">
1.85      jmmv     9175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9176: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9177: <p>Almost all GNOME applications are written in C and use a common
                   9178: set of tools as their build system.  Things get different with the new
                   9179: bindings to other languages (such as Python), but the following will
                   9180: give you a general idea on the minimum required tools:</p>
1.148     asau     9181: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9182: <li class="listitem">
1.85      jmmv     9183: <p>Almost all GNOME applications use the GNU Autotools as their
                   9184:     build system.  As a general rule you will need to tell this to your
                   9185:     package:</p>
1.100     rillig   9186: <pre class="programlisting">
                   9187: GNU_CONFIGURE=yes
1.85      jmmv     9188: USE_LIBTOOL=yes
1.100     rillig   9189: USE_TOOLS+=gmake
                   9190: </pre>
1.85      jmmv     9191: </li>
1.128     wiz      9192: <li class="listitem">
1.85      jmmv     9193: <p>If the package uses pkg-config to detect dependencies, add this
                   9194:     tool to the list of required utilities:</p>
1.222     sevan    9195: <pre class="programlisting">
                   9196: USE_TOOLS+=pkg-config
                   9197: </pre>
1.250     leot     9198: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85      jmmv     9199:     the end of the build process to ensure that you did not miss to
                   9200:     specify any dependency in your package and that the version
                   9201:     requirements are all correct.</p>
                   9202: </li>
1.128     wiz      9203: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93      rillig   9204:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9205:     to handle dependencies and to force the package to use the latest
                   9206:     available version.</p></li>
1.128     wiz      9207: <li class="listitem">
1.85      jmmv     9208: <p>If the package uses gtk-doc (a documentation generation
                   9209:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9210:     tool is rather big and the distfile should come with pregenerated
                   9211:     documentation anyway; if it does not, it is a bug that you ought to
                   9212:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9213:     the default):</p>
1.222     sevan    9214: <pre class="programlisting">
                   9215: CONFIGURE_ARGS+=--disable-gtk-doc
                   9216: </pre>
1.89      rillig   9217: <p>The default location of installed HTML files
                   9218:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9219:     and should not be changed unless the package insists on installing
                   9220:     them somewhere else.  Otherwise programs as
1.110     hubertf  9221:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   9222:     do that with an entry similar to:</p>
1.222     sevan    9223: <pre class="programlisting">
                   9224: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9225: </pre>
1.85      jmmv     9226: </li>
                   9227: </ul></div>
                   9228: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9229: files under the installation prefix to maintain databases.  In this
                   9230: context, shared means that those exact same directories and files are
                   9231: used among several different packages, leading to conflicts in the
                   9232: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9233: handle the most common cases, so you have to forget about using
                   9234: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9235: omitting shared files from them.  If you find yourself doing those,
                   9236: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9237: <p>The following table lists the common situations that result in
                   9238: using shared directories or files.  For each of them, the appropriate
                   9239: solution is given.  After applying the solution be sure to
                   9240: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  9241: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     9242: <div class="table">
1.106     rillig   9243: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.216     tnn      9244: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9245: <colgroup>
                   9246: <col>
                   9247: <col>
                   9248: </colgroup>
                   9249: <thead><tr>
                   9250: <th>If the package...</th>
                   9251: <th>Then...</th>
                   9252: </tr></thead>
                   9253: <tbody>
                   9254: <tr>
                   9255: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119     mishka   9256: <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     9257: </tr>
                   9258: <tr>
                   9259: <td>Installs icons under the
                   9260:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9261:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  9262: <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     9263: </tr>
                   9264: <tr>
                   9265: <td>Installs files under
                   9266:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  9267: <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     9268: </tr>
                   9269: <tr>
                   9270: <td>Installs <code class="filename">.desktop</code> files under
                   9271:         <code class="filename">share/applications</code> and these include MIME
                   9272:         information.</td>
1.110     hubertf  9273: <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     9274: </tr>
                   9275: </tbody>
1.91      rillig   9276: </table></div>
1.85      jmmv     9277: </div>
1.91      rillig   9278: <br class="table-break">
1.85      jmmv     9279: </div>
1.148     asau     9280: <div class="sect1">
1.85      jmmv     9281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9282: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9283: <p>When seeing GNOME as a whole, there are two kinds of
                   9284: updates:</p>
1.148     asau     9285: <div class="variablelist"><dl class="variablelist">
1.85      jmmv     9286: <dt><span class="term">Major update</span></dt>
                   9287: <dd>
                   9288: <p>Given that there is still a very long way for GNOME 3 (if it
                   9289:       ever appears), we consider a major update one that goes from a
                   9290:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9291:       where <code class="literal">Y</code> is even and greater than
                   9292:       <code class="literal">X</code>.  These are hard to achieve because they
                   9293:       introduce lots of changes in the components' code and almost all
                   9294:       GNOME distfiles are updated to newer versions.  Some of them can
                   9295:       even break API and ABI compatibility with the previous major
                   9296:       version series.  As a result, the update needs to be done all at
                   9297:       once to minimize breakage.</p>
                   9298: <p>A major update typically consists of around 80 package
                   9299:       updates and the addition of some new ones.</p>
                   9300: </dd>
                   9301: <dt><span class="term">Minor update</span></dt>
                   9302: <dd>
                   9303: <p>We consider a minor update one that goes from a
                   9304:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9305:       one where <code class="literal">Y</code> is greater than
                   9306:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9307:       not update all GNOME components, can be done in an incremental way
                   9308:       and do not break API nor ABI compatibility.</p>
                   9309: <p>A minor update typically consists of around 50 package
                   9310:       updates, although the numbers here may vary a lot.</p>
                   9311: </dd>
                   9312: </dl></div>
                   9313: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9314: release (either major or minor), the following steps should be
                   9315: followed:</p>
1.128     wiz      9316: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9317: <li class="listitem">
1.85      jmmv     9318: <p>Get a list of all the tarballs that form the new release by
                   9319:     using the following commands.  These will leave the full list of the
1.120     snj      9320:     components' distfiles into the <code class="filename">list.txt</code>
1.85      jmmv     9321:     file:</p>
1.88      wiz      9322: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9323:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9324:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9325: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9326:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9327:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9328: </li>
1.128     wiz      9329: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85      jmmv     9330:     bump their version to the release you are updating them to.  The
                   9331:     three meta packages should be always consistent with versioning.
                   9332:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9333:     in them.</p></li>
1.128     wiz      9334: <li class="listitem">
1.85      jmmv     9335: <p>For each meta package, update all its
                   9336:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9337:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9338:     newer version (even if found in the FTP) because the meta packages
                   9339:     are supposed to list the exact versions that form a specific GNOME
                   9340:     release.  Exceptions are permitted here if a newer version solves a
                   9341:     serious issue in the overall desktop experience; these typically
                   9342:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9343:     from the developers.</p>
                   9344: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9345:     should be updated to the latest version available (if found in
                   9346:     pkgsrc).  This is the case, for example, of the dependencies on the
1.250     leot     9347:     GNU Autotools in the <a href="https://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     9348: </li>
1.128     wiz      9349: <li class="listitem">
1.85      jmmv     9350: <p>Generate a patch from the modified meta packages and extract the
                   9351:     list of "new" lines.  This will provide you an outline on what
                   9352:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   9353: <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     9354: </li>
1.128     wiz      9355: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85      jmmv     9356:     installed packages and start over from scratch at this point.</p></li>
1.128     wiz      9357: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85      jmmv     9358:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9359:     it in order.  For major desktop updates none of these should be
1.93      rillig   9360:     committed until the entire set is completed because there are chances
1.85      jmmv     9361:     of breaking not-yet-updated packages.</p></li>
1.128     wiz      9362: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85      jmmv     9363:     the tree one by one with appropriate log messages.  At the end,
                   9364:     commit the three meta package updates and all the corresponding
                   9365:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9366:     <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>
                   9367: </ol></div>
                   9368: </div>
1.148     asau     9369: <div class="sect1">
1.85      jmmv     9370: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9371: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     9372: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9373: packages.  Please, it is very important that you always, always,
                   9374: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  9375: 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     9376: their attention on portability issues and to ensure that future versions
                   9377: can be built out-of-the box on NetBSD.  The less custom patches in
                   9378: pkgsrc, the easier further updates are.  Those developers in charge of
                   9379: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  9380: <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     9381: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9382: of them do.  Do not be short on your reports: always provide detailed
                   9383: explanations of the current failure, how it can be improved to achieve
                   9384: maximum portability and, if at all possible, provide a patch against CVS
                   9385: head.  The more verbose you are, the higher chances of your patch being
                   9386: accepted.</p>
                   9387: <p>Also, please avoid using preprocessor magic to fix portability
                   9388: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9389: GNOME to their operating system, the official GNOME sources are now
                   9390: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9391: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  9392: 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     9393: details.</p>
                   9394: </div>
                   9395: </div>
1.75      rillig   9396: </div>
1.148     asau     9397: <div class="part">
1.75      rillig   9398: <div class="titlepage"><div><div><h1 class="title">
                   9399: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     9400: <div class="partintro">
1.75      rillig   9401: <div></div>
                   9402: <p>This part of the guide deals with everything
                   9403:        from the infrastructure that is behind the interfaces described
                   9404:        in the developer's guide. A casual package maintainer should not
                   9405:        need anything from this part.</p>
                   9406: <div class="toc">
                   9407: <p><b>Table of Contents</b></p>
1.210     leot     9408: <dl class="toc">
1.106     rillig   9409: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   9410: <dd><dl>
1.106     rillig   9411: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   9412: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   9413: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   9414: <dd><dl>
1.106     rillig   9415: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   9416: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   9417: </dl></dd>
1.106     rillig   9418: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   9419: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9420: <dd><dl>
1.106     rillig   9421: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   9422: <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   9423: </dl></dd>
1.106     rillig   9424: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   9425: <dd><dl>
1.128     wiz      9426: <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>
                   9427: <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   9428: </dl></dd>
                   9429: </dl></dd>
1.106     rillig   9430: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   9431: <dd><dl>
1.219     rillig   9432: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
                   9433: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75      rillig   9434: <dd><dl>
1.219     rillig   9435: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
                   9436: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75      rillig   9437: </dl></dd>
                   9438: </dl></dd>
1.106     rillig   9439: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.219     rillig   9440: <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   9441: </dl>
                   9442: </div>
                   9443: </div>
1.148     asau     9444: <div class="chapter">
1.75      rillig   9445: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9446: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   9447: <div class="toc">
                   9448: <p><b>Table of Contents</b></p>
1.210     leot     9449: <dl class="toc">
1.106     rillig   9450: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   9451: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   9452: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   9453: <dd><dl>
1.106     rillig   9454: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   9455: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   9456: </dl></dd>
1.106     rillig   9457: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   9458: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9459: <dd><dl>
1.106     rillig   9460: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   9461: <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   9462: </dl></dd>
1.106     rillig   9463: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   9464: <dd><dl>
1.128     wiz      9465: <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>
                   9466: <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   9467: </dl></dd>
                   9468: </dl>
                   9469: </div>
                   9470: <p>The pkgsrc infrastructure consists of many small Makefile
                   9471:        fragments. Each such fragment needs a properly specified
                   9472:        interface. This chapter explains how such an interface looks
                   9473:        like.</p>
1.148     asau     9474: <div class="sect1">
1.75      rillig   9475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9476: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   9477: <p>Whenever a variable is defined in the pkgsrc
                   9478:        infrastructure, the location and the way of definition provide
                   9479:        much information about the intended use of that variable.
                   9480:        Additionally, more documentation may be found in a header
                   9481:        comment or in this pkgsrc guide.</p>
                   9482: <p>A special file is
                   9483:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   9484:        variables that are intended to be user-defined. They are either
                   9485:        defined using the <code class="literal">?=</code> operator or they are
                   9486:        left undefined because defining them to anything would
1.128     wiz      9487:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   9488:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   9489:        file.</p>
                   9490: <p>Outside this file, the following conventions apply:
                   9491:        Variables that are defined using the <code class="literal">?=</code>
                   9492:        operator may be overridden by a package.</p>
                   9493: <p>Variables that are defined using the <code class="literal">=</code>
                   9494:        operator may be used read-only at run-time.</p>
                   9495: <p>Variables whose name starts with an underscore must not be
                   9496:        accessed outside the pkgsrc infrastructure at all. They may
                   9497:        change without further notice.</p>
1.148     asau     9498: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   9499: <h3 class="title">Note</h3>
                   9500: <p>These conventions are currently not applied
                   9501:        consistently to the complete pkgsrc
                   9502:        infrastructure.</p>
                   9503: </div>
                   9504: </div>
1.148     asau     9505: <div class="sect1">
1.81      rillig   9506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9507: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   9508: <p>All variables that contain lists of things should default
                   9509:        to being empty. Two examples that do not follow this rule are
                   9510:        <code class="varname">USE_LANGUAGES</code> and
                   9511:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   9512:        modified using the <code class="literal">+=</code> operator in package
                   9513:        <code class="filename">Makefile</code>s (or other files included by
                   9514:        them), since there is no guarantee whether the variable is
                   9515:        already set or not, and what its value is. In the case of
1.128     wiz      9516:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   9517:        the default value and just define it as in the following
                   9518:        example.</p>
                   9519: <pre class="programlisting">
1.100     rillig   9520: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   9521: </pre>
                   9522: <p>Because of the selection of this default value, the same
                   9523:        value appears in many package Makefiles. Similarly for
                   9524:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      9525:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   9526:        doesn't stand out. Nevertheless it is mentioned in many
                   9527:        files.</p>
                   9528: </div>
1.148     asau     9529: <div class="sect1">
1.81      rillig   9530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9531: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148     asau     9532: <div class="sect2">
1.75      rillig   9533: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9534: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   9535: <p>Variable evaluation takes place either at load time or at
                   9536:        runtime, depending on the context in which they occur. The
                   9537:        contexts where variables are evaluated at load time are:</p>
1.148     asau     9538: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9539: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   9540:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      9541: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   9542:        <code class="literal">.for</code>,</p></li>
1.128     wiz      9543: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   9544: </ul></div>
                   9545: <p>A special exception are references to the iteration
                   9546:        variables of <code class="literal">.for</code> loops, which are expanded
                   9547:        inline, no matter in which context they appear.</p>
                   9548: <p>As the values of variables may change during load time,
                   9549:        care must be taken not to evaluate them by accident. Typical
                   9550:        examples for variables that should not be evaluated at load time
                   9551:        are <code class="varname">DEPENDS</code> and
                   9552:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   9553:        clear, here is an example:</p>
                   9554: <pre class="programlisting">
1.100     rillig   9555: CONFIGURE_ARGS=         # none
                   9556: CFLAGS=                 -O
                   9557: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    9558: 
1.100     rillig   9559: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    9560: 
1.100     rillig   9561: CFLAGS+=                -Wall
1.222     sevan    9562: </pre>
1.75      rillig   9563: <p>This code shows how the use of the <code class="literal">:=</code>
                   9564:        operator can quickly lead to unexpected results. The first
                   9565:        paragraph is fairly common code. The second paragraph evaluates
                   9566:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   9567:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   9568:        <code class="literal">-Wall</code> is appended to the
                   9569:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   9570:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   9571:        paragraphs from above typically occur in completely unrelated
                   9572:        files.</p>
                   9573: </div>
1.148     asau     9574: <div class="sect2">
1.75      rillig   9575: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9576: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   9577: <p>After all the files have been loaded, the values of the
                   9578:        variables cannot be changed anymore. Variables that are used in
                   9579:        the shell commands are expanded at this point.</p>
                   9580: </div>
                   9581: </div>
1.148     asau     9582: <div class="sect1">
1.75      rillig   9583: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9584: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   9585: <p>There are many ways in which the definition and use of a
1.218     rillig   9586:        variable can be restricted in order to detect bugs and violations
                   9587:        of the (mostly unwritten) policies. A package can be checked with
                   9588:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   9589:        rules.</p>
1.78      rillig   9590: </div>
1.148     asau     9591: <div class="sect1">
1.78      rillig   9592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9593: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   9594: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   9595:        of the following classes. Cases where a file falls into more
                   9596:        than one class should be avoided as it often leads to subtle
                   9597:        bugs.</p>
1.148     asau     9598: <div class="sect2">
1.75      rillig   9599: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9600: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   9601: <p>In a traditional imperative programming language some of
1.76      rillig   9602:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 9603:        procedures. They take some input parameters and&mdash;after
                   9604:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   9605:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   9606:        care must be taken not to use parameter names that have already
                   9607:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   9608:        bad choice for a parameter name.</p>
                   9609: <p>Procedures are completely evaluated at preprocessing time.
                   9610:        That is, when calling a procedure all input parameters must be
                   9611:        completely resolvable. For example,
                   9612:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   9613:        parameter since it is very likely that further text will be
                   9614:        added after calling the procedure, which would effectively apply
                   9615:        the procedure to only a part of the variable. Also, references
1.218     rillig   9616:        to other variables will be modified after calling the
1.75      rillig   9617:        procedure.</p>
                   9618: <p>A procedure can declare its output parameters either as
                   9619:        suitable for use in preprocessing directives or as only
                   9620:        available at runtime. The latter alternative is for variables
                   9621:        that contain references to other runtime variables.</p>
                   9622: <p>Procedures shall be written such that it is possible to
                   9623:        call the procedure more than once. That is, the file must not
                   9624:        contain multiple-inclusion guards.</p>
                   9625: <p>Examples for procedures are
1.76      rillig   9626:        <code class="filename">mk/bsd.options.mk</code> and
                   9627:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   9628:        that the parameters are evaluated at load time, they should be
                   9629:        assigned using the <code class="literal">:=</code> operator, which should
                   9630:        be used only for this purpose.</p>
                   9631: </div>
1.148     asau     9632: <div class="sect2">
1.75      rillig   9633: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9634: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   9635: <p>Action files take some input parameters and may define
                   9636:        runtime variables. They shall not define loadtime variables.
                   9637:        There are action files that are included implicitly by the
                   9638:        pkgsrc infrastructure, while other must be included
                   9639:        explicitly.</p>
                   9640: <p>An example for action files is
1.76      rillig   9641:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   9642: </div>
                   9643: </div>
1.148     asau     9644: <div class="sect1">
1.81      rillig   9645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9646: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   9647: <p>Package <code class="filename">Makefile</code>s usually consist of
                   9648:        a set of variable definitions, and include the file
                   9649:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   9650:        Before that, they may also include various other
                   9651:        <code class="filename">*.mk</code> files if they need to query the
                   9652:        availability of certain features like the type of compiler or
                   9653:        the X11 implementation. Due to the heavy use of preprocessor
                   9654:        directives like <code class="literal">.if</code> and
                   9655:        <code class="literal">.for</code>, the order in which the files are loaded
                   9656:        matters.</p>
                   9657: <p>This section describes at which point the various files
                   9658:        are loaded and gives reasons for that order.</p>
1.148     asau     9659: <div class="sect2">
1.81      rillig   9660: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9661: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   9662: </h3></div></div></div>
                   9663: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   9664:        is to define some essential variables like
                   9665:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   9666:        <code class="varname">MACHINE_ARCH</code>.</p>
                   9667: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  9668:        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   9669:        After that, those variables
1.81      rillig   9670:        that have not been overridden by the user are loaded from
                   9671:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   9672: <p>After the user settings, the system settings and platform
                   9673:        settings are loaded, which may override the user
                   9674:        settings.</p>
                   9675: <p>Then, the tool definitions are loaded. The tool wrappers
                   9676:        are not yet in effect. This only happens when building a
                   9677:        package, so the proper variables must be used instead of the
                   9678:        direct tool names.</p>
                   9679: <p>As the last steps, some essential variables from the
                   9680:        wrapper and the package system flavor are loaded, as well as the
                   9681:        variables that have been cached in earlier phases of a package
                   9682:        build.</p>
                   9683: </div>
1.148     asau     9684: <div class="sect2">
1.81      rillig   9685: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9686: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   9687: </h3></div></div></div>
1.81      rillig   9688: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   9689: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   9690:        loaded, which fill default values for those variables that have
1.93      rillig   9691:        not been defined by the package. These variables may later
1.81      rillig   9692:        be used even in unrelated files.</p>
                   9693: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   9694:        provides the target <code class="literal">error-check</code> that is added
                   9695:        as a special dependency to all other targets that use
                   9696:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   9697:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   9698: <p>Then, the package-specific hacks from
                   9699:        <code class="filename">hacks.mk</code> are included.</p>
                   9700: <p>Then, various other files follow. Most of them don't have
                   9701:        any dependencies on what they need to have included before or
                   9702:        after them, though some do.</p>
                   9703: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   9704:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   9705:        restricts the use of these variables to all the files that have
                   9706:        been included before. Appearances in later files will be
                   9707:        silently ignored.</p>
                   9708: <p>Then, the files for the main targets are included, in the
                   9709:        order of later execution, though the actual order should not
                   9710:        matter.</p>
                   9711: <p>At last, some more files are included that don't set any
                   9712:        interesting variables but rather just define make targets to be
                   9713:        executed.</p>
                   9714: </div>
                   9715: </div>
1.75      rillig   9716: </div>
1.148     asau     9717: <div class="chapter">
1.75      rillig   9718: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9719: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   9720: <div class="toc">
                   9721: <p><b>Table of Contents</b></p>
1.210     leot     9722: <dl class="toc">
1.219     rillig   9723: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
                   9724: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75      rillig   9725: <dd><dl>
1.219     rillig   9726: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
                   9727: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75      rillig   9728: </dl></dd>
                   9729: </dl>
                   9730: </div>
                   9731: <p>The pkgsrc infrastructure consists of a large codebase,
                   9732:        and there are many corners where every little bit of a file is
                   9733:        well thought out, making pkgsrc likely to fail as soon as
                   9734:        anything is changed near those parts. To prevent most changes
                   9735:        from breaking anything, a suite of regression tests should go
                   9736:        along with every important part of the pkgsrc infrastructure.
                   9737:        This chapter describes how regression tests work in pkgsrc and
                   9738:        how you can add new tests.</p>
1.148     asau     9739: <div class="sect1">
1.75      rillig   9740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219     rillig   9741: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.250     leot     9742: <p>You first need to install the <a href="https://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  9743:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   9744:        can simply run that command, which will run all tests in the
1.76      rillig   9745:        <code class="filename">regress</code> category.</p>
1.75      rillig   9746: </div>
1.148     asau     9747: <div class="sect1">
1.75      rillig   9748: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219     rillig   9749: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.76      rillig   9750: <p>Every directory in the <code class="filename">regress</code>
                   9751:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   9752:        is considered a regression test. This file is a shell program
1.110     hubertf  9753:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   9754:        The following functions can be overridden to suit your
                   9755:        needs.</p>
1.148     asau     9756: <div class="sect2">
1.75      rillig   9757: <div class="titlepage"><div><div><h3 class="title">
1.219     rillig   9758: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   9759: <p>These functions do not take any parameters. Although they
                   9760:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
                   9761:        first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
                   9762:        question</a> for details.</p>
1.148     asau     9763: <div class="variablelist"><dl class="variablelist">
1.218     rillig   9764: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   9765: <dd><p>This function prepares the environment for the
                   9766:        test. By default it does nothing.</p></dd>
1.218     rillig   9767: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   9768: <dd>
                   9769: <p>This function runs the actual test. By default,
1.75      rillig   9770:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   9771:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   9772:        error messages into the file
1.218     rillig   9773:        <code class="varname">TEST_OUTFILE</code>.</p>
                   9774: <p>When defining this function, make sure that all output that
                   9775:        needs to be checked is written to the correct output file.
                   9776:        Example:</p>
                   9777: <pre class="programlisting">
                   9778: do_test() {
1.223     rillig   9779:         echo "Example output"
1.218     rillig   9780: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   9781: </pre>
                   9782: </dd>
                   9783: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   9784: <dd>
                   9785: <p>This function is run after the test and is
1.75      rillig   9786:        typically used to compare the actual output from the one that is
                   9787:        expected. It can make use of the various helper functions from
1.218     rillig   9788:        the next section. Example:</p>
                   9789: <pre class="programlisting">
                   9790: check_result() {
1.223     rillig   9791:         exit_status 0
                   9792:         output_require "Example"
                   9793:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   9794:         output_prohibit "no such file or directory"
1.218     rillig   9795: }
                   9796: </pre>
                   9797: </dd>
                   9798: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   9799: <dd><p>This function cleans everything up after the
                   9800:        test has been run. By default it does nothing.</p></dd>
                   9801: </dl></div>
                   9802: </div>
1.148     asau     9803: <div class="sect2">
1.75      rillig   9804: <div class="titlepage"><div><div><h3 class="title">
1.219     rillig   9805: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.148     asau     9806: <div class="variablelist"><dl class="variablelist">
1.218     rillig   9807: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   9808: <dd><p>This function compares the exitcode of the
1.218     rillig   9809:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   9810:        If they differ, the test will fail.</p></dd>
1.218     rillig   9811: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   9812: <dd>
                   9813: <p>This function checks for each of its parameters
                   9814:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   9815:        extended regular expression. If it does not, the test will
1.218     rillig   9816:        fail. Example:</p>
                   9817: <pre class="programlisting">
1.219     rillig   9818: output_require "looks fine"
                   9819: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   9820: </pre>
                   9821: </dd>
1.75      rillig   9822: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   9823: <dd><p>This function checks for each of its parameters
1.110     hubertf  9824:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   9825:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   9826:        If any of the regular expressions matches, the test will
                   9827:        fail.</p></dd>
                   9828: </dl></div>
                   9829: </div>
                   9830: </div>
                   9831: </div>
1.148     asau     9832: <div class="chapter">
1.75      rillig   9833: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9834: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   9835: <div class="toc">
                   9836: <p><b>Table of Contents</b></p>
1.219     rillig   9837: <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   9838: </div>
                   9839: <p>The pkgsrc system has already been ported to many
                   9840:        operating systems, hardware architectures and compilers. This
                   9841:        chapter explains the necessary steps to make pkgsrc even more
                   9842:        portable.</p>
1.148     asau     9843: <div class="sect1">
1.75      rillig   9844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9845: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   9846: <p>To port pkgsrc to a new operating system (called
                   9847:        <code class="literal">MyOS</code> in this example), you need to touch the
                   9848:        following files:</p>
1.148     asau     9849: <div class="variablelist"><dl class="variablelist">
1.93      rillig   9850: <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   9851: <dd><p>This file contains some basic definitions, for
                   9852:        example the name of the C
                   9853:        compiler.</p></dd>
1.76      rillig   9854: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   9855: <dd><p>Insert code that defines the variables
                   9856:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   9857:        <code class="varname">LOWER_OS_VERSION</code>,
                   9858:        <code class="varname">LOWER_VENDOR</code>,
                   9859:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   9860:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   9861:        appear in this file.</p></dd>
1.93      rillig   9862: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   9863: <dd><p>This file contains the platform-specific
                   9864:        definitions that are used by pkgsrc. Start by copying one of the
                   9865:        other files and edit it to your
                   9866:        needs.</p></dd>
1.93      rillig   9867: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   9868: <dd><p>This file defines the paths to all the tools
                   9869:        that are needed by one or the other package in pkgsrc, as well
                   9870:        as by pkgsrc itself. Find out where these tools are on your
                   9871:        platform and add them.</p></dd>
                   9872: </dl></div>
                   9873: <p>Now, you should be able to build some basic packages, like
1.250     leot     9874:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   9875: </div>
                   9876: </div>
                   9877: </div>
1.148     asau     9878: <div class="appendix">
                   9879: <div class="titlepage"><div><div><h1 class="title">
                   9880: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   9881: <div class="toc">
                   9882: <p><b>Table of Contents</b></p>
1.210     leot     9883: <dl class="toc">
1.75      rillig   9884: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   9885: <dd><dl>
                   9886: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   9887: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   9888: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz      9889: <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   9890: </dl></dd>
                   9891: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   9892: </dl>
                   9893: </div>
                   9894: <p>We checked to find a piece of software that wasn't in the packages
                   9895:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  9896:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   9897:     present in the tree is beyond us, but it's useful for the purposes of
                   9898:     this exercise.</p>
1.148     asau     9899: <div class="sect1">
1.75      rillig   9900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9901: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     9902: <div class="sect2">
1.75      rillig   9903: <div class="titlepage"><div><div><h3 class="title">
                   9904: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   9905: <pre class="programlisting">
1.100     rillig   9906: # $NetBSD$
                   9907: #
1.1       grant    9908: 
1.100     rillig   9909: DISTNAME=       bison-1.25
                   9910: CATEGORIES=     devel
                   9911: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    9912: 
1.136     dholland 9913: MAINTAINER=     pkgsrc-users@NetBSD.org
1.100     rillig   9914: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   9915: COMMENT=        GNU yacc clone
1.1       grant    9916: 
1.100     rillig   9917: GNU_CONFIGURE=  yes
1.152     wiz      9918: INFO_FILES=     yes
1.1       grant    9919: 
1.100     rillig   9920: .include "../../mk/bsd.pkg.mk"
1.1       grant    9921: </pre>
1.75      rillig   9922: </div>
1.148     asau     9923: <div class="sect2">
1.75      rillig   9924: <div class="titlepage"><div><div><h3 class="title">
                   9925: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   9926: <pre class="programlisting">
1.100     rillig   9927: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.257     leot     9928: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-8.0"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   9929: of the NetBSD source tree is beyond me.
1.1       grant    9930: </pre>
1.75      rillig   9931: </div>
1.148     asau     9932: <div class="sect2">
1.75      rillig   9933: <div class="titlepage"><div><div><h3 class="title">
                   9934: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   9935: <pre class="programlisting">
1.100     rillig   9936: @comment $NetBSD$
                   9937: bin/bison
                   9938: man/man1/bison.1.gz
                   9939: share/bison.simple
                   9940: share/bison.hairy
1.1       grant    9941: </pre>
1.75      rillig   9942: </div>
1.148     asau     9943: <div class="sect2">
1.75      rillig   9944: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  9945: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   9946: </h3></div></div></div>
1.75      rillig   9947: <p>The NetBSD package system comes with
1.250     leot     9948:         <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   9949:        which helps to check the contents of these
                   9950:        files. After installation it is quite easy to use, just change to the
                   9951:        directory of the package you wish to examine and execute
1.110     hubertf  9952:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   9953: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   9954: looks fine.</pre>
                   9955: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  9956:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   9957:        -Wall</strong></span> for a very thorough check.</p>
                   9958: </div>
                   9959: </div>
1.148     asau     9960: <div class="sect1">
1.75      rillig   9961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9962: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   9963: <p>Create the directory where the package lives,
                   9964:       plus any auxiliary directories:</p>
                   9965: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   9966: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   9967: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   9968: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   9969: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  9970:       <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   9971:       then continue with fetching the distfile:</p>
                   9972: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    9973: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   9974: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   9975: Requesting ftp://prep.ai.mit.edu/pub/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://wuarchive.wustl.edu/systems/gnu//.
                   9979: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   9980: ftp: Error retrieving file: 500 Internal error
                   9981: 
                   9982: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   9983: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   9984: Successfully retrieved file.</pre>
                   9985: <p>Generate the checksum of the distfile into
1.76      rillig   9986:       <code class="filename">distinfo</code>:</p>
1.88      wiz      9987: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   9988: <p>Now compile:</p>
                   9989: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    9990: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   9991: ===&gt;  Extracting for bison-1.25
                   9992: ===&gt;  Patching for bison-1.25
                   9993: ===&gt;   Ignoring empty patch directory
                   9994: ===&gt;  Configuring for bison-1.25
                   9995: creating cache ./config.cache
                   9996: checking for gcc... cc
                   9997: checking whether we are using GNU C... yes
                   9998: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   9999: checking how to run the C preprocessor... cc -E
                   10000: checking for minix/config.h... no
                   10001: checking for POSIXized ISC... no
                   10002: checking whether cross-compiling... no
                   10003: checking for ANSI C header files... yes
                   10004: checking for string.h... yes
                   10005: checking for stdlib.h... yes
                   10006: checking for memory.h... yes
                   10007: checking for working const... yes
                   10008: checking for working alloca.h... no
                   10009: checking for alloca... yes
                   10010: checking for strerror... yes
                   10011: updating cache ./config.cache
                   10012: creating ./config.status
                   10013: creating Makefile
                   10014: ===&gt;  Building for bison-1.25
                   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 LR0.c
                   10016: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g allocate.c
                   10017: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g closure.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 conflicts.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 derives.c
1.68      rillig   10020: 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    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 getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.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 print.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 reader.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 reduce.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 symtab.c
                   10032: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g warshall.c
                   10033: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g version.c
                   10034: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt.c
                   10035: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt1.c
                   10036: 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
                   10037: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10038: rm -f bison.s1
1.75      rillig   10039: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10040: <p>Everything seems OK, so install the files:</p>
                   10041: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10042: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10043: ===&gt;  Installing for bison-1.25
                   10044: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10045: rm -f /usr/pkg/bin/bison
                   10046: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10047: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10048: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10049: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10050: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10051: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10052: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10053: ===&gt;  Registering installation for bison-1.25</pre>
                   10054: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10055:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10056:       binary package, do this now:</p>
                   10057: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10058: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10059: ===&gt;  Building package for bison-1.25
                   10060: Creating package bison-1.25.tgz
                   10061: Registering depends:.
1.75      rillig   10062: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10063: <p>Now that you don't need the source and object files
                   10064:       any more, clean up:</p>
                   10065: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10066: ===&gt;  Cleaning for bison-1.25</pre>
                   10067: </div>
                   10068: </div>
1.148     asau     10069: <div class="appendix">
                   10070: <div class="titlepage"><div><div><h1 class="title">
                   10071: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   10072: <div class="toc">
                   10073: <p><b>Table of Contents</b></p>
1.210     leot     10074: <dl class="toc">
1.75      rillig   10075: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10076: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10077: </dl>
                   10078: </div>
1.148     asau     10079: <div class="sect1">
1.75      rillig   10080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10081: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10082: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10083: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10084: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10085: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10086: =&gt; [172219 bytes]
                   10087: Connected to ftp.plig.net.
                   10088: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10089: 331 Guest login ok, send your complete e-mail address as password.
                   10090: 230-You are user #5 of 500 simultaneous users allowed.
                   10091: 230-
1.68      rillig   10092: 230-  ___ _             _ _
                   10093: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10094: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10095: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10096: 230-         |_|   |_|     |___|         |___|
                   10097: 230-
                   10098: 230-** Welcome to ftp.plig.org **
                   10099: 230-
                   10100: 230-Please note that all transfers from this FTP site are logged. If you
                   10101: 230-do not like this, please disconnect now.
                   10102: 230-
1.120     snj      10103: 230-This archive is available via
1.1       grant    10104: 230-
                   10105: 230-HTTP:  http://ftp.plig.org/
                   10106: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10107: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10108: 230-
                   10109: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10110: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10111: 230-
                   10112: 230-
                   10113: 230 Logged in anonymously.
                   10114: Remote system type is UNIX.
                   10115: Using binary mode to transfer files.
                   10116: 200 Type okay.
                   10117: 250 "/pub" is new cwd.
                   10118: 250-"/pub/figlet" is new cwd.
                   10119: 250-
                   10120: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10121: 250-
1.75      rillig   10122: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10123: 250-
                   10124: 250-The official FIGlet web page is:
1.75      rillig   10125: 250-   http://www.figlet.org/
1.1       grant    10126: 250-
                   10127: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10128: 250-contribute a font or something else, you can email us.
1.68      rillig   10129: 250
1.1       grant    10130: 250 "/pub/figlet/program" is new cwd.
                   10131: 250 "/pub/figlet/program/unix" is new cwd.
                   10132: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10133: 502 Unimplemented command.
                   10134: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10135: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10136: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10137: 226 Transfer completed.
                   10138: 172219 bytes received in 00:02 (75.99 KB/s)
                   10139: 221 Goodbye.
                   10140: =&gt; Checksum OK for figlet221.tar.gz.
                   10141: ===&gt; Extracting for figlet-2.2.1nb2
                   10142: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10143: ===&gt; Patching for figlet-2.2.1nb2
                   10144: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10145: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10146: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10147: ===&gt; Configuring for figlet-2.2.1nb2
                   10148: ===&gt; Building for figlet-2.2.1nb2
                   10149: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10150: chmod a+x figlet
                   10151: gcc -O2 -o chkfont chkfont.c
                   10152: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10153: <code class="prompt">#</code>
1.75      rillig   10154: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10155: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10156: ===&gt; Installing for figlet-2.2.1nb2
                   10157: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10158: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10159: mkdir -p /usr/pkg/share/figlet
                   10160: cp figlet /usr/pkg/bin
                   10161: cp chkfont /usr/pkg/bin
                   10162: chmod 555 figlist showfigfonts
                   10163: cp figlist /usr/pkg/bin
                   10164: cp showfigfonts /usr/pkg/bin
                   10165: cp fonts/*.flf /usr/pkg/share/figlet
                   10166: cp fonts/*.flc /usr/pkg/share/figlet
                   10167: cp figlet.6 /usr/pkg/man/man6
                   10168: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10169: <code class="prompt">#</code></pre>
                   10170: </div>
1.148     asau     10171: <div class="sect1">
1.75      rillig   10172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10173: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10174: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10175: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10176: ===&gt; Packaging figlet-2.2.1nb2
                   10177: ===&gt; Building binary package for figlet-2.2.1nb2
                   10178: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10179: Using SrcDir value of /usr/pkg
1.68      rillig   10180: Registering depends:.
1.75      rillig   10181: <code class="prompt">#</code></pre>
                   10182: </div>
                   10183: </div>
1.148     asau     10184: <div class="appendix">
                   10185: <div class="titlepage"><div><div><h1 class="title">
                   10186: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   10187: <div class="toc">
                   10188: <p><b>Table of Contents</b></p>
1.210     leot     10189: <dl class="toc">
1.128     wiz      10190: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10191: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10192: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10193: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10194: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261     leot     10195: <code class="filename">stable</code>,
1.128     wiz      10196: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10197: source packages</a></span></dt>
                   10198: </dl>
                   10199: </div>
                   10200: <p>As in other big projects, the directory layout of pkgsrc
                   10201:        is quite complex for newbies. This chapter explains where you
                   10202:        find things on the FTP server. The base directory on
1.110     hubertf  10203:        <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   10204:        On other servers it may be different, but inside this directory,
                   10205:        everything should look the same, no matter on which server you
                   10206:        are. This directory contains some subdirectories, which are
                   10207:        explained below.</p>
1.148     asau     10208: <div class="sect1">
1.76      rillig   10209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10210: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   10211: <p>The directory <code class="filename">distfiles</code> contains lots
                   10212:        of archive files from all pkgsrc packages, which are mirrored
                   10213:        here. The subdirectories are called after their package names
                   10214:        and are used when the distributed files have names that don't
                   10215:        explicitly contain a version number or are otherwise too generic
                   10216:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10217: </div>
1.148     asau     10218: <div class="sect1">
1.76      rillig   10219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10220: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   10221: <p>This directory contains things that individual pkgsrc
                   10222:        developers find worth publishing.</p>
                   10223: </div>
1.148     asau     10224: <div class="sect1">
1.76      rillig   10225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10226: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   10227: <p>This directory contains binary packages for the various
                   10228:        platforms that are supported by pkgsrc.
                   10229:        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     10230: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10231: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   10232:        operating system for which the packages have been built. The
1.110     hubertf  10233:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   10234:        command, so it may differ from the one you are used to
                   10235:        hear.</p></li>
1.128     wiz      10236: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   10237:        architecture of the platform for which the packages have been
1.110     hubertf  10238:        built. It also includes the <code class="varname">ABI</code> (Application
                   10239:        Binary Interface) for platforms that have several of
                   10240:        them.</p></li>
1.128     wiz      10241: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   10242:        the operating system. For version numbers that change often (for
                   10243:        example NetBSD-current), the often-changing part should be
                   10244:        replaced with an <code class="literal">x</code>, for example
                   10245:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      10246: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 10247:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   10248:        for a stable branch, or <code class="literal">head</code> for packages
                   10249:        built from the HEAD branch. The latter should only be used when
                   10250:        the packages are updated on a regular basis. Otherwise the date
                   10251:        from checking out pkgsrc should be appended, for example
                   10252:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   10253: </ul></div>
                   10254: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10255:        can quickly click through the directories on the
                   10256:        server and find the best binary packages for their machines. Since they
                   10257:        usually know the operating system and the hardware architecture, OPSYS
                   10258:        and ARCH are placed first. After these choices, they can select the
                   10259:        best combination of OSVERSION and TAG together, since it is usually the
                   10260:        case that packages stay compatible between different version of the
                   10261:        operating system.</p>
                   10262: <p>In each of these directories, there is a
                   10263:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   10264:        <code class="filename">All</code> which contains all binary packages.
                   10265:        Besides that, there are various category directories that
                   10266:        contain symbolic links to the real binary packages.</p>
                   10267: </div>
1.148     asau     10268: <div class="sect1">
1.76      rillig   10269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10270: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   10271: <p>Here are the reports from bulk builds, for those who want
                   10272:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      10273:        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   10274: </div>
1.148     asau     10275: <div class="sect1">
1.108     rillig   10276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10277: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.261     leot     10278: <code class="filename">stable</code>,
1.126     jakllsch 10279: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10280: source packages</h2></div></div></div>
1.128     wiz      10281: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   10282:        that is the files that define how to create binary packages from
                   10283:        source archives.</p>
1.262     leot     10284: <p>Each of the <code class="filename">current</code>,
                   10285:        <code class="filename">stable</code> and
                   10286:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10287:        directories share the same structure.  They each contain a
                   10288:        <code class="filename">pkgsrc</code> directory and
                   10289:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   10290: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10291:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     10292:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   10293:        as the directory, ready to be downloaded as a whole.</p>
                   10294: <p>The <code class="filename">current</code> directory contains files
                   10295:        related to the HEAD branch of the CVS repository.
                   10296:        In this directory there is an additional file called
                   10297:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   10298:        all pkgsrc <code class="filename">README</code>s with information about
                   10299:        categories and packages.
                   10300:        </p>
                   10301: <p>The <code class="filename">stable</code> directory is a symlink to
                   10302:        the latest 
                   10303:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   10304:        </p>
                   10305: <p>The
                   10306:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   10307:        directories contain files related to the 
                   10308:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10309:        stable branch of the CVS repository. In these directories there is
                   10310:        an additional file called
                   10311:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.76      rillig   10312:        which contains the state of pkgsrc when it was branched.</p>
                   10313: </div>
1.75      rillig   10314: </div>
1.148     asau     10315: <div class="appendix">
                   10316: <div class="titlepage"><div><div><h1 class="title">
                   10317: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   10318: <div class="toc">
                   10319: <p><b>Table of Contents</b></p>
1.210     leot     10320: <dl class="toc">
1.79      rillig   10321: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   10322: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10323: </dl>
                   10324: </div>
1.79      rillig   10325: <p>This section contains information on editing the pkgsrc
                   10326:        guide itself.</p>
1.148     asau     10327: <div class="sect1">
1.75      rillig   10328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   10329: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10330: <p>The pkgsrc guide's source code is stored in
                   10331:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10332:        are created from it:</p>
1.148     asau     10333: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10334: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   10335: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   10336: <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>
                   10337: <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   10338:        The PDF version of the pkgsrc guide.</p></li>
1.128     wiz      10339: <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   10340:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   10341: </ul></div>
                   10342: </div>
1.148     asau     10343: <div class="sect1">
1.75      rillig   10344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10345: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   10346: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      10347: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     10348: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      10349:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   10350:        documentation) installed. These are automatically installed when
1.250     leot     10351:        you install the <a href="https://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     10352: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   10353:        right directory. All further steps will take place
                   10354:        here.</p></li>
1.148     asau     10355: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   10356:        <code class="filename">files/</code>.</p></li>
1.148     asau     10357: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   10358:        guide for valid XML and to build the final output files. If you
                   10359:        get any errors at this stage, you can just edit the files, as
                   10360:        there are only symbolic links in the working directory, pointing
                   10361:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     10362: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   10363:        commit)</strong></span></p></li>
1.148     asau     10364: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   10365:        regenerate the output files with the proper RCS
                   10366:        Ids.</p></li>
1.148     asau     10367: <li class="step">
1.110     hubertf  10368: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   10369:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   10370:        <code class="filename">htdocs</code>.</p>
1.148     asau     10371: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   10372: <h3 class="title">Note</h3>
                   10373: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  10374:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   10375:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   10376:        directory.</p>
                   10377: </div>
                   10378: </li>
1.79      rillig   10379: </ol></div>
1.75      rillig   10380: </div>
                   10381: </div>
                   10382: </div></body>
1.1       grant    10383: </html>

CVSweb <webmaster@jp.NetBSD.org>