Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.180
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.10 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.166 leot 33: <div><p class="copyright">Copyright © 1994-2020 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.36 2020/01/03 15:55:24 leot Exp $</p></div>
1.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
1.100 leot 48: <dl class="toc">
1.1 dsieger 49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
1.154 rillig 63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1 dsieger 65: <dd><dl>
1.154 rillig 66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 67: <dd><dl>
1.154 rillig 68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 70: </dl></dd>
1.154 rillig 71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 72: <dd><dl>
1.154 rillig 73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 75: </dl></dd>
76: </dl></dd>
1.154 rillig 77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 78: <dd><dl>
1.154 rillig 79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 81: </dl></dd>
1.154 rillig 82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 83: <dd><dl>
1.154 rillig 84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 85: <dd><dl>
1.154 rillig 86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
88: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
90: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
91: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
92: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.1 dsieger 93: </dl></dd>
1.154 rillig 94: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 95: <dd><dl>
1.154 rillig 96: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
97: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
98: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 99: </dl></dd>
100: </dl></dd>
1.154 rillig 101: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 102: <dd><dl>
1.154 rillig 103: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
104: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
105: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
106: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 107: <dd><dl>
1.154 rillig 108: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
109: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
110: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 111: </dl></dd>
1.154 rillig 112: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
113: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 114: </dl></dd>
1.154 rillig 115: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 116: <dd><dl>
1.154 rillig 117: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
118: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 119: </dl></dd>
1.154 rillig 120: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 121: builds)</a></span></dt>
1.1 dsieger 122: <dd><dl>
1.154 rillig 123: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 ! rillig 124: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 125: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
126: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 127: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
128: <dd><dl>
1.179 rillig 129: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
130: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
131: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.3. Use custom directories</a></span></dt>
132: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.4. Turn warnings into errors</a></span></dt>
133: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.5. Reject packages for which pkglint reports errors</a></span></dt>
134: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.6. Reject packages that contain forbidden strings</a></span></dt>
135: <dt><span class="sect2"><a href="#bulk.var.test">8.4.7. Reject packages whose self-test fails</a></span></dt>
136: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.8. Reject packages that use undefined shell variables</a></span></dt>
137: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.9. Turn off verbose logging</a></span></dt>
1.178 rillig 138: </dl></dd>
139: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
140: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 141: </dl></dd>
142: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
143: <dd><dl>
144: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
145: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
146: </dl></dd>
147: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
148: <dd><dl>
149: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
150: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
151: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
152: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
153: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
154: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
155: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
156: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
157: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
158: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 159: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 160: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
161: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
162: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
163: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
164: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
165: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
166: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 167: </dl></dd>
168: </dl></dd>
169: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
170: <dd><dl>
1.154 rillig 171: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
172: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 173: <dd><dl>
1.154 rillig 174: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 175: <dd><dl>
1.154 rillig 176: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
177: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160 brook 178: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
179: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 180: </dl></dd>
1.154 rillig 181: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
182: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 183: </dl></dd>
1.154 rillig 184: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.6 rillig 185: <dd><dl>
1.154 rillig 186: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
187: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
188: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 189: <dd><dl>
1.154 rillig 190: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
191: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
192: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
193: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
194: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.6 rillig 195: </dl></dd>
1.154 rillig 196: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
197: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.6 rillig 198: <dd><dl>
1.154 rillig 199: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
200: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
201: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.6 rillig 202: </dl></dd>
1.154 rillig 203: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
204: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 205: </dl></dd>
1.154 rillig 206: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 207: <dd><dl>
1.154 rillig 208: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
209: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
210: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
211: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.6 rillig 212: <dd><dl>
1.154 rillig 213: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
214: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
215: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
216: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 217: </dl></dd>
218: </dl></dd>
1.154 rillig 219: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.6 rillig 220: <dd><dl>
1.154 rillig 221: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
222: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
223: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
224: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
225: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
226: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
227: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
228: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
229: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.6 rillig 230: </dl></dd>
1.154 rillig 231: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.6 rillig 232: <dd><dl>
1.154 rillig 233: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
234: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 235: <dd><dl>
1.154 rillig 236: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
237: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26 wiz 238: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
239: and
240: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
241: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 242: </dl></dd>
1.154 rillig 243: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 244: <dd><dl>
1.154 rillig 245: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
246: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.6 rillig 247: </dl></dd>
248: </dl></dd>
1.154 rillig 249: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.6 rillig 250: <dd><dl>
1.154 rillig 251: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
252: <dd><dl>
253: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
254: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
255: </dl></dd>
256: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
257: <dd><dl>
258: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
259: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
260: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
261: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
262: </dl></dd>
263: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
264: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
265: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
266: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
267: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
268: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
269: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
270: </dl></dd>
271: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
272: <dd><dl>
273: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
274: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
275: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
276: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
277: </dl></dd>
278: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
279: <dd><dl>
280: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
281: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
282: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
283: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
284: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
285: <dd><dl>
286: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
287: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
288: </dl></dd>
289: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
299: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
300: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
301: </dl></dd>
302: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
303: <dd><dl>
304: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
305: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
306: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
307: </dl></dd>
308: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
309: <dd><dl>
310: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
311: <dd><dl>
312: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
313: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
314: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
315: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
316: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
317: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
318: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
319: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
320: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
321: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
322: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
323: </dl></dd>
324: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
325: <dd><dl>
326: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
327: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
328: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
329: </dl></dd>
330: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
331: <dd><dl>
332: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
333: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
334: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
335: </dl></dd>
336: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
337: <dd><dl>
338: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
339: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
340: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
341: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
342: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
343: </dl></dd>
344: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
345: <dd><dl>
346: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
347: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 348: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
349: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
350: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 351: </dl></dd>
352: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
353: <dd><dl>
354: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
355: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
356: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
357: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
358: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
359: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
360: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
361: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
362: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
363: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
364: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
365: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
366: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
367: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
368: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
369: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
370: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
371: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 372: emulation</a></span></dt>
1.154 rillig 373: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
374: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 375: </dl></dd>
1.154 rillig 376: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 377: </dl></dd>
1.154 rillig 378: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
379: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 380: <dd><dl>
1.154 rillig 381: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
382: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
383: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
384: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
385: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
386: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
387: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
388: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
389: </dl></dd>
390: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
391: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
392: <dd><dl>
393: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
394: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
395: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
396: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 397: </dl></dd>
398: </dl></dd>
399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
400: <dd><dl>
1.154 rillig 401: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 402: <dd><dl>
1.154 rillig 403: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 406: <dd><dl>
1.154 rillig 407: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
408: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 409: </dl></dd>
1.154 rillig 410: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
411: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 412: <dd><dl>
1.154 rillig 413: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
414: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 415: </dl></dd>
1.154 rillig 416: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 417: <dd><dl>
1.154 rillig 418: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
419: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 420: </dl></dd>
421: </dl></dd>
1.154 rillig 422: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 423: <dd><dl>
1.154 rillig 424: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
425: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 426: <dd><dl>
1.154 rillig 427: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
428: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 429: </dl></dd>
430: </dl></dd>
1.154 rillig 431: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
432: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 433: </dl></dd>
434: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
435: <dd><dl>
436: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
437: <dd><dl>
438: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
439: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
440: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 441: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 442: </dl></dd>
443: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
444: </dl></dd>
445: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
446: <dd><dl>
447: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
448: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
449: </dl></dd>
450: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
451: <dd><dl>
1.23 wiz 452: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
453: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
454: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
455: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
456: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 457: <code class="filename">stable</code>,
1.23 wiz 458: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 459: source packages</a></span></dt>
460: </dl></dd>
1.154 rillig 461: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
462: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 463: <dd><dl>
1.154 rillig 464: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
465: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 466: </dl></dd>
467: </dl>
468: </div>
469: <div class="list-of-tables">
470: <p><b>List of Tables</b></p>
471: <dl>
472: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
473: </dt>
1.154 rillig 474: <dt>13.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 475: </dt>
1.154 rillig 476: <dt>25.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 477: </dt>
478: </dl>
479: </div>
1.41 asau 480: <div class="chapter">
481: <div class="titlepage"><div><div><h1 class="title">
482: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 483: <div class="toc">
484: <p><b>Table of Contents</b></p>
1.100 leot 485: <dl class="toc">
1.1 dsieger 486: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
487: <dd><dl>
488: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
489: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
490: </dl></dd>
491: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
492: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
493: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
494: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
495: </dl>
496: </div>
1.41 asau 497: <div class="sect1">
1.1 dsieger 498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
499: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
500: <p>There is a lot of software freely available for Unix-based
501: systems, which is usually available in form of the source code. Before
502: such software can be used, it needs to be configured to the local
503: system, compiled and installed, and this is exactly what The NetBSD
504: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
505: to handle binary packages, so that not every user has to build the
506: packages for himself, which is a time-costly task.</p>
507: <p>pkgsrc currently contains several thousand packages,
508: including:</p>
1.41 asau 509: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 510: <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.1 dsieger 511: web server</p></li>
1.137 leot 512: <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.1 dsieger 513: web browser</p></li>
1.137 leot 514: <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.1 dsieger 515: Desktop Environment</p></li>
1.137 leot 516: <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.1 dsieger 517: Desktop Environment</p></li>
518: </ul></div>
1.108 rillig 519: <p>… just to name a few.</p>
1.1 dsieger 520: <p>pkgsrc has built-in support for handling varying dependencies,
521: such as pthreads and X11, and extended features such as IPv6 support on
522: a range of platforms.</p>
1.41 asau 523: <div class="sect2">
1.1 dsieger 524: <div class="titlepage"><div><div><h3 class="title">
525: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
526: <p>
527: pkgsrc provides the following key features:
528: </p>
1.41 asau 529: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 530: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 531: and installation of binary packages. The source and latest
532: patches are retrieved from a master or mirror download site, checksum
533: verified, then built on your system. Support for binary-only
534: distributions is available for both native platforms and NetBSD
535: emulated platforms.</p></li>
1.23 wiz 536: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 537: including binaries, libraries, man pages and other
538: documentation.</p></li>
1.104 sevan 539: <li class="listitem"><p>Tracking of package dependencies automatically, including when
540: performing updates, to ensure required packages are installed. The
541: configuration files of various packages are handled automatically during
542: updates, so local changes are preserved.</p></li>
1.23 wiz 543: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 544: consists of highly portable code. This allows the greatest speed of
1.25 spz 545: development when porting to a new platform. This portability also
1.1 dsieger 546: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
547: platforms</em></span>.</p></li>
1.23 wiz 548: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 549: international encryption requirements and build-time options for a
550: large number of packages are all set in a simple, central
551: configuration file.</p></li>
1.23 wiz 552: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 553: freely available under a BSD license, so you may extend and adapt
554: pkgsrc to your needs. Support for local packages and patches is
555: available right out of the box, so you can configure it specifically
556: for your environment.</p></li>
557: </ul></div>
558: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 560: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 561: — That means, if a package contains bugs, it's better to find
1.1 dsieger 562: them and to complain about them rather than to just install the package
563: and hope that it works. There are numerous checks in pkgsrc that try to
1.175 gutterid 564: 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.1 dsieger 565: of shell scripts), and post-installation checks (installed files,
566: references to shared libraries, script interpreters).</p></li>
1.23 wiz 567: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 568: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 569: pkgsrc has been ported to many operating systems. Care is taken that
570: packages behave the same on all platforms.</p></li>
571: </ul></div>
572: </div>
1.41 asau 573: <div class="sect2">
1.1 dsieger 574: <div class="titlepage"><div><div><h3 class="title">
575: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
576: <p>pkgsrc consists of both a source distribution and a binary
577: distribution for these operating systems. After retrieving the required
578: source or binaries, you can be up and running with pkgsrc in just
579: minutes!</p>
580: <p>pkgsrc was derived from FreeBSD's ports system, and
581: initially developed for NetBSD only. Since then, pkgsrc has
582: grown a lot, and now supports the following platforms:</p>
583: <div class="table">
584: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 585: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 586: <colgroup>
587: <col>
588: <col>
1.92 sevan 589: <col>
1.1 dsieger 590: </colgroup>
591: <thead><tr>
592: <th>Platform</th>
593: <th>Date Support Added</th>
1.92 sevan 594: <th>Notes</th>
1.1 dsieger 595: </tr></thead>
596: <tbody>
597: <tr>
1.174 leot 598: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 599: <td align="center">Aug 1997</td>
1.92 sevan 600: <td class="auto-generated"> </td>
1.1 dsieger 601: </tr>
602: <tr>
1.10 hubertf 603: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 604: <td align="center">Mar 1999</td>
1.151 sevan 605: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1 dsieger 606: </tr>
607: <tr>
1.174 leot 608: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 609: <td align="center">Jun 1999</td>
1.151 sevan 610: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1 dsieger 611: </tr>
612: <tr>
613: <td>
1.118 sevan 614: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 615: </td>
616: <td align="center">Oct 2001</td>
1.151 sevan 617: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.1 dsieger 618: </tr>
619: <tr>
1.174 leot 620: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 621: <td align="center">Nov 2002</td>
1.151 sevan 622: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1 dsieger 623: </tr>
624: <tr>
1.174 leot 625: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 626: <td align="center">Nov 2002</td>
1.151 sevan 627: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1 dsieger 628: </tr>
629: <tr>
1.174 leot 630: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 631: <td align="center">Dec 2002</td>
1.92 sevan 632: <td>
1.151 sevan 633: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
634: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92 sevan 635: </td>
1.1 dsieger 636: </tr>
637: <tr>
638: <td>BSD/OS</td>
639: <td align="center">Dec 2003</td>
1.92 sevan 640: <td class="auto-generated"> </td>
1.1 dsieger 641: </tr>
642: <tr>
1.174 leot 643: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 644: <td align="center">Dec 2003</td>
1.151 sevan 645: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1 dsieger 646: </tr>
647: <tr>
648: <td>
1.174 leot 649: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 650: (Microsoft Windows Services for Unix)
651: </td>
652: <td align="center">Mar 2004</td>
1.151 sevan 653: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1 dsieger 654: </tr>
655: <tr>
1.174 leot 656: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 657: <td align="center">Oct 2004</td>
1.92 sevan 658: <td class="auto-generated"> </td>
1.1 dsieger 659: </tr>
660: <tr>
1.10 hubertf 661: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 662: <td align="center">Nov 2004</td>
1.151 sevan 663: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1 dsieger 664: </tr>
665: <tr>
1.174 leot 666: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 667: <td align="center">Apr 2007</td>
1.151 sevan 668: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1 dsieger 669: </tr>
1.23 wiz 670: <tr>
1.174 leot 671: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23 wiz 672: <td align="center">Sep 2010</td>
1.151 sevan 673: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23 wiz 674: </tr>
1.45 obache 675: <tr>
1.174 leot 676: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 677: <td align="center">Jan 2011</td>
1.92 sevan 678: <td class="auto-generated"> </td>
1.45 obache 679: </tr>
680: <tr>
1.174 leot 681: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45 obache 682: <td align="center">Nov 2011</td>
1.151 sevan 683: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45 obache 684: </tr>
685: <tr>
1.174 leot 686: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45 obache 687: <td align="center">Mar 2013</td>
1.151 sevan 688: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45 obache 689: </tr>
1.58 ryoon 690: <tr>
1.174 leot 691: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58 ryoon 692: <td align="center">Jul 2013</td>
1.151 sevan 693: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58 ryoon 694: </tr>
1.104 sevan 695: <tr>
1.174 leot 696: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104 sevan 697: <td align="center">Jun 2014</td>
1.151 sevan 698: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.104 sevan 699: </tr>
1.1 dsieger 700: </tbody>
701: </table></div>
702: </div>
703: <br class="table-break">
704: </div>
705: </div>
1.41 asau 706: <div class="sect1">
1.1 dsieger 707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
708: <a name="overview"></a>1.2. Overview</h2></div></div></div>
709: <p>This document is divided into three parts. The first,
1.10 hubertf 710: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 711: describes how one can use one of the packages in the Package
712: Collection, either by installing a precompiled binary package,
713: or by building one's own copy using the NetBSD package system.
1.10 hubertf 714: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1 dsieger 715: package so it can be easily built by other NetBSD users without
716: knowing about the package's building details. The third part,
1.10 hubertf 717: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 718: is intended for those who want to understand how pkgsrc is
719: implemented.</p>
720: <p>This document is available in various formats:
1.10 hubertf 721: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1 dsieger 722: </div>
1.41 asau 723: <div class="sect1">
1.1 dsieger 724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
725: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 726: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
727: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 728: terminology used within this document.</p>
1.41 asau 729: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 730: <dt><span class="term">Package</span></dt>
731: <dd><p>A set of files and building instructions
732: that describe what's necessary
733: to build a certain piece of software using
734: pkgsrc. Packages are traditionally stored under
1.123 wiz 735: <code class="filename">/usr/pkgsrc</code>,
736: but may be stored in any location,
737: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 738: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 739: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 740: is part of the NetBSD operating system and can be bootstrapped
741: to run on non-NetBSD operating systems as well. It handles
742: building (compiling), installing, and removing of
743: packages.</p></dd>
744: <dt><span class="term">Distfile</span></dt>
745: <dd><p>This term describes the file or files that are
746: provided by the author of the piece of software to
747: distribute his work. All the changes necessary to build on
748: NetBSD are reflected in the corresponding package. Usually
749: the distfile is in the form of a compressed tar-archive,
750: but other types are possible, too. Distfiles are usually
751: stored below
752: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
753: <dt><span class="term">Port</span></dt>
754: <dd><p>This is the term used by FreeBSD and OpenBSD people
755: for what we call a package.
1.23 wiz 756: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 757: architecture.</p></dd>
758: <dt><span class="term">Precompiled/binary package</span></dt>
759: <dd>
760: <p>A set of binaries built with pkgsrc from a distfile
761: and stuffed together in a single <code class="filename">.tgz</code>
762: file so it can be installed on machines of the same
763: machine architecture without the need to
764: recompile. Packages are usually generated in
765: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 766: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 767: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 768: especially in the context of precompiled packages.</p>
769: </dd>
770: <dt><span class="term">Program</span></dt>
771: <dd><p>The piece of software to be installed which will be
772: constructed from all the files in the distfile by the
773: actions defined in the corresponding package.</p></dd>
774: </dl></div>
1.41 asau 775: <div class="sect2">
1.1 dsieger 776: <div class="titlepage"><div><div><h3 class="title">
777: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 778: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 779: <dt><span class="term">pkgsrc users</span></dt>
780: <dd>
781: <p>The
782: pkgsrc users are people who use the packages provided by pkgsrc.
783: Typically they are system administrators. The people using the
1.23 wiz 784: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
785: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 786: <p>There are two kinds of pkgsrc users: Some only want to
787: install pre-built binary packages. Others build the pkgsrc
788: packages from source, either for installing them directly or for
1.10 hubertf 789: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.1 dsieger 790: documentation.</p>
791: </dd>
792: <dt><span class="term">package maintainers</span></dt>
793: <dd><p>A
1.10 hubertf 794: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.1 dsieger 795: <dt><span class="term">infrastructure developers</span></dt>
796: <dd><p>These people are involved in all those files
797: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 798: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.1 dsieger 799: too.</p></dd>
800: </dl></div>
801: </div>
802: </div>
1.41 asau 803: <div class="sect1">
1.1 dsieger 804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
805: <a name="typography"></a>1.4. Typography</h2></div></div></div>
806: <p>When giving examples for commands, shell prompts are used to
807: show if the command should/can be issued as root, or if
1.23 wiz 808: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 809: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
810: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
811: bourne shell and derivatives.</p>
1.1 dsieger 812: </div>
813: </div>
1.41 asau 814: <div class="part">
1.1 dsieger 815: <div class="titlepage"><div><div><h1 class="title">
816: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
817: <div class="toc">
818: <p><b>Table of Contents</b></p>
1.100 leot 819: <dl class="toc">
1.154 rillig 820: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
821: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1 dsieger 822: <dd><dl>
1.154 rillig 823: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 824: <dd><dl>
1.154 rillig 825: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
826: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 827: </dl></dd>
1.154 rillig 828: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 829: <dd><dl>
1.154 rillig 830: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
831: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 832: </dl></dd>
833: </dl></dd>
1.154 rillig 834: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 835: <dd><dl>
1.154 rillig 836: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
837: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 838: </dl></dd>
1.154 rillig 839: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 840: <dd><dl>
1.154 rillig 841: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 842: <dd><dl>
1.154 rillig 843: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
844: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
845: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
846: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
847: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
848: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
849: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.1 dsieger 850: </dl></dd>
1.154 rillig 851: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 852: <dd><dl>
1.154 rillig 853: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
854: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
855: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 856: </dl></dd>
857: </dl></dd>
1.154 rillig 858: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 859: <dd><dl>
1.154 rillig 860: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
861: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
862: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
863: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 864: <dd><dl>
1.154 rillig 865: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
866: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
867: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 868: </dl></dd>
1.154 rillig 869: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
870: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 871: </dl></dd>
1.154 rillig 872: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 873: <dd><dl>
1.154 rillig 874: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
875: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 876: </dl></dd>
1.154 rillig 877: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 878: builds)</a></span></dt>
1.1 dsieger 879: <dd><dl>
1.154 rillig 880: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 ! rillig 881: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 882: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
883: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 884: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
885: <dd><dl>
1.179 rillig 886: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
887: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
888: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.3. Use custom directories</a></span></dt>
889: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.4. Turn warnings into errors</a></span></dt>
890: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.5. Reject packages for which pkglint reports errors</a></span></dt>
891: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.6. Reject packages that contain forbidden strings</a></span></dt>
892: <dt><span class="sect2"><a href="#bulk.var.test">8.4.7. Reject packages whose self-test fails</a></span></dt>
893: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.8. Reject packages that use undefined shell variables</a></span></dt>
894: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.9. Turn off verbose logging</a></span></dt>
1.178 rillig 895: </dl></dd>
896: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
897: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 898: </dl></dd>
899: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
900: <dd><dl>
901: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
902: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
903: </dl></dd>
904: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
905: <dd><dl>
906: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
907: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
908: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
909: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
910: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
911: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
912: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
913: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
914: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
915: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 916: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 917: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
918: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
919: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
920: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
921: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
922: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
923: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 924: </dl></dd>
925: </dl>
926: </div>
1.41 asau 927: <div class="chapter">
1.1 dsieger 928: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 929: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
930: <p>
931: To get help when using pkgsrc, the definitive source is this
932: document, the pkgsrc guide. If you don't find anything here,
933: there are alternatives:
934: </p>
935: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
936: <li class="listitem">
937: <p>
938: The built-in pkgsrc help, which is available after bootstrapping
939: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
940: help for any topic, such as a variable name like
941: <code class="varname">BUILD_DEFS</code>, a make target like
942: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
943: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
944: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix D. Help topics">Appendix D, <i>Help topics</i></a>.</p>
945: </li>
946: <li class="listitem"><p>
1.163 rillig 947: To see the value of a single variable, run <span class="command"><strong>bmake
948: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
949: </p></li>
950: <li class="listitem"><p>
951: To see the values of the most common variables, run
952: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
953: topic. To see the variables for a single topic, run
954: <span class="command"><strong>bmake
955: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
956: <span class="command"><strong>bmake show-all-fetch</strong></span>.
957: </p></li>
958: <li class="listitem"><p>
1.154 rillig 959: The pkgsrc-users mailing list, to which
960: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
961: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
962: questions</a>.</p></li>
963: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
964: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
965: or by using a specialized chat program such as
966: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
967: Pick any user name and join the channel #pkgsrc.</p></li>
968: </ul></div>
969: </div>
970: <div class="chapter">
971: <div class="titlepage"><div><div><h2 class="title">
972: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.1 dsieger 973: <div class="toc">
974: <p><b>Table of Contents</b></p>
1.100 leot 975: <dl class="toc">
1.154 rillig 976: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 977: <dd><dl>
1.154 rillig 978: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
979: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 980: </dl></dd>
1.154 rillig 981: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 982: <dd><dl>
1.154 rillig 983: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
984: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 985: </dl></dd>
986: </dl>
987: </div>
988: <p>Before you download and extract the files, you need to decide
989: where you want to extract them. When using pkgsrc as root user, pkgsrc
990: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
991: free to install the sources and binary packages wherever you want in
992: your filesystem, provided that the pathname does not contain white-space
993: or other characters that are interpreted specially by the shell and some
994: other programs. A safe bet is to use only letters, digits, underscores
995: and dashes.</p>
1.41 asau 996: <div class="sect1">
1.1 dsieger 997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 998: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 999: <p>Before you download any pkgsrc files, you should decide
1000: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1001: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1002: quarterly basis from the current branch and only gets modified
1003: for security updates. The names of the stable branches are built
1004: from the year and the quarter, for example
1.174 leot 1005: <code class="literal">2020Q1</code>.</p>
1.1 dsieger 1006: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 1007: want to download pkgsrc. You can get it as a tar file or via CVS.
1008: Both ways are described here.</p>
1.51 asau 1009: <p>Note that tar archive contains CVS working copy.
1010: Thus you can switch to using CVS at any later time.</p>
1.41 asau 1011: <div class="sect2">
1.1 dsieger 1012: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1013: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 1014: <p>The primary download location for all pkgsrc files is
1.151 sevan 1015: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 1016: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1017: (it points to the same location).
1018: There are a number of subdirectories for different purposes,
1019: 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>
1020: <p>The tar archive for the current branch is in the directory
1.151 sevan 1021: <code class="filename">current</code> and is called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.118 sevan 1022: It is autogenerated weekly.</p>
1.51 asau 1023: <p>To save download time we provide bzip2- and
1024: xz-compressed archives which are published at
1.151 sevan 1025: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
1.51 asau 1026: and
1.151 sevan 1027: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
1.51 asau 1028: respectively.
1029: </p>
1030: <p>You can fetch the same files using FTP.</p>
1.174 leot 1031: <p>The tar file for the stable branch 2020Q1 is in the
1032: directory <code class="filename">pkgsrc-2020Q1</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136 leot 1033: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1034: <pre class="screen">
1.174 leot 1035: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q1/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 1036: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1037: or your web browser.</p>
1.12 weinem 1038: <p>Then, extract it with:</p>
1.78 snj 1039: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1040: <p>This will create the directory <code class="filename">pkgsrc/</code>
1041: in <code class="filename">/usr/</code> and all the package source will be
1042: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1043: <p>To download pkgsrc-current, run:</p>
1044: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1 dsieger 1045: </div>
1.41 asau 1046: <div class="sect2">
1.1 dsieger 1047: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1048: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1049: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.174 leot 1050: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2020Q1 -P pkgsrc</code></strong>
1.23 wiz 1051: </pre>
1052: <p>This will create the directory <code class="filename">pkgsrc/</code>
1053: in your <code class="filename">/usr/</code> directory and all the package source
1054: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1055: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1056: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1057: </pre>
1.174 leot 1058: <p>Refer to the <a class="ulink" href="https://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 1059: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 1060: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23 wiz 1061: </pre>
1062: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1063: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1064: or better globally in <code class="filename">/etc/profile</code>:</p>
1065: <pre class="programlisting">
1066: # set CVS remote shell command
1067: CVS_RSH=ssh
1068: export CVS_RSH
1069: </pre>
1070: <p>By default, CVS doesn't do things like most people would expect it to do.
1071: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1072: in your home directory and saving the following lines to it.
1073: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1074: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1075: <pre class="programlisting">
1076: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1077: cvs -q
1.2 rillig 1078: checkout -P
1.4 rillig 1079: update -dP
1080: diff -upN
1.2 rillig 1081: rdiff -u
1.23 wiz 1082: release -d
1.2 rillig 1083: </pre>
1.1 dsieger 1084: </div>
1085: </div>
1.41 asau 1086: <div class="sect1">
1.1 dsieger 1087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1088: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1089: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1090: (which also works if you have first installed it via a tar
1091: file). It saves bandwidth and hard disk activity, compared to
1092: downloading the tar file again.</p>
1.41 asau 1093: <div class="sect2">
1.1 dsieger 1094: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1095: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1096: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1097: <h3 class="title">Warning</h3>
1098: <p>When updating from a tar file, you first need to
1099: completely remove the old pkgsrc directory. Otherwise those
1100: files that have been removed from pkgsrc in the mean time will
1101: not be removed on your local disk, resulting in inconsistencies.
1102: When removing the old files, any changes that you have done to
1103: the pkgsrc files will be lost after updating. Therefore updating
1104: via CVS is strongly recommended.</p>
1105: </div>
1106: <p>Note that by default the distfiles and the binary packages
1107: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1108: before updating. You can also configure pkgsrc to store distfiles
1109: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1110: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1111: variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1112: <p>To update pkgsrc from a tar file, download the tar file as
1113: explained above. Then, make sure that you have not made any
1114: changes to the files in the pkgsrc directory. Remove the pkgsrc
1115: directory and extract the new tar file. Done.</p>
1116: </div>
1.41 asau 1117: <div class="sect2">
1.1 dsieger 1118: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1119: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1120: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1121: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1122: </pre>
1123: <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>
1124: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1125: </pre>
1.41 asau 1126: <div class="sect3">
1.1 dsieger 1127: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1128: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1129: <p>When updating pkgsrc, the CVS program keeps track of the
1130: branch you selected. But if you, for whatever reason, want to
1131: switch from the stable branch to the current one, you can do it
1.23 wiz 1132: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1133: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1134: back to the stable branch, add the
1.174 leot 1135: <span class="quote">“<span class="quote">-rpkgsrc-2020Q1</span>”</span> option.</p>
1.1 dsieger 1136: </div>
1.41 asau 1137: <div class="sect3">
1.1 dsieger 1138: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1139: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1140: <p>When you update pkgsrc, the CVS program will only touch
1141: those files that are registered in the CVS repository. That
1142: means that any packages that you created on your own will stay
1143: unmodified. If you change files that are managed by CVS, later
1144: updates will try to merge your changes with those that have been
1145: done by others. See the CVS manual, chapter
1.23 wiz 1146: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1147: </div>
1148: </div>
1149: </div>
1150: </div>
1.41 asau 1151: <div class="chapter">
1.1 dsieger 1152: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1153: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1154: <div class="toc">
1155: <p><b>Table of Contents</b></p>
1.100 leot 1156: <dl class="toc">
1.154 rillig 1157: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1158: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1159: </dl>
1160: </div>
1.41 asau 1161: <div class="sect1">
1.1 dsieger 1162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1163: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1164: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, “Using binary packages”</a>.</p>
1.1 dsieger 1165: </div>
1.41 asau 1166: <div class="sect1">
1.1 dsieger 1167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1168: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1169: <p>pkgsrc can be bootstrapped for use in two different modes:
1170: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1171: to privileged one all programs are installed under one particular user
1.43 asau 1172: and cannot utilise privileged operations (packages don't create
1173: special users and all special file permissions like setuid are ignored).
1174: </p>
1.1 dsieger 1175: <p>Installing the bootstrap kit from source should be as simple as:</p>
1176: <pre class="screen">
1.60 asau 1177: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1178: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1179: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1180: </pre>
1.43 asau 1181: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1182: <p>By default, in privileged mode pkgsrc uses
1183: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1184: where programs will be installed in,
1.118 sevan 1185: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1186: directory where pkgsrc will do its internal bookkeeping,
1187: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1188: where packages install their persistent data.
1189: In unprivileged mode pkgsrc uses
1190: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1191: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1192: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1193: </p>
1194: <p>You can change default layout using command-line arguments.
1195: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1196: </p>
1.41 asau 1197: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1198: <h3 class="title">Note</h3>
1.10 hubertf 1199: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1200: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1201: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1202: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1203: </div>
1.43 asau 1204: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1205: <h3 class="title">Note</h3>
1206: <p>It is possible to bootstrap multiple instances of pkgsrc
1207: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1208: corresponding to the installation you're working with to build
1209: and install packages.
1210: </p>
1211: </div>
1.1 dsieger 1212: </div>
1213: </div>
1.41 asau 1214: <div class="chapter">
1.1 dsieger 1215: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1216: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1217: <div class="toc">
1218: <p><b>Table of Contents</b></p>
1.100 leot 1219: <dl class="toc">
1.154 rillig 1220: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1221: <dd><dl>
1.154 rillig 1222: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1223: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1224: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
1225: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
1226: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1227: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1228: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1229: </dl></dd>
1230: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1231: <dd><dl>
1232: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1233: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1234: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1 dsieger 1235: </dl></dd>
1236: </dl>
1237: </div>
1238: <p>Basically, there are two ways of using pkgsrc. The first
1239: is to only install the package tools and to use binary packages
1.23 wiz 1240: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1241: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1242: of pkgsrc, too. Then you are able to build your own packages,
1243: and you can still use binary packages from someone else.</p>
1.41 asau 1244: <div class="sect1">
1.1 dsieger 1245: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1246: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.179 rillig 1247: <p>On the <a class="ulink" href="http://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151 sevan 1248: site and mirrors, there are collections of binary packages,
1.9 rillig 1249: ready to be installed. These binary packages have been built using the
1250: default settings for the directories, that is:</p>
1.41 asau 1251: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1252: <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>
1253: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1254: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9 rillig 1255: </ul></div>
1256: <p>If you cannot use these directories for whatever reasons (maybe
1257: because you're not root), you cannot use these binary packages, but
1.154 rillig 1258: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, “Bootstrapping pkgsrc”</a>.</p>
1.41 asau 1259: <div class="sect2">
1.1 dsieger 1260: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1261: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1262: <p>To install binary packages, you first need to know from where
1263: to get them. The first place where you should look is on the main
1.179 rillig 1264:
1265: pkgsrc FTP server in the directory <a class="ulink" href="http://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1266: <p>This directory contains binary packages for multiple
1267: platforms. First, select your operating system. (Ignore the
1268: directories with version numbers attached to it, they just exist for
1269: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1270: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1271: <p>In this directory, you often find a file called
1272: <code class="filename">bootstrap.tar.gz</code> which contains the package
1273: management tools. If the file is missing, it is likely that your
1274: operating system already provides those tools. Download the file and
1275: extract it in the <code class="filename">/</code> directory. It will create
1276: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1277: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1278: </div>
1.41 asau 1279: <div class="sect2">
1.1 dsieger 1280: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1281: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1282: <p>In the directory from the last section, there is a
1.85 wiz 1283: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1284: binary packages that are available for the platform, excluding those
1285: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1286: medium you are using).</p>
1.9 rillig 1287: <p>To install packages directly from an FTP or HTTP server, run
1288: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1289: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1290: <pre class="screen">
1291: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.179 rillig 1292:
1293: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169 rillig 1294: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="$PKG_PATH/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.9 rillig 1295: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1296: </pre>
1297: <p>Instead of URLs, you can also use local paths, for example if
1298: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1299: repository. If you want to install packages from multiple sources,
1300: you can separate them by a semicolon in
1301: <code class="varname">PKG_PATH</code>.</p>
1302: <p>After these preparations, installing a package is very
1303: easy:</p>
1304: <pre class="screen">
1.118 sevan 1305: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1306: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.9 rillig 1307: </pre>
1.1 dsieger 1308: <p>Note that any prerequisite packages needed to run the
1309: package in question will be installed, too, assuming they are
1310: present where you install from.</p>
1.23 wiz 1311: <p>Adding packages might install vulnerable packages.
1312: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1313: regularly, especially after installing new packages, and verify
1314: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1315: <p>After you've installed packages, be sure to have
1316: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1317: <code class="varname">PATH</code> so you can actually start the just
1318: installed program.</p>
1319: </div>
1.41 asau 1320: <div class="sect2">
1.1 dsieger 1321: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1322: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1323: <p>To deinstall a package, it does not matter whether it was
1324: installed from source code or from a binary package. The
1.10 hubertf 1325: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1326: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1327: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1328: name can be given with or without version number. Wildcards can
1329: also be used to deinstall a set of packages, for example
1330: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1331: so that the shell does not expand them before
1332: <code class="literal">pkg_delete</code> sees them.</p>
1333: <p>The <code class="option">-r</code> option is very powerful: it
1334: removes all the packages that require the package in question
1335: and then removes the package itself. For example:
1336:
1337: </p>
1338: <pre class="screen">
1339: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1340: </pre>
1341: <p>
1342:
1343: will remove jpeg and all the packages that used it; this allows
1344: upgrading the jpeg package.</p>
1345: </div>
1.41 asau 1346: <div class="sect2">
1.1 dsieger 1347: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1348: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1349: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1350: installed packages or binary package files.</p>
1351: </div>
1.41 asau 1352: <div class="sect2">
1.1 dsieger 1353: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1354: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1355: <p>
1.164 leot 1356: The pkgsrc Security Team and Packages Groups maintain a list of
1.1 dsieger 1357: known security vulnerabilities to packages which are (or have been)
1358: included in pkgsrc. The list is available from the NetBSD
1.179 rillig 1359:
1360: FTP site at <a class="ulink" href="http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1.1 dsieger 1361: </p>
1362: <p>
1.22 jakllsch 1363: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1364: this list can be downloaded
1365: automatically, and a security audit of all packages installed on a system
1366: can take place.
1367: </p>
1368: <p>
1.22 jakllsch 1369: There are two components to auditing. The first
1370: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1371: is for downloading
1.1 dsieger 1372: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1373: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1374: installed packages are vulnerable. If a package is vulnerable, you
1375: will see output similar to the following:
1376: </p>
1377: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1378: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1 dsieger 1379: <p>
1.22 jakllsch 1380: You may wish to have the
1.179 rillig 1381:
1382: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1383: file downloaded daily so that
1384: it remains current. This may be done by adding an appropriate entry
1.174 leot 1385: to the root users <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1386: </p>
1387: <pre class="screen">
1.121 sevan 1388: # Download vulnerabilities file
1.118 sevan 1389: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1390: # Audit the installed packages and email results to root
1391: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1392: root >/dev/null 2>&1
1.22 jakllsch 1393: </pre>
1394: <p>
1.118 sevan 1395: will update the vulnerability list every day at 3AM, followed by an audit
1396: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1397:
1.118 sevan 1398: On NetBSD this may be accomplished instead by adding the following
1399: line to <code class="filename">/etc/daily.conf</code>:
1400: </p>
1401: <pre class="screen">
1402: fetch_pkg_vulnerabilities=YES
1403: </pre>
1404: <p>
1405: to fetch the vulnerability list from the daily security script. The system
1406: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1407: desired (not required), by adding the following line to
1.118 sevan 1408: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1409: </p>
1410: <pre class="screen">
1.118 sevan 1411: check_pkg_vulnerabilities=YES
1.22 jakllsch 1412: </pre>
1413: <p>
1.174 leot 1414: see <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1 dsieger 1415: </p>
1416: </div>
1.41 asau 1417: <div class="sect2">
1.1 dsieger 1418: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1419: <a name="pkg_versions"></a>5.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.1 dsieger 1420: <p>
1.137 leot 1421: 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.23 wiz 1422: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1423: argument to check if your packages are up-to-date, e.g.
1424: </p>
1425: <pre class="screen">
1426: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1427: ...
1428: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1429: </pre>
1.10 hubertf 1430: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1431: package on your system and rebuild any dependencies.
1432: </p>
1433: </div>
1.41 asau 1434: <div class="sect2">
1.1 dsieger 1435: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1436: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1437: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1438: administrative functions on the package system.</p>
1439: </div>
1440: </div>
1.41 asau 1441: <div class="sect1">
1.1 dsieger 1442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1443: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1444: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1445: directory now contains a set of packages, organized into
1446: categories. You can browse the online index of packages, or run
1.10 hubertf 1447: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1448: directory to build local <code class="filename">README.html</code> files for
1.137 leot 1449: 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.1 dsieger 1450: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1451: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1452: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1453: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1454: different <code class="varname">LOCALBASE</code> definitions on the same
1455: system (inside a chroot is an exception). </p>
1456: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1457: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.1 dsieger 1458: instructions how to create your own packages.</p>
1.41 asau 1459: <div class="sect2">
1.1 dsieger 1460: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1461: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1462: <p>To build packages from source, you need a working C
1463: compiler. On NetBSD, you need to install the
1.23 wiz 1464: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1465: sets. If you want to build X11-related packages, the
1.23 wiz 1466: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1467: sets are required, too.</p>
1468: </div>
1.41 asau 1469: <div class="sect2">
1.1 dsieger 1470: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1471: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1472: <p>The first step for building a package is downloading the
1473: distfiles (i.e. the unmodified source). If they have not yet been
1474: downloaded, pkgsrc will fetch them automatically.</p>
1475: <p>If you have all files that you need in the
1476: <code class="filename">distfiles</code> directory,
1477: you don't need to connect. If the distfiles are on CD-ROM, you can
1478: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1479: </p>
1480: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1481: <p>
1.10 hubertf 1482: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1483: <p>By default a list of distribution sites will be randomly
1484: intermixed to prevent huge load on servers which holding popular
1485: packages (for example, SourceForge.net mirrors). Thus, every
1486: time when you need to fetch yet another distfile all the mirrors
1487: will be tried in new (random) order. You can turn this feature
1488: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1489: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1490: <p>You can overwrite some of the major distribution sites to
1491: fit to sites that are close to your own. By setting one or two
1492: variables you can modify the order in which the master sites are
1493: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1494: delimited list of domain suffixes.
1495: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1496: contains a whitespace delimited list of regular expressions. It
1497: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1498: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1499: some examples. This may save some of your bandwidth and
1500: time.</p>
1501: <p>You can change these settings either in your shell's environment, or,
1502: if you want to keep the settings, by editing the
1.10 hubertf 1503: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1504: and adding the definitions there.</p>
1505: <p>
1506: If a package depends on many other packages (such as
1.137 leot 1507: <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.1 dsieger 1508: alternate between periods of
1509: downloading source, and compiling. To ensure you have all the source
1510: downloaded initially you can run the command:
1511: </p>
1512: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1513: <p>
1514: which will output and run a set of shell commands to fetch the
1515: necessary files into the <code class="filename">distfiles</code> directory. You can
1516: also choose to download the files manually.
1517: </p>
1518: </div>
1.41 asau 1519: <div class="sect2">
1.1 dsieger 1520: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1521: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1522: <p>
1523: Once the software has downloaded, any patches will be applied, then it
1524: will be compiled for you. This may take some time depending on your
1525: computer, and how many other packages the software depends on and their
1526: compile time.
1527: </p>
1.41 asau 1528: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1529: <h3 class="title">Note</h3>
1530: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1531: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1532: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1533: </div>
1534: <p>For example, type</p>
1535: <pre class="screen">
1536: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1537: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1538: </pre>
1539: <p>at the shell prompt to build the various components of the
1540: package.</p>
1541: <p>The next stage is to actually install the newly compiled
1542: program onto your system. Do this by entering:
1543:
1544: </p>
1545: <pre class="screen">
1546: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1547: </pre>
1548: <p>
1549:
1550: while you are still in the directory for whatever package you
1551: are installing.</p>
1552: <p>Installing the package on your system may require you to
1553: be root. However, pkgsrc has a
1554: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1555: to only become root for the actual installation step.</p>
1556: <p>That's it, the software should now be installed and setup for use.
1557: You can now enter:
1558:
1559: </p>
1560: <pre class="screen">
1561: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1562: </pre>
1563: <p>
1564:
1565: to remove the compiled files in the work directory, as you shouldn't need
1566: them any more. If other packages were also added to your system
1567: (dependencies) to allow your program to compile, you can tidy these up
1568: also with the command:</p>
1569: <pre class="screen">
1570: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1571: </pre>
1572: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1573: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1 dsieger 1574: <p>The program is installed under the default root of the
1575: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1576: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1577: variable in your environment, and it will use that value as the
1578: root of your packages tree. So, to use
1579: <code class="filename">/usr/local</code>, set
1580: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1581: Please note that you should use a directory which is dedicated to
1582: packages and not shared with other programs (i.e., do not try and
1583: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1584: to add any of your own files or directories (such as
1585: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1586: <code class="filename">pkgsrc/</code>) below the
1587: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1588: conflicts between programs and other files installed by the
1589: package system and whatever else may have been installed
1590: there.</p>
1.10 hubertf 1591: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1592: alter some configuration options at build time. Have a look at
1593: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1594: of what will be set there by default. Environment variables such
1595: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1596: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1597: set them each time you want to use pkgsrc.</p>
1.23 wiz 1598: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1599: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1600: or being installed. This may be for debugging purposes, or out of
1601: simple curiosity. A number of utility values have been added to
1602: help with this.</p>
1.23 wiz 1603: <div class="orderedlist"><ol class="orderedlist" type="1">
1604: <li class="listitem">
1.174 leot 1605: <p>If you invoke the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1606: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1607: information will be displayed. For example,</p>
1608: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1609: <p>will show all the commands that are invoked, up to and
1.23 wiz 1610: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1611: </li>
1.23 wiz 1612: <li class="listitem">
1.174 leot 1613: <p>If you want to know the value of a certain <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1614: definition, then the <code class="varname">VARNAME</code> definition
1615: should be used, in conjunction with the show-var
1.174 leot 1616: target. e.g. to show the expansion of the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1617: variable <code class="varname">LOCALBASE</code>:</p>
1618: <pre class="screen">
1619: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1620: /usr/pkg
1621: <code class="prompt">%</code>
1622: </pre>
1623: </li>
1624: </ol></div>
1625: <p>If you want to install a binary package that you've either
1626: created yourself (see next section), that you put into
1627: pkgsrc/packages manually or that is located on a remote FTP
1628: server, you can use the "bin-install" target. This target will
1.174 leot 1629: install a binary package - if available - via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 1630: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1631: sites searched is kept in the variable
1632: <code class="varname">BINPKG_SITES</code>, which defaults to
1.174 leot 1633: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 1634: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1635: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1636: details.</p>
1637: <p>A final word of warning: If you set up a system that has a
1638: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1639: set that before any packages are installed, as you cannot use
1640: several directories for the same purpose. Doing so will result in
1641: pkgsrc not being able to properly detect your installed packages,
1642: and fail miserably. Note also that precompiled binary packages are
1643: usually built with the default <code class="varname">LOCALBASE</code> of
1644: <code class="filename">/usr/pkg</code>, and that you should
1645: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1646: <code class="varname">LOCALBASE</code>.</p>
1647: </div>
1648: </div>
1649: </div>
1.41 asau 1650: <div class="chapter">
1.1 dsieger 1651: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1652: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1653: <div class="toc">
1654: <p><b>Table of Contents</b></p>
1.100 leot 1655: <dl class="toc">
1.154 rillig 1656: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1657: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1658: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
1659: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1660: <dd><dl>
1661: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
1662: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1663: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 1664: </dl></dd>
1.154 rillig 1665: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
1666: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1 dsieger 1667: </dl>
1668: </div>
1.4 rillig 1669: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1670: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1671: that file depends on the installation. On NetBSD, when you use
1.174 leot 1672: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 1673: <code class="filename">/etc/</code>. In all other cases the default location is
1674: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1675: bootstrap program to install the binary packages.</p>
1676: <p>The format of the configuration file is that of the usual
1677: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1678: is done by setting variables in this file. Note that you can define all
1679: kinds of variables, and no special error checking (for example for
1.112 rillig 1680: spelling mistakes) takes place.</p>
1.41 asau 1681: <div class="sect1">
1.1 dsieger 1682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1683: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1684: <p>The following variables apply to all
1.1 dsieger 1685: pkgsrc packages. A complete list of the variables that can be
1686: configured by the user is available in
1687: <code class="filename">mk/defaults/mk.conf</code>, together with some
1688: comments that describe each variable's intent.</p>
1.41 asau 1689: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1690: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1691: packages will be installed. The default is
1692: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1693: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1694: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1695: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1696: installed. The default is
1697: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1698: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1699: X11 is installed on the system. The default is
1.84 wiz 1700: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1701: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1702: downloaded copies of the original source distributions used
1703: for building pkgsrc packages. The default is
1704: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1705: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1706: database about installed packages is stored. The default is
1.118 sevan 1707: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1708: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1709: If set, override the packages'
1710: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1711: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1712: Backup location(s) for distribution files and patch files
1713: if not found locally or in
1714: <code class="filename">${MASTER_SITES}</code> or
1715: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1716: The defaults is
1717: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1718: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1719: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1720: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1721: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1722: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1723: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1724: List of acceptable licenses. License names are case-sensitive.
1725: Whenever you try to build a package whose license is not in this
1726: list, you will get an error message. If the license condition is
1727: simple enough, the error message will include specific
1728: instructions on how to change this variable.</p></li>
1.1 dsieger 1729: </ul></div>
1730: </div>
1.41 asau 1731: <div class="sect1">
1.1 dsieger 1732: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1733: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1734: <p>
1.1 dsieger 1735: </p>
1.41 asau 1736: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1737: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1738: directory for the binary packages. The default is
1739: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1740: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1741: The top level directory where, if defined, the separate
1742: working directories will get created, and symbolically
1743: linked to from <code class="filename">${WRKDIR}</code> (see below).
1744: This is useful for building packages on several
1745: architectures, then <code class="filename">${PKGSRCDIR}</code>
1746: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1747: is local to every architecture. (It should be noted that
1748: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1749: — it is an internal definition which refers to the
1.1 dsieger 1750: root of the pkgsrc tree. It is possible to have many
1751: pkgsrc tree instances.)</p></li>
1.23 wiz 1752: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1753: Directory for local patches that aren't part of pkgsrc.
1.154 rillig 1754: See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, “<code class="filename">patches/*</code>”</a> for more
1.1 dsieger 1755: information.</p></li>
1.23 wiz 1756: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1757: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1758: BSD-style Makefile. If this is not set,
1759: <code class="varname">MAKECONF</code> is set to
1760: <code class="filename">/dev/null</code> to avoid picking up
1761: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1762: </ul></div>
1763: </div>
1.41 asau 1764: <div class="sect1">
1.1 dsieger 1765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1766: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.143 maya 1767: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
1768: By default, binary packages of built packages are
1.150 leot 1769: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1770: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1771: <p>Packages have to support installation into a
1.4 rillig 1772: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1773: to be built, before the actual filesystem is touched. DESTDIR
1774: support exists in two variations:</p>
1.41 asau 1775: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1776: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1777: installation and packaging is still run as root.</p></li>
1778: <li class="listitem"><p>Full DESTDIR support can run the complete
1779: build, installation and packaging as normal user. Root
1780: privileges are only needed to add packages.</p></li>
1781: </ul></div>
1.4 rillig 1782: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1783: clean</code></strong> needs to be run as root.</p>
1.17 imil 1784: <p>Considering the <code class="filename">foo/bar</code> package,
1785: DESTDIR full support can be tested using the following commands
1786:
1787: </p>
1788: <pre class="programlisting">
1789: <code class="prompt">$</code> id
1790: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1791: <code class="prompt">$</code> mkdir $HOME/packages
1792: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1793: </pre>
1794: <p>
1795:
1796: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1797: should be needed
1798:
1799: </p>
1800: <pre class="programlisting">
1.66 asau 1801: <code class="prompt">$</code> make stage-install
1.17 imil 1802: </pre>
1803: <p>
1804:
1805: Create a package without root privileges
1806:
1807: </p>
1808: <pre class="programlisting">
1.66 asau 1809: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1810: </pre>
1811: <p>
1812:
1813: For the following command, you must be able to gain root
1.174 leot 1814: privileges using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 1815:
1816: </p>
1817: <pre class="programlisting">
1.66 asau 1818: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1819: </pre>
1820: <p>
1821:
1822: Then, as a simple user
1823:
1824: </p>
1825: <pre class="programlisting">
1826: <code class="prompt">$</code> make clean
1827: </pre>
1828: <p>
1829:
1830: </p>
1.4 rillig 1831: </div>
1.41 asau 1832: <div class="sect1">
1.4 rillig 1833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1834: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1835: <div class="sect2">
1.1 dsieger 1836: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1837: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1838: <p>By default, pkgsrc will use GCC to build packages. This may be
1839: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1840: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1841: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1842: <dd>
1843: <p>This is a list of values specifying the chain of
1844: compilers to invoke when building packages. Valid values
1845: are:</p>
1.41 asau 1846: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1847: <li class="listitem"><p><code class="varname">ccc</code>:
1848: Compaq C Compilers (Tru64)</p></li>
1849: <li class="listitem"><p><code class="varname">ccache</code>:
1850: compiler cache (chainable)</p></li>
1851: <li class="listitem"><p><code class="varname">clang</code>:
1852: Clang C and Objective-C compiler</p></li>
1.23 wiz 1853: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1854: distributed C/C++ (chainable)</p></li>
1.66 asau 1855: <li class="listitem"><p><code class="varname">f2c</code>:
1856: Fortran 77 to C compiler (chainable)</p></li>
1857: <li class="listitem"><p><code class="varname">icc</code>:
1858: Intel C++ Compiler (Linux)</p></li>
1859: <li class="listitem"><p><code class="varname">ido</code>:
1860: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1861: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1862: GNU C/C++ Compiler</p></li>
1.66 asau 1863: <li class="listitem"><p><code class="varname">hp</code>:
1864: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1865: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1866: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1867: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1868: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1869: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1870: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1871: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1872: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1873: </ul></div>
1874: <p>The default is
1.23 wiz 1875: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1876: <code class="varname">ccache</code> and/or
1877: <code class="varname">distcc</code> with an appropriate
1878: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1879: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1880: variable should always be terminated with a value for
1881: a real compiler. Note that only one real compiler
1.23 wiz 1882: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1883: is not allowed).</p>
1884: </dd>
1885: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1886: <dd><p>This specifies the minimum version of GCC to use
1887: when building packages. If the system GCC doesn't
1888: satisfy this requirement, then pkgsrc will build and
1889: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1890: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1891: <dd><p>Specifies which version of python to use when several
1892: options are available.</p></dd>
1893: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.176 gutterid 1894: <dd><p>Specifies the Fortran compiler to use.
1895: The default is <code class="varname">gfortran</code>.</p></dd>
1.114 maya 1896: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1897: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1898: <code class="varname">gfortran</code> is used, this option specifies which
1899: version to use.</p></dd>
1.1 dsieger 1900: </dl></div>
1901: </div>
1.41 asau 1902: <div class="sect2">
1.1 dsieger 1903: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1904: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1905: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
1906: please make sure to use the <code class="literal">+=</code> operator
1907: instead of the <code class="literal">=</code> operator:</p>
1908: <pre class="programlisting">
1909: CFLAGS+= -your -flags
1910: </pre>
1911: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 1912: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 1913: need to add their own flags. You may want to take a look
1.137 leot 1914: 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.23 wiz 1915: package if you're interested in optimization specifically
1916: for the current CPU. </p>
1.1 dsieger 1917: </div>
1.41 asau 1918: <div class="sect2">
1.1 dsieger 1919: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1920: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1921: <p>If you want to pass flags to the linker, both in the configure
1922: step and the build step, you can do this in two ways. Either set
1923: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
1924: between the two is that <code class="varname">LIBS</code> will be appended to
1925: the command line, while <code class="varname">LDFLAGS</code> come earlier.
1926: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
1927: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
1928: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
1929: <code class="varname">CFLAGS</code>, if you do not wish to override these
1930: settings, use the <code class="literal">+=</code> operator:</p>
1931: <pre class="programlisting">
1932: LDFLAGS+= -your -linkerflags
1933: </pre>
1934: </div>
1935: </div>
1.41 asau 1936: <div class="sect1">
1.1 dsieger 1937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1938: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84 wiz 1939: <p>
1.1 dsieger 1940: </p>
1.41 asau 1941: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1942: <li class="listitem">
1.1 dsieger 1943: <p><code class="varname">PKG_DEVELOPER</code>:
1944: Run some sanity checks that package developers want:
1945: </p>
1.41 asau 1946: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 1947: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 1948: fuzz</p></li>
1.23 wiz 1949: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 1950: binaries will find their shared libs.</p></li>
1951: </ul></div>
1952: <p>
1953: </p>
1954: </li>
1.23 wiz 1955: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 1956: of debugging output which is displayed whilst making and
1957: installing the package. The default value for this is 0,
1958: which will not display the commands as they are executed
1959: (normal, default, quiet operation); the value 1 will display
1960: all shell commands before their invocation, and the value 2
1961: will display both the shell commands before their invocation,
1.112 rillig 1962: as well as their actual execution progress with <span class="command"><strong>set
1963: -x</strong></span>.</p></li>
1.1 dsieger 1964: </ul></div>
1965: <p>
1966: </p>
1967: </div>
1.41 asau 1968: <div class="sect1">
1.1 dsieger 1969: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1970: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 1971: <p>Some packages have build time options, usually to select
1972: between different dependencies, enable optional support for big
1973: dependencies or enable experimental features.</p>
1974: <p>To see which options, if any, a package supports, and which
1.10 hubertf 1975: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 1976: show-options</strong></span>, for example:</p>
1977: <pre class="programlisting">
1978: The following options are supported by this package:
1979: ssl Enable SSL support.
1980: Exactly one of the following gecko options is required:
1981: firefox Use firefox as gecko rendering engine.
1982: mozilla Use mozilla as gecko rendering engine.
1983: At most one of the following database options may be selected:
1984: mysql Enable support for MySQL database.
1985: pgsql Enable support for PostgreSQL database.
1986:
1987: These options are enabled by default: firefox
1988: These options are currently enabled: mozilla ssl
1989: </pre>
1990: <p>The following variables can be defined in
1.10 hubertf 1991: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 1992: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
1993: which can be used to select or disable options for all packages
1994: that support them, and
1995: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
1996: which can be used to select or disable options specifically for
1997: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 1998: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 1999: are disabled. A few examples:</p>
2000: <pre class="screen">
1.10 hubertf 2001: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 2002: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2003: PKG_OPTIONS.kdebase= debug -sasl
2004: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2005: <p>It is important to note that options that were specifically
1.18 snj 2006: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2007: you do not wish to include the option. If you are unsure you can view
2008: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2009: <p>The following settings are consulted in the order given, and
2010: the last setting that selects or disables an option is
2011: used:</p>
1.23 wiz 2012: <div class="orderedlist"><ol class="orderedlist" type="1">
2013: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2014: maintainer</p></li>
1.23 wiz 2015: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2016: variables (see below)</p></li>
1.23 wiz 2017: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2018: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2019: </ol></div>
2020: <p>For groups of mutually exclusive options, the last option
2021: selected is used, all others are automatically disabled. If an
2022: option of the group is explicitly disabled, the previously
2023: selected option, if any, is used. It is an error if no option
2024: from a required group of options is selected, and building the
2025: package will fail.</p>
2026: <p>Before the options framework was introduced, build options
2027: were selected by setting a variable (often named
2028: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2029: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2030: transition to the options framework for the user, these legacy
2031: variables are converted to the appropriate options setting
2032: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2033: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2034: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2035: directly. Support for the legacy variables will be removed
2036: eventually.</p>
2037: </div>
2038: </div>
1.41 asau 2039: <div class="chapter">
1.1 dsieger 2040: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2041: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2042: <div class="toc">
2043: <p><b>Table of Contents</b></p>
1.100 leot 2044: <dl class="toc">
1.154 rillig 2045: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2046: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.1 dsieger 2047: </dl>
2048: </div>
1.41 asau 2049: <div class="sect1">
1.1 dsieger 2050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2051: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2052: <p>Once you have built and installed a package, you can create
2053: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.174 leot 2054: another system with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2055: the same package on a group of hosts and wasting CPU time. It also
2056: provides a simple means for others to install your package, should
2057: you distribute it.</p>
2058: <p>To create a binary package, change into the appropriate
1.10 hubertf 2059: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2060: package</strong></span>:</p>
2061: <pre class="screen">
1.112 rillig 2062: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2063: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2064: </pre>
1.1 dsieger 2065: <p>This will build and install your package (if not already done),
2066: and then build a binary package from what was installed. You can
1.10 hubertf 2067: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2068: it. Binary packages are created by default in
2069: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2070: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.137 leot 2071: 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.154 rillig 2072: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.1 dsieger 2073: such a binary package.</p>
2074: </div>
1.41 asau 2075: <div class="sect1">
1.1 dsieger 2076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2077: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
2078: <p>See <a class="xref" href="#build.helpful-targets" title="19.17. Other helpful targets">Section 19.17, “Other helpful targets”</a>.</p>
1.6 rillig 2079: </div>
2080: </div>
1.41 asau 2081: <div class="chapter">
1.6 rillig 2082: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2083: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2084: builds)</h2></div></div></div>
2085: <div class="toc">
2086: <p><b>Table of Contents</b></p>
1.100 leot 2087: <dl class="toc">
1.154 rillig 2088: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 ! rillig 2089: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 2090: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2091: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 2092: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2093: <dd><dl>
1.179 rillig 2094: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2095: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
2096: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.3. Use custom directories</a></span></dt>
2097: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.4. Turn warnings into errors</a></span></dt>
2098: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.5. Reject packages for which pkglint reports errors</a></span></dt>
2099: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.6. Reject packages that contain forbidden strings</a></span></dt>
2100: <dt><span class="sect2"><a href="#bulk.var.test">8.4.7. Reject packages whose self-test fails</a></span></dt>
2101: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.8. Reject packages that use undefined shell variables</a></span></dt>
2102: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.9. Turn off verbose logging</a></span></dt>
1.178 rillig 2103: </dl></dd>
2104: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2105: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2106: </dl>
2107: </div>
1.175 gutterid 2108: <p>For a number of reasons, you may want to build binary packages
2109: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.71 wiz 2110: For instance, when you have multiple machines that should run the same software,
2111: it is wasted time if they all build their packages themselves from source.
2112: Or you may want to build a list of packages you want and check them before
1.175 gutterid 2113: deploying onto production systems.
1.71 wiz 2114: There is a way of getting a set of binary packages:
1.175 gutterid 2115: the bulk build system, or pbulk ("p" stands for "parallel").
1.112 rillig 2116: This chapter describes how to set it up.</p>
1.41 asau 2117: <div class="sect1">
1.6 rillig 2118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2119: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2120: <p>First of all, you have to decide whether you build all packages
2121: or a limited set of them. Full bulk builds usually consume a lot more resources,
2122: both space and time, than builds for some practical sets of packages.
1.175 gutterid 2123: A number of particularly heavy packages exist that are not actually
2124: interesting to a wide audience. (The approximate resource consumption for a
2125: full bulk build is given in section <a class="xref" href="#bulk.req" title="8.3. Requirements of a full bulk build">Section 8.3, “Requirements of a full bulk build”</a>.)
2126: For limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2127: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2128: </p>
2129: <p>During bulk builds various packages are installed and deinstalled
2130: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2131: so make sure that you don't need any package during the builds.
1.112 rillig 2132: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2133: or something even more restrictive, depending on what the operating system provides,
2134: or dedicate the whole physical machine.
2135: As a useful side effect this makes sure that bulk builds cannot
2136: break anything in your system. There have been numerous cases where
1.6 rillig 2137: certain packages tried to install files outside the
2138: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2139: <code class="filename">/etc</code>.
2140: </p>
1.6 rillig 2141: </div>
1.41 asau 2142: <div class="sect1">
1.6 rillig 2143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 ! rillig 2144: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
! 2145: <p>Running a bulk build works roughly as follows:</p>
1.41 asau 2146: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2147: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2148: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2149: </ul></div>
1.41 asau 2150: <div class="sect2">
1.15 rillig 2151: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2152: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2153: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2154: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2155: Configure network access to fetch distribution files.
1.112 rillig 2156: Create a user with name "pbulk".</p>
1.68 asau 2157: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2158: <pre class="screen">
1.151 sevan 2159: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
2160: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.72 wiz 2161: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.68 asau 2162: </pre>
2163: <p>Or any other way that fits (e.g., curl, wget).</p>
2164: <p>Deploy and configure pbulk tools, e.g.:</p>
2165: <pre class="screen">
1.118 sevan 2166: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.68 asau 2167: <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>
2168: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2169: </pre>
2170: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2171: <h3 class="title">Note</h3>
2172: <p><code class="filename">mk.conf.frag</code> is a fragment of
2173: <code class="filename">mk.conf</code> that contains settings you want to
2174: apply to packages you build. For instance,</p>
2175: <pre class="programlisting">
1.112 rillig 2176: PKG_DEVELOPER= yes # perform more checks
2177: X11_TYPE= modular # use pkgsrc X11
2178: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2179: # when building all packages)
1.68 asau 2180: </pre>
2181: </div>
2182: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2183: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2184: <pre class="programlisting">
2185: www/firefox
2186: mail/thunderbird
2187: misc/libreoffice4
2188: </pre>
1.69 asau 2189: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2190: and make final amendments, if wanted.</p>
1.68 asau 2191: <p>Start it:</p>
2192: <pre class="screen">
2193: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2194: </pre>
2195: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2196: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2197: </p>
2198: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2199: <h3 class="title">Note</h3>
2200: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2201: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2202: The script is kept small enough for better understanding.</p>
2203: </div>
2204: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2205: <h3 class="title">Note</h3>
2206: <p>The <code class="filename">pbulk.sh</code> script supports running
2207: unprivileged bulk build and helps configuring distributed bulk builds.</p>
2208: </div>
1.6 rillig 2209: </div>
2210: </div>
1.41 asau 2211: <div class="sect1">
1.6 rillig 2212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2213: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2214: <p>A complete bulk build requires lots of disk space. Some of the
2215: disk space can be read-only, some other must be writable. Some can be on
2216: remote filesystems (such as NFS) and some should be local. Some can be
2217: temporary filesystems, others must survive a sudden reboot.</p>
2218: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2219: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
2220: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
2221: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2222: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2223: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2224: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2225: </ul></div>
2226: </div>
2227: <div class="sect1">
2228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.178 rillig 2229: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2230: <p>To ensure that pkgsrc packages work in different configurations, it
2231: makes sense to run non-default bulk builds from time to time. This
2232: section lists some ideas for bulk builds that intentionally let packages
2233: fail if they don't follow the pkgsrc style.</p>
2234: <div class="sect2">
2235: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2236: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.178 rillig 2237: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2238: <pre class="programlisting">
2239: GNU_CONFIGURE_STRICT= yes
2240: </pre>
2241: <p>When a package fails this additional check, the most common cause
2242: is that the configure option was valid for an older version of the
2243: package but does not apply anymore. In that case, just remove it.</p>
2244: </div>
2245: <div class="sect2">
2246: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2247: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178 rillig 2248: <p>The job of a compiler is not restricted to producing executable
1.179 rillig 2249: code, most compilers also detect typical programming mistakes. The pkgsrc
2250: compiler wrappers make it easy to force compiler options when the package
2251: is built. This can be used to find typical bugs across all packages that
2252: are in pkgsrc. By reporting these bugs upstream, the packages will be
2253: more reliable with the next updates.</p>
2254: <p>Add some of the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.178 rillig 2255: <pre class="programlisting">
2256: CFLAGS+= -Werror=char-subscripts
1.179 rillig 2257: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 2258: </pre>
1.179 rillig 2259: <p>When a package fails to build using these stricter compiler
2260: options, document the circumstances in which the compiler produced the
2261: error message. This includes:</p>
1.178 rillig 2262: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2263: <li class="listitem"><p>The platform
2264: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2265: <li class="listitem"><p>The source file</p></li>
2266: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2267: part of the diagnostic.</p></li>
1.179 rillig 2268: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178 rillig 2269: </ul></div>
2270: <p>If a package produces these error messages, but the package is
1.179 rillig 2271: fine, record this in your local <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, like this, to skip this check
2272: in the next builds:</p>
1.178 rillig 2273: <pre class="programlisting">
1.179 rillig 2274: .if ${PKGPATH} == category/package
1.178 rillig 2275: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2276: # error message
2277: # code
1.179 rillig 2278: # Reason why the code does not need to be fixed.
1.178 rillig 2279: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 2280: .endif
1.178 rillig 2281: </pre>
2282: <p>If the error messages from the compiler are valid and the code
1.179 rillig 2283: needs to be fixed, prepare a local patch (see
2284: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2285: authors of the package, providing them with the information you collected
2286: above.</p>
2287: <p>Patches that are not essential for the package to work should only
2288: be reported upstream but not committed to pkgsrc, to make future updates
2289: easier.</p>
1.178 rillig 2290: </div>
2291: <div class="sect2">
2292: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2293: <a name="bulk.var.dirs"></a>8.4.3. Use custom directories</h3></div></div></div>
1.178 rillig 2294: <p>Some directories like <code class="varname">PREFIX</code>,
2295: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2296: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2297: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2298: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2299: <pre class="programlisting">
2300: PREFIX= /a-random-uuid
2301: PKG_SYSCONFDIR= /a-random-uuid
2302: VARBASE= /a-random-uuid
2303: PKGMANDIR= a-random-uuid
2304: PKG_INFODIR= a-random-uuid
2305: </pre>
2306: </div>
2307: <div class="sect2">
2308: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2309: <a name="bulk.var.warn"></a>8.4.4. Turn warnings into errors</h3></div></div></div>
1.178 rillig 2310: <p>When building a package, warnings are typically ignored since they
2311: just flow by and do not cause the build to fail immediately. To find
2312: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2313: <pre class="programlisting">
2314: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2315: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2316: </pre>
2317: <p>(There are many more classes of warnings in pkgsrc, and most of
2318: them can be redefined with a simple definition like above.</p>
1.179 rillig 2319: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178 rillig 2320: the package Makefile, research whether the package actually needs Perl.
2321: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2322: Makefile, and if it doesn't, add
2323: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2324: </div>
2325: <div class="sect2">
2326: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2327: <a name="bulk.var.pkglint"></a>8.4.5. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178 rillig 2328: <p>Using pkglint as part of the regular build process is mostly a
2329: waste of time. If you want to fix some of the warnings, just run pkglint
2330: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2331: 10), which is much faster than a complete bulk build.</p>
2332: </div>
2333: <div class="sect2">
2334: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2335: <a name="bulk.var.strings"></a>8.4.6. Reject packages that contain forbidden strings</h3></div></div></div>
1.178 rillig 2336: <p>To ensure that the binary packages don't contain references to the
2337: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2338: that variable includes the item <code class="literal">extra</code>, it is
2339: possible to define additional patterns that must not appear in any
2340: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2341: <pre class="programlisting">
2342: CHECK_WRKREF= extra
2343: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2344: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2345: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2346: </pre>
2347: <p>The above patterns will probably generate many false positives,
2348: therefore the results need to be taken with a grain of salt.</p>
2349: </div>
2350: <div class="sect2">
2351: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2352: <a name="bulk.var.test"></a>8.4.7. Reject packages whose self-test fails</h3></div></div></div>
1.178 rillig 2353: <p>To run the test suites that come with each package, add this line
2354: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2355: <pre class="programlisting">
2356: PKGSRC_RUN_TEST= yes
2357: </pre>
2358: <p>Be prepared that even the most basic packages fail this test. When
2359: doing a bulk build with this, it will often abort in the early phase
2360: where the packages are scanned for their dependencies since there are
2361: cyclic dependencies. There is still a lot to do in this area.</p>
2362: </div>
2363: <div class="sect2">
2364: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2365: <a name="bulk.var.shvar"></a>8.4.8. Reject packages that use undefined shell variables</h3></div></div></div>
1.178 rillig 2366: <p>To catch typos in the shell snippets from the Makefile fragments,
2367: add the <code class="literal">-u</code> flag to most of the commands by adding this
2368: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2369: <pre class="programlisting">
2370: RUN= @set -eu;
2371: </pre>
2372: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2373: definition.</p>
2374: </div>
2375: <div class="sect2">
2376: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2377: <a name="bulk.var.quiet"></a>8.4.9. Turn off verbose logging</h3></div></div></div>
1.178 rillig 2378: <p>The build logs of a package are often quite long. This allows error
2379: messages or other interesting details to hide between the noise. To make
2380: the actual error message stand out more, add these lines to
2381: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2382: <pre class="programlisting">
2383: GNU_CONFIGURE_QUIET= yes
2384: MAKE_FLAGS+= -s
2385: </pre>
2386: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2387: Make. On exotic platforms with their own make, it may be a little
2388: different.</p>
2389: </div>
2390: </div>
2391: <div class="sect1">
2392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2393: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2394: <p>After your pkgsrc bulk-build has completed, you may wish to
2395: create a CD-ROM set of the resulting binary packages to assist
2396: in installing packages on other machines. The
1.137 leot 2397: <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.1 dsieger 2398: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2399: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2400: way that keeps all the dependencies for a given package on the same
2401: CD as that package.</p>
1.41 asau 2402: <div class="sect2">
1.1 dsieger 2403: <div class="titlepage"><div><div><h3 class="title">
1.178 rillig 2404: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2405: <p>Complete documentation for cdpack is found in the cdpack(1)
2406: man page. The following short example assumes that the binary
2407: packages are left in
2408: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2409: sufficient disk space exists in <code class="filename">/u2</code> to
2410: hold the ISO 9660 images.</p>
2411: <pre class="screen">
2412: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2413: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2414: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2415: </pre>
2416: <p>If you wish to include a common set of files
2417: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2418: etc.) on each CD in the collection, then you need to create a
1.175 gutterid 2419: directory which contains these files, e.g.:</p>
1.1 dsieger 2420: <pre class="screen">
2421: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2422: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2423: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2424: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2425: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2426: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2427: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2428: </pre>
2429: <p>Now create the images:</p>
2430: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2431: <p>Each image will contain <code class="filename">README</code>,
2432: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2433: in their root directories.</p>
2434: </div>
2435: </div>
2436: </div>
1.41 asau 2437: <div class="chapter">
1.1 dsieger 2438: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2439: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2440: <div class="toc">
2441: <p><b>Table of Contents</b></p>
1.100 leot 2442: <dl class="toc">
1.154 rillig 2443: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2444: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 2445: </dl>
2446: </div>
2447: <p>The files that are installed by pkgsrc are organized in a way that
2448: is similar to what you find in the <code class="filename">/usr</code> directory
2449: of the base system. But some details are different. This is because
2450: pkgsrc initially came from FreeBSD and had adopted its file system
2451: hierarchy. Later it was largely influenced by NetBSD. But no matter
2452: which operating system you are using pkgsrc with, you can expect the
2453: same layout for pkgsrc.</p>
2454: <p>There are mainly four root directories for pkgsrc, which are all
2455: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2456: When pkgsrc has been installed as root, the default locations
2457: are:</p>
2458: <pre class="programlisting">
2459: LOCALBASE= /usr/pkg
2460: PKG_SYSCONFBASE= /usr/pkg/etc
2461: VARBASE= /var
1.119 sevan 2462: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2463: </pre>
2464: <p>In unprivileged mode (when pkgsrc has been installed as any other
2465: user), the default locations are:</p>
2466: <pre class="programlisting">
2467: LOCALBASE= ${HOME}/pkg
2468: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2469: VARBASE= ${HOME}/pkg/var
1.119 sevan 2470: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2471: </pre>
2472: <p>What these four directories are for, and what they look like is
2473: explained below.</p>
1.41 asau 2474: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2475: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2476: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2477: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2478: the well-known subdirectories like <code class="filename">bin</code>,
2479: <code class="filename">include</code>, <code class="filename">lib</code>,
2480: <code class="filename">share</code> and
2481: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2482: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2483: <code class="filename">/var</code> in the base system. Some programs (especially
2484: games, network daemons) need write access to it during normal
2485: operation.</p></li>
1.23 wiz 2486: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2487: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2488: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 2489: itself.</p></li>
2490: </ul></div>
1.41 asau 2491: <div class="sect1">
1.1 dsieger 2492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2493: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2494: </h2></div></div></div>
2495: <p>The following directories exist in a typical pkgsrc installation
2496: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2497: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2498: <dt><span class="term"><code class="filename">bin</code></span></dt>
2499: <dd><p>Contains executable programs that are intended to be
2500: directly used by the end user.</p></dd>
2501: <dt><span class="term"><code class="filename">emul</code></span></dt>
2502: <dd><p>Contains files for the emulation layers of various other
2503: operating systems, especially for
2504: NetBSD.</p></dd>
2505: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2506: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2507: <dd><p>Contains
2508: the configuration files.</p></dd>
2509: <dt><span class="term"><code class="filename">include</code></span></dt>
2510: <dd><p>Contains headers for the C and C++ programming
2511: languages.</p></dd>
2512: <dt><span class="term"><code class="filename">info</code></span></dt>
2513: <dd><p>Contains GNU info files of various
2514: packages.</p></dd>
2515: <dt><span class="term"><code class="filename">lib</code></span></dt>
2516: <dd><p>Contains shared and static
2517: libraries.</p></dd>
2518: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2519: <dd><p>Contains data files that don't change after
2520: installation. Other data files belong into
2521: <code class="filename">${VARBASE}</code>.</p></dd>
2522: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2523: <dd><p>Contains programs that are not intended to be used by
2524: end users, such as helper programs or network
2525: daemons.</p></dd>
2526: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2527: <dd><p>Contains programs that are intended to be executed as
2528: CGI scripts by a web server.</p></dd>
2529: <dt><span class="term"><code class="filename">man</code> (the usual value of
2530: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2531: <dd><p>Contains brief
2532: documentation in form of manual pages.</p></dd>
2533: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2534: <dd><p>Contains programs that are intended to be used only by
2535: the super-user.</p></dd>
2536: <dt><span class="term"><code class="filename">share</code></span></dt>
2537: <dd><p>Contains platform-independent data files that don't
2538: change after installation.</p></dd>
2539: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2540: <dd><p>Contains documentation files provided by the
2541: packages.</p></dd>
2542: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2543: <dd><p>Contains example files provided by the packages. Among
2544: others, the original configuration files are saved here and copied to
2545: <code class="filename">${PKG_SYSCONFDIR}</code> during
2546: installation.</p></dd>
2547: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2548: <dd><p>Contains the original files for rc.d
2549: scripts.</p></dd>
2550: <dt><span class="term"><code class="filename">var</code> (the usual location of
2551: <code class="filename">${VARBASE}</code>)</span></dt>
2552: <dd><p>Contains files
2553: that may be modified after
2554: installation.</p></dd>
2555: </dl></div>
2556: </div>
1.41 asau 2557: <div class="sect1">
1.1 dsieger 2558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2559: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2560: </h2></div></div></div>
1.41 asau 2561: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2562: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2563: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2564: <dd><p>Contains
2565: information about the currently installed
2566: packages.</p></dd>
2567: <dt><span class="term"><code class="filename">games</code></span></dt>
2568: <dd><p>Contains highscore
2569: files.</p></dd>
2570: <dt><span class="term"><code class="filename">log</code></span></dt>
2571: <dd><p>Contains log files.</p></dd>
2572: <dt><span class="term"><code class="filename">run</code></span></dt>
2573: <dd><p>Contains informational files about daemons that are
2574: currently running.</p></dd>
2575: </dl></div>
2576: </div>
2577: </div>
1.41 asau 2578: <div class="chapter">
1.1 dsieger 2579: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2580: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2581: <div class="toc">
2582: <p><b>Table of Contents</b></p>
1.100 leot 2583: <dl class="toc">
1.154 rillig 2584: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2585: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2586: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2587: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2588: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
2589: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2590: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2591: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
2592: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2593: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2594: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 2595: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
2596: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
2597: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2598: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2599: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2600: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2601: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 2602: </dl>
2603: </div>
2604: <p>This section contains hints, tips & tricks on special things in
2605: pkgsrc that we didn't find a better place for in the previous chapters, and
2606: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2607: <div class="sect1">
1.1 dsieger 2608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2609: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2610: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2611: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2612: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 2613: This is a general purpose list for most issues regarding
2614: pkgsrc, regardless of platform, e.g. soliciting user help
2615: for pkgsrc configuration, unexpected build failures, using
2616: particular packages, upgrading pkgsrc installations,
2617: questions regarding the pkgsrc release branches, etc. General announcements or
2618: proposals for changes that impact the pkgsrc user community,
2619: e.g. major infrastructure changes, new features, package
2620: removals, etc., may also be posted.</p></li>
1.174 leot 2621: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 2622: A list where the results of pkgsrc bulk builds are sent and
2623: discussed.</p></li>
1.174 leot 2624: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 2625: This list is for those who are interested in getting a
2626: commit message for every change committed to pkgsrc. It is
2627: also available in digest form, meaning one daily message
2628: containing all commit messages for changes to the package
2629: source tree in that 24 hour period.</p></li>
2630: </ul></div>
2631: <p>To subscribe, do:</p>
2632: <pre class="programlisting">
2633: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2634: </pre>
2635: <p>Archives for all these mailing lists are available from
1.174 leot 2636: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2637: </div>
1.41 asau 2638: <div class="sect1">
1.1 dsieger 2639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2640: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2641: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2642: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2643: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2644: they might be useful, and not to duplicate the documentation that comes
2645: with each package.</p>
2646: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.137 leot 2647: <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.1 dsieger 2648: Symlinks for use by buildlink.</p></li></ul></div>
2649: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2650: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2651: <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.121 sevan 2652: Calculates various kinds of checksums (including SHA3).</p></li>
1.137 leot 2653: <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.1 dsieger 2654: Compatibility library for pkgsrc tools.</p></li>
1.137 leot 2655: <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.1 dsieger 2656: non-BSD systems due to lack of native mtree.</p></li>
1.137 leot 2657: <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.1 dsieger 2658: Up-to-date replacement for
2659: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2660: systems where pkg_install is not present.</p></li>
2661: </ul></div>
2662: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2663: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2664: <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.1 dsieger 2665: Create a binary package from an
1.10 hubertf 2666: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2667: save the old package.</p></li>
1.137 leot 2668: <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.1 dsieger 2669: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2670: from multiple locations. It currently supports the following
2671: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.137 leot 2672: <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.16 jnemeth 2673: the best compiler flags to optimise code for your current
1.23 wiz 2674: CPU and compiler. </p></li>
1.1 dsieger 2675: </ul></div>
2676: <p>Utilities for keeping track of installed packages, being up to date,
2677: etc:</p>
1.41 asau 2678: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2679: <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.65 wiz 2680: update tool similar to apt(1). Download, install, and upgrade
2681: binary packages easily.</p></li>
1.137 leot 2682: <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.1 dsieger 2683: packages whose installed versions do not match the latest pkgsrc
2684: entries.</p></li>
1.137 leot 2685: <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.1 dsieger 2686: dependency graphs of packages, to aid in choosing a strategy for
2687: updating.</p></li>
1.137 leot 2688: <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
2689: 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>
2690: <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.12 weinem 2691: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.137 leot 2692: <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.1 dsieger 2693: does various checks on the complete pkgsrc system.</p></li>
1.137 leot 2694: <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.1 dsieger 2695: packages you have installed.</p></li>
2696: </ul></div>
2697: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2698: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2699: <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.1 dsieger 2700: making and maintaining patches for a package (includes pkgdiff,
2701: pkgvi, mkpatches, etc.).</p></li>
1.137 leot 2702: <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.1 dsieger 2703: converting to pkgsrc.</p></li>
2704: </ul></div>
2705: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2706: utilities)</p>
1.41 asau 2707: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 2708: <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.1 dsieger 2709: packages in a chrooted area.</p></li>
1.137 leot 2710: <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.1 dsieger 2711: kernel version for chrooted cross builds.</p></li>
2712: </ul></div>
2713: </div>
1.41 asau 2714: <div class="sect1">
1.1 dsieger 2715: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2716: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2717: <p>To install packages from source as a non-root user, download
1.154 rillig 2718: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.108 rillig 2719: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2720: --unprivileged</strong></span>.</p>
2721: <p>This will install the binary part of pkgsrc to
2722: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2723: into <code class="filename">~/pkg/etc</code>.</p>
2724: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2725: </div>
1.41 asau 2726: <div class="sect1">
1.1 dsieger 2727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2728: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2729: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2730: enable this feature by adding the option
2731: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2732: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2733: distfile is found, pkgsrc will try to resume it.</p>
2734: <p>You can also
1.61 wiz 2735: use a different program than the platform default program by changing the
1.16 jnemeth 2736: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2737: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2738: by using the value manual. A value of custom disables the system defaults
2739: and dependency tracking for the fetch program. In that case you have to
2740: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2741: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2742: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2743: <p>For example, if you want to use
1.16 jnemeth 2744: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2745: like:</p>
2746: <pre class="programlisting">
1.112 rillig 2747: FETCH_USING= wget
1.1 dsieger 2748: </pre>
2749: </div>
1.41 asau 2750: <div class="sect1">
1.1 dsieger 2751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2752: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 2753: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2754: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2755: you will have to add the following line into
1.10 hubertf 2756: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2757: <pre class="programlisting">
1.4 rillig 2758: X11_TYPE=modular
1.1 dsieger 2759: </pre>
2760: </div>
1.41 asau 2761: <div class="sect1">
1.1 dsieger 2762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2763: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2764: <p>If you are sitting behind a firewall which does not allow direct
2765: connections to Internet hosts (i.e. non-NAT), you may specify the
2766: relevant proxy hosts. This is done using an environment variable in the
2767: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2768: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2769: port 80 as the proxy port number. So the proxy environment variables
2770: are:</p>
2771: <pre class="programlisting">
2772: ftp_proxy=ftp://orpheus.amdahl.com:80/
2773: http_proxy=http://orpheus.amdahl.com:80/
2774: </pre>
2775: </div>
1.41 asau 2776: <div class="sect1">
1.1 dsieger 2777: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2778: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2779: <p>Some fetch tools are not prepared to support HTTPS by default
2780: (for example, the one in NetBSD 6.0), or the one installed by the
2781: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2782: dependency graph).</p>
2783: <p>Usually you won't notice, because distribution files are
2784: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2785: be often enough if you are following pkgsrc-current. In that case, set
2786: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2787: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2788: with HTTPS support by default. Of course, these tools need to be
2789: installed before you can use them this way.</p>
2790: </div>
2791: <div class="sect1">
2792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2793: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1 dsieger 2794: <p>This depends on which utility is used to retrieve distfiles. From
2795: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2796: the first available command from the following list:</p>
1.41 asau 2797: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2798: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2799: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2800: </ul></div>
2801: <p>On a default NetBSD installation, this will be
2802: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2803: connections first, and falls back to active connections if the server
2804: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2805: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2806: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2807: <p>Having that option present will prevent
2808: <code class="filename">/usr/bin/ftp</code> from falling back to active
2809: transfers.</p>
2810: </div>
1.41 asau 2811: <div class="sect1">
1.1 dsieger 2812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2813: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 2814: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 2815: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 2816: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1 dsieger 2817: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 2818: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 2819: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
2820: resulting list to your machine at work/school and use it there. If you
1.174 leot 2821: don't have a NetBSD-compatible <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 2822: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
2823: URL:</p>
2824: <p>At home:</p>
2825: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2826: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
2827: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
2828: <p>At work:</p>
2829: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
2830: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
2831: home.</p>
2832: <p>If you have a machine running NetBSD, and you want to get
2833: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
2834: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 2835: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 2836: directly by running:</p>
2837: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
2838: <p>If you even decide to ignore
2839: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
2840: by running:</p>
2841: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
2842: </div>
1.41 asau 2843: <div class="sect1">
1.1 dsieger 2844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2845: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">“<span class="quote">Don't know how to make
1.23 wiz 2846: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.137 leot 2847: <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.1 dsieger 2848: package, you get the error from make that it doesn't know how to make
2849: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 2850: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 2851: the NetBSD base distribution on your machine. It is recommended to do
2852: that to format man pages.</p>
1.137 leot 2853: <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.1 dsieger 2854: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 2855: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2856: </div>
1.41 asau 2857: <div class="sect1">
1.1 dsieger 2858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2859: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 2860: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
2861: when you installed your NetBSD machine. Please get and install it, by
2862: extracting it in <code class="filename">/</code>:</p>
2863: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
2864: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
2865: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 2866: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 2867: -r</strong></span>).</p>
2868: </div>
1.41 asau 2869: <div class="sect1">
1.1 dsieger 2870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2871: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 2872: <p>When installing packages as non-root user and using the just-in-time
1.174 leot 2873: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-9.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.1 dsieger 2874: password for each required package installed. To avoid this, the sudo
2875: package can be used, which does password caching over a limited time. To
2876: use it, install sudo (either as binary package or from
1.137 leot 2877: <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.10 hubertf 2878: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 2879: <span class="emphasis"><em>after</em></span> the definition of the
2880: <code class="varname">LOCALBASE</code> variable:</p>
2881: <pre class="programlisting">
2882: .if exists(${LOCALBASE}/bin/sudo)
2883: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2884: .endif
2885: </pre>
2886: </div>
1.41 asau 2887: <div class="sect1">
1.1 dsieger 2888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2889: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 2890: <p>As the system administrator, you can choose where configuration files
2891: are installed. The default settings make all these files go into
2892: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
2893: be suboptimal depending on your expectations (e.g., a read-only,
2894: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
2895: configuration of the provided packages).</p>
2896: <p>In order to change the defaults, you can modify the
2897: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 2898: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 2899: directory; some common examples include <code class="filename">/etc</code> or
2900: <code class="filename">/etc/pkg</code>.</p>
2901: <p>Furthermore, you can change this value on a per-package basis by
2902: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
2903: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
2904: package you would like to modify, that is, the contents of
2905: <code class="varname">PKGBASE</code>.</p>
2906: <p>Note that after changing these settings, you must rebuild and
2907: reinstall any affected packages.</p>
2908: </div>
1.41 asau 2909: <div class="sect1">
1.1 dsieger 2910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2911: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 2912: <p>Please be aware that there can often be bugs in third-party software,
2913: and some of these bugs can leave a machine vulnerable to exploitation by
2914: attackers. In an effort to lessen the exposure, the NetBSD packages team
2915: maintains a database of known-exploits to packages which have at one time
2916: been included in pkgsrc. The database can be downloaded automatically, and
2917: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 2918: do this, refer to the following two tools (installed as part of the
1.137 leot 2919: <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.23 wiz 2920: <div class="orderedlist"><ol class="orderedlist" type="1">
2921: <li class="listitem">
1.20 snj 2922: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 2923: download a list of the security vulnerabilities information. This list
1.25 spz 2924: is kept up to date by the pkgsrc security team, and is distributed
2925: from the NetBSD ftp server:</p>
1.177 leot 2926: <p><a class="ulink" href="https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a></p>
1.1 dsieger 2927: </li>
1.23 wiz 2928: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
2929: current machine, checking each known vulnerability. If a
1.1 dsieger 2930: vulnerable package is installed, it will be shown by output to stdout,
2931: including a description of the type of vulnerability, and a URL
2932: containing more information.</p></li>
2933: </ol></div>
1.121 sevan 2934: <p>Use of these tools is strongly recommended!
1.154 rillig 2935: See <a class="xref" href="#vulnerabilities" title="5.1.5. Checking for security vulnerabilities in installed packages">Section 5.1.5, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.121 sevan 2936: reporting.</p>
2937: <p>If this database is installed, pkgsrc builds will use it to
2938: perform a security check before building any package.</p>
1.1 dsieger 2939: </div>
1.41 asau 2940: <div class="sect1">
1.1 dsieger 2941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2942: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 2943: <p>When you add your own preferences to the
2944: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 2945: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 2946: environment variables to the <code class="filename">./configure</code>
1.174 leot 2947: scripts and to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 2948: <code class="varname">CFLAGS</code> from the environment variable by
2949: overriding them in the <code class="filename">Makefile</code>s of their
2950: package.</p>
2951: <p>Currently there is no solution to this problem. If you
2952: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 2953: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 2954: directory and then inspect any <code class="filename">Makefile</code> and
2955: <code class="filename">Makefile.in</code> for whether they define
2956: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 2957: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 2958: programmers write so bad code that it only works for the
2959: specific combination of <code class="varname">CFLAGS</code> they have
2960: chosen.</p>
1.172 rillig 2961: <p>To find out where the CFLAGS are ignored, add the following lines to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
2962: <pre class="programlisting">
2963: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
2964: CFLAGS+= -Dpkgsrc___CFLAGS
2965: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
2966: </pre>
2967: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
2968: to see whether the above flags are passed to the actual build
2969: commands in general.</p>
2970: <p>To find out whether the flags are passed to individual compiler
2971: commands, have a look at the file <code class="filename">work/.work.log</code>. In
2972: most cases, the flags from the original command lines (the lines starting
2973: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
2974: (the lines starting with <code class="literal"><.></code>). If the flag is
2975: missing from the actual compiler command, it must have been removed by
2976: the <a class="link" href="#build.wrapper" title="19.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1 dsieger 2977: </div>
1.41 asau 2978: <div class="sect1">
1.1 dsieger 2979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2980: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 2981: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2982: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 2983: case that occurs often is that people only update pkgsrc in
2984: parts, because of performance reasons. Since pkgsrc is one large
2985: system, not a collection of many small systems, there are
2986: sometimes changes that only work when the whole pkgsrc tree is
2987: updated.</p></li>
1.41 asau 2988: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 2989: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
2990: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 2991: files.</p></li>
1.41 asau 2992: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 2993: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 2994: verify this.</p></li>
1.108 rillig 2995: <li class="step"><p>If you are a package developer who wants to invest
1.154 rillig 2996: some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.41 asau 2997: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 2998: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
2999: </ol></div>
3000: </div>
1.41 asau 3001: <div class="sect1">
1.1 dsieger 3002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3003: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3004: <p>You have modified a file from pkgsrc, and someone else has
3005: modified that same file afterwards in the CVS repository. Both changes
3006: are in the same region of the file, so when you updated pkgsrc, the
3007: <code class="literal">cvs</code> command marked the conflicting changes in the
3008: file. Because of these markers, the file is no longer a valid
3009: <code class="filename">Makefile</code>.</p>
3010: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3011: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3012: -dP</strong></span> in that directory to download the current version.</p>
3013: </div>
3014: </div>
3015: </div>
1.41 asau 3016: <div class="part">
1.1 dsieger 3017: <div class="titlepage"><div><div><h1 class="title">
3018: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3019: <div class="partintro">
1.1 dsieger 3020: <div></div>
3021: <p>This part of the book deals with creating and
1.23 wiz 3022: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3023: guide on creating a new package. The remaining chapters are more
3024: like a reference manual for pkgsrc.</p>
3025: <div class="toc">
3026: <p><b>Table of Contents</b></p>
1.100 leot 3027: <dl class="toc">
1.154 rillig 3028: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
3029: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3030: <dd><dl>
1.154 rillig 3031: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 3032: <dd><dl>
1.154 rillig 3033: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
3034: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160 brook 3035: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
3036: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 3037: </dl></dd>
1.154 rillig 3038: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
3039: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 3040: </dl></dd>
1.154 rillig 3041: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.6 rillig 3042: <dd><dl>
1.154 rillig 3043: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
3044: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
3045: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.6 rillig 3046: <dd><dl>
1.154 rillig 3047: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
3048: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
3049: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
3050: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
3051: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.6 rillig 3052: </dl></dd>
1.154 rillig 3053: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
3054: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.6 rillig 3055: <dd><dl>
1.154 rillig 3056: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
3057: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
3058: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.6 rillig 3059: </dl></dd>
1.154 rillig 3060: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
3061: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3062: </dl></dd>
1.154 rillig 3063: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3064: <dd><dl>
1.154 rillig 3065: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
3066: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
3067: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
3068: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.6 rillig 3069: <dd><dl>
1.154 rillig 3070: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
3071: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
3072: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
3073: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.6 rillig 3074: </dl></dd>
3075: </dl></dd>
1.154 rillig 3076: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.6 rillig 3077: <dd><dl>
1.154 rillig 3078: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
3079: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3080: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
3081: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
3082: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
3083: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3084: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
3085: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
3086: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3087: </dl></dd>
1.154 rillig 3088: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.6 rillig 3089: <dd><dl>
1.154 rillig 3090: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
3091: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3092: <dd><dl>
1.154 rillig 3093: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3094: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26 wiz 3095: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3096: and
3097: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3098: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3099: </dl></dd>
1.154 rillig 3100: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 3101: <dd><dl>
1.154 rillig 3102: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
3103: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.6 rillig 3104: </dl></dd>
3105: </dl></dd>
1.154 rillig 3106: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.6 rillig 3107: <dd><dl>
1.154 rillig 3108: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
3109: <dd><dl>
3110: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
3111: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
3112: </dl></dd>
3113: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
3114: <dd><dl>
3115: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3116: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
3117: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
3118: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
3119: </dl></dd>
3120: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
3121: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3122: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
3123: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
3124: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
3125: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
3126: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
3127: </dl></dd>
3128: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
3129: <dd><dl>
3130: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
3131: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
3132: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
3133: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
3134: </dl></dd>
3135: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
3136: <dd><dl>
3137: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
3138: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
3139: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
3140: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
3141: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3142: <dd><dl>
3143: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
3144: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
3145: </dl></dd>
3146: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3147: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3148: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3149: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3150: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3151: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3152: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3153: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3154: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3155: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3156: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
3157: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
3158: </dl></dd>
3159: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
3160: <dd><dl>
3161: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
3162: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
3163: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
3164: </dl></dd>
3165: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3166: <dd><dl>
3167: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3168: <dd><dl>
3169: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
3170: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3171: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3172: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3173: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3174: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3175: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3176: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3177: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3178: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3179: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3180: </dl></dd>
3181: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3182: <dd><dl>
3183: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3184: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
3185: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3186: </dl></dd>
3187: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3188: <dd><dl>
3189: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3190: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3191: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
3192: </dl></dd>
3193: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3194: <dd><dl>
3195: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3196: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
3197: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
3198: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
3199: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
3200: </dl></dd>
3201: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3202: <dd><dl>
3203: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3204: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 3205: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3206: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
3207: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 3208: </dl></dd>
3209: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3210: <dd><dl>
3211: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3212: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3213: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3214: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3215: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3216: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
3217: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3218: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
3219: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
3220: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
3221: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
3222: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
3223: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
3224: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
3225: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
3226: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
3227: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
3228: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 3229: emulation</a></span></dt>
1.154 rillig 3230: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
3231: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3232: </dl></dd>
1.154 rillig 3233: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3234: </dl></dd>
1.154 rillig 3235: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
3236: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3237: <dd><dl>
1.154 rillig 3238: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3239: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3240: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3241: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3242: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3243: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3244: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3245: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3246: </dl></dd>
3247: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
3248: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
3249: <dd><dl>
3250: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
3251: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
3252: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
3253: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 3254: </dl></dd>
3255: </dl>
3256: </div>
3257: </div>
1.41 asau 3258: <div class="chapter">
1.1 dsieger 3259: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3260: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3261: <p>
3262: To get help when developing pkgsrc, the definitive source is this
3263: document, the pkgsrc guide. If you don't find anything here,
3264: there are alternatives:
3265: </p>
3266: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3267: <li class="listitem">
3268: <p>
3269: The built-in pkgsrc help, which is available after bootstrapping
3270: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3271: help for any topic, such as a variable name like
3272: <code class="varname">BUILD_DEFS</code>, a make target like
3273: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3274: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
3275: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix D. Help topics">Appendix D, <i>Help topics</i></a>.</p>
3276: </li>
3277: <li class="listitem"><p>
1.163 rillig 3278: To see the value of a single variable, run <span class="command"><strong>bmake
3279: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3280: </p></li>
3281: <li class="listitem"><p>
3282: To see the values of the most common variables, run
3283: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3284: topic. To see the variables for a single topic, run
3285: <span class="command"><strong>bmake
3286: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3287: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3288: </p></li>
3289: <li class="listitem"><p>
1.154 rillig 3290: The tech-pkg mailing list, to which
3291: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3292: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3293: questions</a>.</p></li>
3294: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3295: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3296: or by using a specialized chat program such as
3297: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3298: Pick any user name and join the channel #pkgsrc.</p></li>
3299: </ul></div>
3300: </div>
3301: <div class="chapter">
3302: <div class="titlepage"><div><div><h2 class="title">
3303: <a name="creating"></a>Chapter 12. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3304: <div class="toc">
3305: <p><b>Table of Contents</b></p>
1.100 leot 3306: <dl class="toc">
1.154 rillig 3307: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1 dsieger 3308: <dd><dl>
1.154 rillig 3309: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
3310: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160 brook 3311: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
3312: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1 dsieger 3313: </dl></dd>
1.154 rillig 3314: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
3315: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1 dsieger 3316: </dl>
3317: </div>
3318: <p>When you find a package that is not yet in pkgsrc, you
3319: most likely have a URL from where you can download the source
3320: code. Starting with this URL, creating a package involves only a
3321: few steps.</p>
1.23 wiz 3322: <div class="procedure"><ol class="procedure" type="1">
1.137 leot 3323: <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.41 asau 3324: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3325: category in which you want to place your package. You can also create a
3326: directory of your own (maybe called <code class="filename">local</code>). In that
3327: category directory, create another directory for your package and change
3328: into it.</p></li>
1.41 asau 3329: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3330: you for a URL. Enter the URL of the distribution file (in most cases a
3331: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3332: of your package are created automatically. The distribution file is
3333: extracted automatically to fill in some details in the
3334: <code class="filename">Makefile</code> that would otherwise have to be done
3335: manually.</p></li>
1.41 asau 3336: <li class="step">
1.1 dsieger 3337: <p>Examine the extracted files to determine the dependencies of
3338: your package. Ideally, this is mentioned in some
3339: <code class="filename">README</code> file, but things may differ. For each of
3340: these dependencies, look where it exists in pkgsrc, and if there is a
3341: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3342: line to your package <code class="filename">Makefile</code> which includes that
3343: file just before the last line. If the
1.25 spz 3344: <code class="filename">buildlink3.mk</code> file does not exist, it must be
1.161 leot 3345: created first. The <code class="filename">buildlink3.mk</code> file makes sure
3346: that the package's include files and libraries are provided.</p>
1.25 spz 3347: <p>If you just need binaries from a package, add a
1.1 dsieger 3348: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3349: version of the dependency and where it can be found in pkgsrc. This line
3350: should be placed in the third paragraph. If the dependency is only
3351: needed for building the package, but not when using it, use
1.156 leot 3352: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
3353: instead of <code class="varname">DEPENDS</code>.
3354: The difference between <code class="varname">TOOL_DEPENDS</code> and
3355: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
3356: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
3357: packages, i.e. packages for the architecture where the package
3358: is built;
3359: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
3360: packages, i.e. packages for the architecture for which the package
1.175 gutterid 3361: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
3362: to specify a dependency used only for testing the resulting package
3363: built, using the upstream project's included test suite.
1.1 dsieger 3364: Your package may then look like this:</p>
3365: <pre class="programlisting">
3366: [...]
3367:
1.156 leot 3368: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 3369: DEPENDS+= screen-[0-9]*:../../misc/screen
3370: DEPENDS+= screen>=4.0:../../misc/screen
3371:
3372: [...]
3373:
3374: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3375: .include "../../devel/glib2/buildlink3.mk"
3376: .include "../../mk/bsd.pkg.mk"
3377: </pre>
3378: </li>
1.41 asau 3379: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3380: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.10 hubertf 3381: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3382: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3383: -e</strong></span>, which outputs additional
3384: explanations.</p></li>
1.41 asau 3385: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.154 rillig 3386: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="12.1. Common types of packages">Section 12.1, “Common types of packages”</a>. After you have followed the instructions
1.1 dsieger 3387: over there, you can hopefully continue here.</p></li>
1.41 asau 3388: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3389: directory from the extracted files. Besides these files, a lot of cache
3390: files and other system information has been saved in the working
3391: directory, which may become wrong after you edited the
3392: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3393: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.154 rillig 3394: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.41 asau 3395: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3396: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3397: everything works.</p></li>
1.41 asau 3398: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3399: contains a list of the files that are installed by the package, is
1.10 hubertf 3400: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3401: >PLIST</strong></span> to generate a probably correct list. Check
3402: the file using your preferred text editor to see if the list of
3403: files looks plausible.</p></li>
1.41 asau 3404: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3405: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3406: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3407: has been registered in the database of installed files, but with an
1.10 hubertf 3408: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3409: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3410: registered with the list of files from
3411: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3412: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3413: package from the set of installed files.</p></li>
3414: </ol></div>
1.41 asau 3415: <div class="sect1">
1.1 dsieger 3416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3417: <a name="creating.common"></a>12.1. Common types of packages</h2></div></div></div>
1.41 asau 3418: <div class="sect2">
1.1 dsieger 3419: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3420: <a name="creating.perl-module"></a>12.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3421: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3422: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3423: </div>
1.41 asau 3424: <div class="sect2">
1.1 dsieger 3425: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3426: <a name="creating.python-module"></a>12.1.2. Python modules and programs</h3></div></div></div>
1.17 imil 3427: <p>Python modules and programs packages are easily created using a
3428: set of predefined variables.</p>
3429: <p>
1.63 wiz 3430: If some Python versions are not supported by the software, set the
3431: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
3432: that are not supported, e.g.
1.17 imil 3433: </p>
3434: <pre class="programlisting">
1.93 sevan 3435: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 3436: </pre>
3437: <p>
1.103 wiz 3438: If the packaged software is a Python module, include one of
3439: <code class="filename">../../lang/python/egg.mk</code>,
3440: <code class="filename">../../lang/python/distutils.mk</code>, or
3441: <code class="filename">../../lang/python/extension.mk</code>.</p>
3442: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3443: easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
1.175 gutterid 3444: If the packaged software is using setuptools, you only need
1.103 wiz 3445: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
3446: Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
1.175 gutterid 3447: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>,
1.103 wiz 3448: so pkgsrc will use this framework.
1.175 gutterid 3449: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>;
1.103 wiz 3450: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
3451: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3452: to the name of the script.</p>
3453: <p>Either way, the package directory should be called
1.23 wiz 3454: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3455: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3456: </p>
3457: <pre class="programlisting">
3458: DISTNAME= foopymodule-1.2.10
3459: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3460: </pre>
1.63 wiz 3461: <p>If it is an application, include
3462: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
3463: In order to correctly set the path to the Python interpreter, use the
1.17 imil 3464: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 3465: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63 wiz 3466: For example:
1.17 imil 3467: </p>
3468: <pre class="programlisting">
1.35 wiz 3469: REPLACE_PYTHON= *.py
1.17 imil 3470: </pre>
1.63 wiz 3471: <p>Some Python modules have separate distributions for Python-2.x
3472: and Python-3.x support. In pkgsrc this is handled by the
3473: <code class="filename">versioned_dependencies.mk</code> file. Set
3474: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
3475: packages that should be depended upon and include
3476: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
3477: then the pkgsrc infrastructure will depend on the appropriate package
3478: version. For example:
3479: </p>
3480: <pre class="programlisting">
1.135 wiz 3481: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.63 wiz 3482: </pre>
3483: <p>
3484: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
3485: of supported packages.</p>
1.17 imil 3486: </div>
1.160 brook 3487: <div class="sect2">
3488: <div class="titlepage"><div><div><h3 class="title">
3489: <a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
3490: <p>Simple R packages from <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>
3491: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
3492: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/README.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
3493: Individual packages (and optionally their dependencies) may be created
3494: and updated. R packages generally follow the same form, and most of
3495: the relevant information needed is contained in a
3496: <code class="filename">DESCRIPTION</code> file as part of each R package on
3497: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
3498: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
3499: creates or updates a package in the canonical form. The resulting
3500: package should be reviewed for correctness.</p>
3501: </div>
3502: <div class="sect2">
3503: <div class="titlepage"><div><div><h3 class="title">
3504: <a name="creating.TeX-package"></a>12.1.4. TeXlive packages</h3></div></div></div>
3505: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
3506: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/README.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
3507: <p>If the TeXlive package name is not known, it may be useful to
3508: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
3509: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
3510: identifies the basename of the package file in the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
3511: archive</a>.</p>
3512: <p>If the TeXlive package name is known, download the files from
3513: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
3514: archive</a>. For package <code class="filename">foo</code>, you will need
3515: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
3516: also have associated documentation packages, so download
3517: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
3518: should be placed in the appropriate category directory, which is often
3519: but not always <code class="filename">print</code>. Then run the following
3520: command in the category directory.</p>
3521: <pre class="programlisting">
3522: texlive2pkg foo.tar.xz foo.doc.tar.xz
3523: </pre>
3524: <p>This will create two packages, <code class="filename">tex-foo</code> and
3525: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
3526: are correct.</p>
3527: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
3528: currently does not include version information in package filenames
3529: and changes their contents periodically when updates occur.
3530: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
3531: pkgsrc archives. For each new or updated TeXlive package, e.g., the
3532: main one and the corresponding documentation, upload the distfiles
3533: with the following command in each package directory.</p>
3534: <pre class="programlisting">
3535: make upload-distfiles
3536: </pre>
3537: </div>
1.1 dsieger 3538: </div>
1.41 asau 3539: <div class="sect1">
1.1 dsieger 3540: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3541: <a name="creating.examples"></a>12.2. Examples</h2></div></div></div>
1.41 asau 3542: <div class="sect2">
1.1 dsieger 3543: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3544: <a name="creating.nvu"></a>12.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 3545: <div class="sect3">
1.1 dsieger 3546: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3547: <a name="creating.nvu.init"></a>12.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3548: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 3549: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 3550: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 3551: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 3552: <pre class="programlisting">
3553: <code class="prompt">$</code> mkdir www/nvu
3554: <code class="prompt">$</code> cd www/nvu
3555: </pre>
3556: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3557: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3558: <pre class="programlisting">
3559: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3560: </pre>
3561: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3562: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 3563: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 3564: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3565: <code class="varname">COMMENT</code> fields. Then the package
3566: <code class="filename">Makefile</code> looked like that:</p>
3567: <pre class="programlisting">
1.121 sevan 3568: # $NetBSD $
1.1 dsieger 3569: #
3570:
3571: DISTNAME= nvu-1.0-sources
3572: PKGNAME= nvu-1.0
3573: CATEGORIES= www
3574: MASTER_SITES= http://cvs.nvu.com/download/
3575: EXTRACT_SUFX= .tar.bz2
3576:
3577: MAINTAINER= rillig@NetBSD.org
3578: HOMEPAGE= http://cvs.nvu.com/
3579: COMMENT= Web Authoring System
3580:
3581: # url2pkg-marker (please do not remove this line.)
3582: .include "../../mk/bsd.pkg.mk"
3583: </pre>
1.124 wiz 3584: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.121 sevan 3585: this is a workaround to prevent CVS expanding to the filename of the
3586: guide.</p>
1.1 dsieger 3587: <p>Then, I quit the editor and watched pkgsrc downloading a large
3588: source archive:</p>
3589: <pre class="programlisting">
3590: url2pkg> Running "make makesum" ...
3591: => Required installed package digest>=20010302: digest-20060826 found
3592: => Fetching nvu-1.0-sources.tar.bz2
3593: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3594: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3595: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3596: url2pkg> Running "make extract" ...
3597: => Required installed package digest>=20010302: digest-20060826 found
3598: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3599: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3600: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3601: ===> Installing dependencies for nvu-1.0
3602: ===> Overriding tools for nvu-1.0
3603: ===> Extracting for nvu-1.0
3604: url2pkg> Adjusting the Makefile.
3605:
3606: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3607:
3608: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3609: </pre>
3610: </div>
1.41 asau 3611: <div class="sect3">
1.1 dsieger 3612: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3613: <a name="creating.nvu.problems"></a>12.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1 dsieger 3614: <p>Now that the package has been extracted, let's see what's inside
3615: it. The package has a <code class="filename">README.txt</code>, but that only
3616: says something about mozilla, so it's probably useless for seeing what
3617: dependencies this package has. But since there is a GNU configure script
3618: in the package, let's hope that it will complain about everything it
3619: needs.</p>
3620: <pre class="programlisting">
3621: <code class="prompt">$</code> bmake
3622: => Required installed package digest>=20010302: digest-20060826 found
3623: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3624: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3625: ===> Patching for nvu-1.0
3626: ===> Creating toolchain wrappers for nvu-1.0
3627: ===> Configuring for nvu-1.0
3628: [...]
3629: configure: error: Perl 5.004 or higher is required.
3630: [...]
3631: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3632: [...]
3633: </pre>
3634: <p>That worked quite well. So I opened the package Makefile in my
3635: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 3636: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 3637: package have changed now, and since a perl wrapper is automatically
1.23 wiz 3638: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 3639: from scratch.</p>
3640: <pre class="programlisting">
3641: <code class="prompt">$</code> bmake clean
3642: ===> Cleaning for nvu-1.0
3643: <code class="prompt">$</code> bmake
3644: [...]
3645: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3646: GNU Make. You will not be able to build Mozilla without GNU Make.
3647: [...]
3648: </pre>
1.23 wiz 3649: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 3650: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
3651: <pre class="programlisting">
3652: [...]
3653: checking for GTK - version >= 1.2.0... no
3654: *** Could not run GTK test program, checking why...
3655: [...]
3656: </pre>
3657: <p>Now to the other dependencies. The first question is: Where is the
3658: GTK package hidden in pkgsrc?</p>
3659: <pre class="programlisting">
3660: <code class="prompt">$</code> echo ../../*/gtk*
3661: [many packages ...]
3662: <code class="prompt">$</code> echo ../../*/gtk
3663: ../../x11/gtk
3664: <code class="prompt">$</code> echo ../../*/gtk2
3665: ../../x11/gtk2
3666: <code class="prompt">$</code> echo ../../*/gtk2/bui*
3667: ../../x11/gtk2/buildlink3.mk
3668: </pre>
3669: <p>The first try was definitely too broad. The second one had exactly
3670: one result, which is very good. But there is one pitfall with GNOME
3671: packages. Before GNOME 2 had been released, there were already many
3672: GNOME 1 packages in pkgsrc. To be able to continue to use these
3673: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 3674: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 3675: whether this was the case here, and indeed it was.</p>
3676: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
3677: file, adding the dependency is very easy. I just inserted an
3678: <code class="literal">.include</code> line before the last line of the package
3679: <code class="filename">Makefile</code>, so that it now looks like this:</p>
3680: <pre class="programlisting">
3681: [...]
3682: .include "../../x11/gtk2/buildlink3.mk"
3683: .include "../../mk/bsd.pkg.mk
3684: </pre>
1.10 hubertf 3685: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 3686: was:</p>
3687: <pre class="programlisting">
3688: [...]
3689: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3690: checking for GTK - version >= 1.2.0... no
3691: *** Could not run GTK test program, checking why...
3692: *** The test program failed to compile or link. See the file config.log for the
3693: *** exact error that occured. This usually means GTK was incorrectly installed
3694: *** or that you have moved GTK since it was installed. In the latter case, you
3695: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3696: configure: error: Test for GTK failed.
3697: [...]
3698: </pre>
1.23 wiz 3699: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
3700: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 3701: told me that this package really wanted to have the GNOME 1 version of
3702: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 3703: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 3704: So I changed the <code class="literal">x11/gtk2</code> to
3705: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
3706: and tried again.</p>
3707: <pre class="programlisting">
3708: [...]
1.59 jnemeth 3709: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 3710: In file included from xpidl.c:42:
3711: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3712: In file included from xpidl.c:42:
3713: xpidl.h:132: error: parse error before "IDL_ns"
3714: [...]
3715: </pre>
3716: <p>The package still does not find all of its dependencies. Now the
3717: question is: Which package provides the
3718: <code class="filename">libIDL/IDL.h</code> header file?</p>
3719: <pre class="programlisting">
3720: <code class="prompt">$</code> echo ../../*/*idl*
3721: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3722: <code class="prompt">$</code> echo ../../*/*IDL*
3723: ../../net/libIDL
3724: </pre>
3725: <p>Let's take the one from the second try. So I included the
3726: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
3727: again. But the error didn't change. After digging through some of the
3728: code, I concluded that the build process of the package was broken and
3729: couldn't have ever worked, but since the Mozilla source tree is quite
3730: large, I didn't want to fix it. So I added the following to the package
3731: <code class="filename">Makefile</code> and tried again:</p>
3732: <pre class="programlisting">
3733: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.139 leot 3734: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 3735: </pre>
3736: <p>The latter line is needed because the package expects the library
3737: <code class="filename">libIDL.so</code>, but only
3738: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
3739: wrapper to rewrite that on the fly.</p>
3740: <p>The next problem was related to a recent change of the FreeType
1.137 leot 3741: 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.1 dsieger 3742: which patch files were relevant for this issue and copied them to the
3743: <code class="filename">patches</code> directory. Then I retried, fixed the
3744: patches so that they applied cleanly and retried again. This time,
3745: everything worked.</p>
3746: </div>
1.41 asau 3747: <div class="sect3">
1.1 dsieger 3748: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 3749: <a name="creating.nvu.inst"></a>12.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 3750: <pre class="programlisting">
3751: <code class="prompt">$</code> bmake CHECK_FILES=no install
3752: [...]
3753: <code class="prompt">$</code> bmake print-PLIST >PLIST
3754: <code class="prompt">$</code> bmake deinstall
3755: <code class="prompt">$</code> bmake install
3756: </pre>
3757: </div>
3758: </div>
3759: </div>
3760: </div>
1.41 asau 3761: <div class="chapter">
1.1 dsieger 3762: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3763: <a name="components"></a>Chapter 13. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3764: <div class="toc">
3765: <p><b>Table of Contents</b></p>
1.100 leot 3766: <dl class="toc">
1.154 rillig 3767: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
3768: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
3769: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
3770: <dd><dl>
3771: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
3772: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
3773: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
3774: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
3775: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
3776: </dl></dd>
3777: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
3778: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
3779: <dd><dl>
3780: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
3781: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
3782: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3783: </dl></dd>
1.154 rillig 3784: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
3785: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3786: </dl>
3787: </div>
3788: <p>Whenever you're preparing a package, there are a number of
3789: files involved which are described in the following
3790: sections.</p>
1.41 asau 3791: <div class="sect1">
1.1 dsieger 3792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3793: <a name="components.Makefile"></a>13.1. <code class="filename">Makefile</code>
1.1 dsieger 3794: </h2></div></div></div>
3795: <p>Building, installation and creation of a binary package are all
3796: controlled by the package's <code class="filename">Makefile</code>.
3797: The <code class="filename">Makefile</code> describes various things about
3798: a package, for example from where to get it, how to configure,
3799: build, and install it.</p>
3800: <p>A package <code class="filename">Makefile</code> contains several
3801: sections that describe the package.</p>
3802: <p>In the first section there are the following variables, which
3803: should appear exactly in the order given here. The order and
3804: grouping of the variables is mostly historical and has no further
3805: meaning.</p>
1.41 asau 3806: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3807: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 3808: distribution file to be downloaded from the package's
3809: website.</p></li>
1.23 wiz 3810: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66 asau 3811: package, as used by pkgsrc. You need to provide it if
1.1 dsieger 3812: <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66 asau 3813: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3814: provided (no distribution file is required). Usually it is the pkgsrc
1.1 dsieger 3815: directory name together with the version number. It must match the
3816: regular expression
3817: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3818: starts with a letter or digit, and contains only letters, digits,
3819: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 3820: <li class="listitem">
1.1 dsieger 3821: <p><code class="varname">CATEGORIES</code> is a list of categories
3822: which the package fits in. You can choose any of the top-level
3823: directories of pkgsrc for it.</p>
3824: <p>Currently the following values are available for
3825: <code class="varname">CATEGORIES</code>. If more than
3826: one is used, they need to be separated by spaces:</p>
3827: <pre class="programlisting">
3828: archivers cross geography meta-pkgs security
3829: audio databases graphics misc shells
3830: benchmarks devel ham multimedia sysutils
3831: biology editors inputmethod net textproc
3832: cad emulators lang news time
3833: chat finance mail parallel wm
3834: comms fonts math pkgtools www
3835: converters games mbone print x11
3836: </pre>
3837: </li>
1.23 wiz 3838: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 3839: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3840: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3841: and <code class="varname">DISTFILES</code> are discussed in detail in
1.154 rillig 3842: <a class="xref" href="#build.fetch" title="19.5. The fetch phase">Section 19.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.1 dsieger 3843: </ul></div>
3844: <p>The second section contains information about separately
3845: downloaded patches, if any.
3846: </p>
1.41 asau 3847: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80 wiz 3848: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1 dsieger 3849: Name(s) of additional files that contain distribution patches.
3850: There is no default. pkgsrc will look for them at
3851: <code class="varname">PATCH_SITES</code>.
3852: They will automatically be uncompressed before patching if
3853: the names end with <code class="filename">.gz</code> or
3854: <code class="filename">.Z</code>.</p></li>
1.23 wiz 3855: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 3856: Primary location(s) for distribution patch files (see
1.80 wiz 3857: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3858: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.174 leot 3859: an argument to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.80 wiz 3860: help find the correct files to patch. It defaults to
3861: <span class="command"><strong>-p0</strong></span>.</p></li>
1.1 dsieger 3862: </ul></div>
3863: <p>The third section contains the following variables.
3864: </p>
1.41 asau 3865: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3866: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 3867: address of the person who feels responsible for this package,
3868: and who is most likely to look at problems or questions regarding
1.174 leot 3869: this package which have been reported with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.14 jmcneill 3870: Other developers may contact the <code class="varname">MAINTAINER</code>
3871: before making changes to the package, but are not required to
3872: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3873: to yourself. If you really can't maintain the package for future
3874: updates, set it to
1.10 hubertf 3875: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 3876: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 3877: of <code class="varname">MAINTAINER</code> when you do not want other
3878: developers to update or change the package without contacting
3879: you first. A package Makefile should contain one of
3880: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
3881: not both. </p></li>
1.23 wiz 3882: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 3883: find more information about the package.</p></li>
1.23 wiz 3884: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 3885: description of the package (should not include the package
3886: name).</p></li>
1.122 leot 3887: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.154 rillig 3888: applicable for the package. See <a class="xref" href="#handling-licenses" title="21.1.3. Handling licenses">Section 21.1.3, “Handling licenses”</a> for further details.</p></li>
1.1 dsieger 3889: </ul></div>
3890: <p>Other variables that affect the build:
3891: </p>
1.41 asau 3892: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 3893: <p><code class="varname">WRKSRC</code>: The directory where the
3894: interesting distribution files of the package are found. The
3895: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3896: works for most packages.</p>
3897: <p>If a package doesn't create a subdirectory for itself
3898: (most GNU software does, for instance), but extracts itself in
3899: the current directory, you should set
3900: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3901: <p>If a package doesn't create a subdirectory with the
3902: name of <code class="varname">DISTNAME</code> but some different name,
3903: set <code class="varname">WRKSRC</code> to point to the proper name in
3904: <code class="filename">${WRKDIR}</code>, for example
3905: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.137 leot 3906: <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.1 dsieger 3907: <p>The name of the working directory created by pkgsrc is
3908: taken from the <code class="varname">WRKDIR_BASENAME</code>
3909: variable. By default, its value is
3910: <code class="filename">work</code>. If you want to use the same
3911: pkgsrc tree for building different kinds of binary packages,
3912: you can change the variable according to your needs. Two
3913: other variables handle common cases of setting
3914: <code class="varname">WRKDIR_BASENAME</code> individually. If
3915: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 3916: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 3917: the host's name is attached to the directory name. If
3918: <code class="varname">OBJMACHINE</code> is defined, the platform name
3919: is attached, which might look like
3920: <code class="filename">work.i386</code> or
3921: <code class="filename">work.sparc</code>.</p>
3922: </li></ul></div>
3923: <p>Please pay attention to the following gotchas:</p>
1.41 asau 3924: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3925: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 3926: installed in compressed form by the package. For packages using
3927: BSD-style makefiles which honor MANZ, there is
3928: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 3929: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3930: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 3931: below).</p></li>
1.154 rillig 3932: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.7. Packages installing info files">Section 21.6.7, “Packages installing info files”</a>.</p></li>
1.1 dsieger 3933: </ul></div>
3934: </div>
1.41 asau 3935: <div class="sect1">
1.1 dsieger 3936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3937: <a name="components.distinfo"></a>13.2. <code class="filename">distinfo</code>
1.1 dsieger 3938: </h2></div></div></div>
3939: <p>The <code class="filename">distinfo</code> file contains the message
3940: digest, or checksum, of each distfile needed for the package. This
3941: ensures that the distfiles retrieved from the Internet have not been
3942: corrupted during transfer or altered by a malign force to introduce
1.108 rillig 3943: a security hole. To provide maximum security, all distfiles are
3944: protected using three different message digest algorithms (SHA1,
3945: RMD160, SHA512), as well as the file size.</p>
1.1 dsieger 3946: <p>The <code class="filename">distinfo</code> file also contains the
3947: checksums for all the patches found in the
1.154 rillig 3948: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, “<code class="filename">patches/*</code>”</a>). These checksums ensure that patches
1.145 leot 3949: are only applied intentionally and that they don't accidentally change,
3950: e.g. when merging different changes together. They also make sure that
3951: new patches are actually added to CVS and old ones are removed.
3952: Too see whether the patches and the <code class="filename">distinfo</code> file
3953: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.1 dsieger 3954: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108 rillig 3955: <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1 dsieger 3956: <p>Some packages have different sets of distfiles depending on
1.178 rillig 3957: the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/README.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
1.1 dsieger 3958: <code class="filename">distinfo</code> file and care should be taken when
3959: upgrading such a package to ensure distfile information is not
3960: lost.</p>
3961: </div>
1.41 asau 3962: <div class="sect1">
1.1 dsieger 3963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3964: <a name="components.patches"></a>13.3. <code class="filename">patches/*</code>
1.108 rillig 3965: </h2></div></div></div>
3966: <p>Some packages don't work out-of-the box on the various
3967: platforms that are supported by pkgsrc. These packages need
3968: to be patched to make them work. The patch files can be
1.1 dsieger 3969: found in the <code class="filename">patches/</code> directory.</p>
3970: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3971: applied to the files in <code class="varname">WRKSRC</code> directory after
1.108 rillig 3972: extracting them, in alphabetic order.</p>
1.41 asau 3973: <div class="sect2">
1.1 dsieger 3974: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 3975: <a name="components.patch.structure"></a>13.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 3976: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 3977: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 3978: problems. (To force patches to apply with fuzz you can set
3979: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3980: should contain only changes for a single file, and no file should be
3981: patched by more than one patch file. This helps to keep future
3982: modifications simple.</p>
3983: <p>Each patch file is structured as follows: In the first line,
3984: there is the RCS Id of the patch itself. The second line should be
3985: empty for aesthetic reasons. After that, there should be a comment for
3986: each change that the patch does. There are a number of standard
3987: cases:</p>
1.41 asau 3988: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3989: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 3990: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 3991: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 3992: platform and other environment (for example, the compiler) that the
3993: patch is needed for.</p></li>
3994: </ul></div>
1.108 rillig 3995: <p>The patch should be commented so that any
1.1 dsieger 3996: developer who knows the code of the application can make some use of
3997: the patch. Special care should be taken for the upstream developers,
3998: since we generally want that they accept our patches, so we have less
3999: work in the future.</p>
4000: </div>
1.41 asau 4001: <div class="sect2">
1.1 dsieger 4002: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4003: <a name="components.patches.caveats"></a>13.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4004: <p>One important thing to mention is to pay attention that no RCS
4005: IDs get stored in the patch files, as these will cause problems when
4006: later checked into the NetBSD CVS tree. Use the
1.137 leot 4007: <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.1 dsieger 4008: problems.</p>
4009: <p>For even more automation, we recommend using
1.10 hubertf 4010: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 4011: whole set of patches. You just have to backup files before you
4012: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 4013: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4014: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 4015: you upgrade a package this way, you can easily compare the new
4016: set of patches with the previously existing one with
1.24 wiz 4017: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4018: are replaced by new files, so carefully check if you want to take all
4019: the changes.</p>
1.1 dsieger 4020: <p>When you have finished a package, remember to generate
1.10 hubertf 4021: the checksums for the patch files by using the <span class="command"><strong>make
1.154 rillig 4022: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="13.2. distinfo">Section 13.2, “<code class="filename">distinfo</code>”</a>.</p>
1.1 dsieger 4023: <p>When adding a patch that corrects a problem in the
4024: distfile (rather than e.g. enforcing pkgsrc's view of where
4025: man pages should go), send the patch as a bug report to the
4026: maintainer. This benefits non-pkgsrc users of the package,
4027: and usually makes it possible to remove the patch in future
4028: version.</p>
1.2 rillig 4029: <p>The file names of the patch files are usually of the form
1.24 wiz 4030: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4031: Many packages still use the previous convention
4032: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4033: but new patches should be of the form containing the filename.
1.137 leot 4034: <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.24 wiz 4035: automatically.</p>
1.1 dsieger 4036: </div>
1.41 asau 4037: <div class="sect2">
1.1 dsieger 4038: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4039: <a name="components.patches.sources"></a>13.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4040: <p>If you want to share patches between multiple packages
4041: in pkgsrc, e.g. because they use the same distfiles, set
4042: <code class="varname">PATCHDIR</code> to the path where the patch files
4043: can be found, e.g.:</p>
4044: <pre class="programlisting">
1.159 rillig 4045: PATCHDIR= ../../editors/xemacs/patches
1.1 dsieger 4046: </pre>
4047: <p>Patch files that are distributed by the author or other
4048: maintainers can be listed in
4049: <code class="varname">PATCHFILES</code>.</p>
4050: <p>If it is desired to store any patches that should not be
4051: committed into pkgsrc, they can be kept outside the pkgsrc
4052: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4053: directory tree there is expected to have the same
1.23 wiz 4054: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 4055: patches are expected to be stored inside these dirs (also
4056: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4057: example, if you want to keep a private patch for
4058: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4059: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4060: files in the named directory are expected to be patch files,
4061: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4062: applied</em></span>.</p>
4063: </div>
1.41 asau 4064: <div class="sect2">
1.1 dsieger 4065: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4066: <a name="components.patches.guidelines"></a>13.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4067: <p>When fixing a portability issue in the code do not use
4068: preprocessor magic to check for the current operating system nor
4069: platform. Doing so hurts portability to other platforms because
4070: the OS-specific details are not abstracted appropriately.</p>
4071: <p>The general rule to follow is: instead of checking for the
4072: operating system the application is being built on, check for the
4073: specific <span class="emphasis"><em>features</em></span> you need. For example,
4074: instead of assuming that kqueue is available under NetBSD and
4075: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 4076: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4077: yes, this generally involves patching the
1.10 hubertf 4078: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 4079: that prevents some OSes from adopting interfaces from other OSes
4080: (e.g. Linux implementing kqueue), something that the above checks
4081: cannot take into account.</p>
4082: <p>Of course, checking for features generally involves more
4083: work on the developer's side, but the resulting changes are
4084: cleaner and there are chances they will work on many other
4085: platforms. Not to mention that there are higher chances of being
4086: later integrated into the mainstream sources. Remember:
4087: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4088: <p>Some typical examples:</p>
4089: <div class="table">
1.154 rillig 4090: <a name="patch-examples"></a><p class="title"><b>Table 13.1. Patching examples</b></p>
1.106 tnn 4091: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1 dsieger 4092: <colgroup>
4093: <col>
4094: <col>
4095: <col>
4096: </colgroup>
4097: <thead><tr>
4098: <th>Where</th>
4099: <th>Incorrect</th>
4100: <th>Correct</th>
4101: </tr></thead>
4102: <tbody>
4103: <tr>
4104: <td>configure script</td>
4105: <td>
4106: <pre class="programlisting">
4107: case ${target_os} in
4108: netbsd*) have_kvm=yes ;;
4109: *) have_kvm=no ;;
4110: esac
4111: </pre>
4112: </td>
4113: <td>
4114: <pre class="programlisting">
4115: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4116: </pre>
4117: </td>
4118: </tr>
4119: <tr>
4120: <td>C source file</td>
4121: <td>
4122: <pre class="programlisting">
4123: #if defined(__NetBSD__)
4124: # include <sys/event.h>
4125: #endif
4126: </pre>
4127: </td>
4128: <td>
4129: <pre class="programlisting">
4130: #if defined(HAVE_SYS_EVENT_H)
4131: # include <sys/event.h>
4132: #endif
4133: </pre>
4134: </td>
4135: </tr>
4136: <tr>
4137: <td>C source file</td>
4138: <td>
4139: <pre class="programlisting">
4140: int
4141: monitor_file(...)
4142: {
4143: #if defined(__NetBSD__)
4144: int fd = kqueue();
4145: ...
4146: #else
4147: ...
4148: #endif
4149: }
4150: </pre>
4151: </td>
4152: <td>
4153: <pre class="programlisting">
4154: int
4155: monitor_file(...)
4156: {
4157: #if defined(HAVE_KQUEUE)
4158: int fd = kqueue();
4159: ...
4160: #else
1.112 rillig 4161: ...
1.1 dsieger 4162: #endif
4163: }
4164: </pre>
4165: </td>
4166: </tr>
4167: </tbody>
4168: </table></div>
4169: </div>
1.141 maya 4170: <br class="table-break">
1.1 dsieger 4171: </div>
1.41 asau 4172: <div class="sect2">
1.1 dsieger 4173: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4174: <a name="components.patches.feedback"></a>13.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4175: <p>Always, always, <span class="strong"><strong>always</strong></span>
4176: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4177: improvements you do to a package to the mainstream developers.
4178: This is the only way to get their attention on portability issues
4179: and to ensure that future versions can be built out-of-the box on
4180: NetBSD. Furthermore, any user that gets newer distfiles will get
4181: the fixes straight from the packaged code.</p>
4182: <p>This generally involves cleaning up the patches
4183: (because sometimes the patches that are
1.40 wiz 4184: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 4185: appropriate trackers for the projects and working with the
4186: mainstream authors to accept your changes. It is
4187: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4188: the packages in pkgsrc are kept simple and thus further changes
4189: can be done without much hassle.</p>
1.24 wiz 4190: <p>When you have done this, please add a URL to the upstream
4191: bug report to the patch comment.</p>
1.1 dsieger 4192: <p>Support the idea of free software!</p>
4193: </div>
4194: </div>
1.41 asau 4195: <div class="sect1">
1.1 dsieger 4196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4197: <a name="other-mandatory-files"></a>13.4. Other mandatory files</h2></div></div></div>
1.41 asau 4198: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4199: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4200: <dd><p>A multi-line description of the piece of software. This should include
4201: any credits where they are due. Please bear in mind that others do not
4202: share your sense of humour (or spelling idiosyncrasies), and that others
4203: will read everything that you write here.</p></dd>
4204: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4205: <dd><p>This file governs the files that are installed on your
4206: system: all the binaries, manual pages, etc. There are other
4207: directives which may be entered in this file, to control the
4208: creation and deletion of directories, and the location of
1.154 rillig 4209: inserted files. See <a class="xref" href="#plist" title="Chapter 15. PLIST issues">Chapter 15, <i>PLIST issues</i></a> for more
1.1 dsieger 4210: information.</p></dd>
4211: </dl></div>
4212: </div>
1.41 asau 4213: <div class="sect1">
1.1 dsieger 4214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4215: <a name="components.optional"></a>13.5. Optional files</h2></div></div></div>
1.41 asau 4216: <div class="sect2">
1.1 dsieger 4217: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4218: <a name="components.optional.bin"></a>13.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 4219: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4220: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 4221: <dd>
1.174 leot 4222: <p>This shell script is invoked twice by <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 4223: First time after package extraction and before files are
4224: moved in place, the second time after the files to install
4225: are moved in place. This can be used to do any custom
4226: procedures not possible with @exec commands in
1.174 leot 4227: <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4228: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.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="17.1. Files and directories outside the installation prefix">Section 17.1, “Files and directories outside the installation prefix”</a>.
1.28 wiz 4229: Please note that you can modify variables in it easily by using
4230: <code class="varname">FILES_SUBST</code> in the package's
4231: <code class="filename">Makefile</code>:</p>
4232: <pre class="programlisting">
4233: FILES_SUBST+= SOMEVAR="somevalue"
4234: </pre>
4235: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4236: <code class="filename">INSTALL</code>. By default, substitution is
4237: performed for <code class="varname">PREFIX</code>,
4238: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4239: <code class="varname">VARBASE</code>, and a few others, type
4240: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4241: complete list.</p>
4242: </dd>
1.1 dsieger 4243: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4244: <dd><p>This script is executed before and after any files are removed. It is
4245: this script's responsibility to clean up any additional messy details
4246: around the package's installation, since all pkg_delete knows is how to
4247: delete the files created in the original distribution.
1.174 leot 4248: See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4249: and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.28 wiz 4250: The same methods to replace variables can be used as for
4251: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4252: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4253: <dd>
4254: <p>This file is displayed after installation of the package.
4255: Useful for things like legal notices on almost-free
4256: software and hints for updating config files after
4257: installing modules for apache, PHP etc.
4258: Please note that you can modify variables in it easily by using
4259: <code class="varname">MESSAGE_SUBST</code> in the package's
4260: <code class="filename">Makefile</code>:</p>
4261: <pre class="programlisting">
4262: MESSAGE_SUBST+= SOMEVAR="somevalue"
4263: </pre>
1.23 wiz 4264: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4265: <code class="filename">MESSAGE</code>. By default, substitution is
4266: performed for <code class="varname">PKGNAME</code>,
4267: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99 sevan 4268: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1 dsieger 4269: <code class="varname">PKG_SYSCONFDIR</code>,
4270: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4271: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4272: <p>You can display a different or additional files by
4273: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4274: default is <code class="filename">MESSAGE</code>, if the file
4275: exists.</p>
4276: </dd>
4277: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66 asau 4278: <dd>
4279: <p>This file is used by the alternatives framework.
4280: It creates, configures, and destroys generic wrappers used to
4281: run programs with similar interfaces.
4282: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4283: for more information.</p>
4284: <p>Each line of the file contains two filenames, first
4285: the wrapper and then the alternative provided by the package.
4286: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4287: </dd>
1.1 dsieger 4288: </dl></div>
4289: </div>
1.41 asau 4290: <div class="sect2">
1.1 dsieger 4291: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4292: <a name="components.optional.build"></a>13.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4293: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4294: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4295: <dd><p>This file contains arbitrary things that could
4296: also go into a <code class="filename">Makefile</code>, but its purpose is
4297: to be used by more than one package. This file should only be
4298: used when the packages that will use the file are known in
4299: advance. For other purposes it is often better to write a
4300: <code class="filename">*.mk</code> file and give it a good name that
4301: describes what it does.</p></dd>
4302: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4303: <dd><p>This file contains the dependency information
1.154 rillig 4304: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p></dd>
1.1 dsieger 4305: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4306: <dd><p>This file contains workarounds for compiler bugs
4307: and similar things. It is included automatically by the pkgsrc
4308: infrastructure, so you don't need an extra
4309: <code class="literal">.include</code> line for
4310: it.</p></dd>
4311: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4312: <dd><p>This file contains the code for the
1.154 rillig 4313: package-specific options (see <a class="xref" href="#options" title="Chapter 18. Options handling">Chapter 18, <i>Options handling</i></a>) that can be
1.1 dsieger 4314: selected by the user. If a package has only one or two options,
4315: it is equally acceptable to put the code directly into the
4316: <code class="filename">Makefile</code>.</p></dd>
4317: </dl></div>
4318: </div>
1.41 asau 4319: <div class="sect2">
1.1 dsieger 4320: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4321: <a name="components.optional.none"></a>13.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4322: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4323: <dt><span class="term"><code class="filename">README*</code></span></dt>
4324: <dd><p>These files do not take place in the creation of
4325: a package and thus are purely informative to the package
4326: developer.</p></dd>
4327: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4328: <dd><p>This file contains things that need to be done
4329: to make the package even
4330: better.</p></dd>
4331: </dl></div>
4332: </div>
4333: </div>
1.41 asau 4334: <div class="sect1">
1.1 dsieger 4335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4336: <a name="work-dir"></a>13.6. <code class="filename">work*</code>
1.1 dsieger 4337: </h2></div></div></div>
1.10 hubertf 4338: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4339: unpacked into the directory denoted by
4340: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4341: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4342: directory is also used to keep various timestamp files.
4343: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4344: The default is <code class="filename">${.CURDIR}/work</code>
4345: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4346: if <code class="varname">OBJMACHINE</code> is set.</p>
4347: </div>
1.41 asau 4348: <div class="sect1">
1.1 dsieger 4349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4350: <a name="files-dir"></a>13.7. <code class="filename">files/*</code>
1.1 dsieger 4351: </h2></div></div></div>
1.172 rillig 4352: <p>If you have any files that you wish to be placed in the package
4353: prior to configuration or building, you can place these files here
4354: and use a <span class="command"><strong>${CP}</strong></span> command in the
4355: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
1.1 dsieger 4356: <p>If you want to share files in this way with other
4357: packages, set the <code class="varname">FILESDIR</code> variable to point
4358: to the other package's <code class="filename">files</code> directory,
4359: e.g.:</p>
4360: <pre class="programlisting">
1.159 rillig 4361: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4362: </pre>
4363: </div>
4364: </div>
1.41 asau 4365: <div class="chapter">
1.1 dsieger 4366: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4367: <a name="makefile"></a>Chapter 14. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4368: <div class="toc">
4369: <p><b>Table of Contents</b></p>
1.100 leot 4370: <dl class="toc">
1.154 rillig 4371: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
4372: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
4373: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
4374: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
4375: <dd><dl>
4376: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
4377: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
4378: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
4379: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.1 dsieger 4380: </dl></dd>
4381: </dl>
4382: </div>
4383: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4384: each of which forms a well-defined part of the pkgsrc system. Using
1.174 leot 4385: the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1 dsieger 4386: like pkgsrc requires some discipline to keep the code correct and
4387: understandable.</p>
4388: <p>The basic ingredients for <code class="filename">Makefile</code>
1.154 rillig 4389: programming are variables and shell
1.1 dsieger 4390: commands. Among these shell commands may even be more complex ones
1.174 leot 4391: like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1 dsieger 4392: as intended it is necessary to quote all variables correctly when they
4393: are used.</p>
1.154 rillig 4394: <p>This chapter describes some patterns that appear quite often in
1.1 dsieger 4395: <code class="filename">Makefile</code>s, including the pitfalls that come along
4396: with them.</p>
1.41 asau 4397: <div class="sect1">
1.1 dsieger 4398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4399: <a name="makefile.style"></a>14.1. Caveats</h2></div></div></div>
1.41 asau 4400: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4401: <p>When you are creating a file as a
4402: target of a rule, always write the data to a temporary file first
4403: and finally rename that file. Otherwise there might occur an error
4404: in the middle of generating the file, and when the user runs
1.174 leot 4405: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.1 dsieger 4406: regenerated properly. Example:</p>
4407: <pre class="programlisting">
4408: wrong:
4409: @echo "line 1" > ${.TARGET}
4410: @echo "line 2" >> ${.TARGET}
4411: @false
4412:
4413: correct:
4414: @echo "line 1" > ${.TARGET}.tmp
4415: @echo "line 2" >> ${.TARGET}.tmp
4416: @false
4417: @mv ${.TARGET}.tmp ${.TARGET}
4418: </pre>
1.10 hubertf 4419: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4420: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4421: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4422: correct</strong></span> gives an error message twice, as expected.</p>
1.174 leot 4423: <p>You might remember that <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1 dsieger 4424: <code class="literal">${.TARGET}</code> in case of error, but this only
4425: happens when it is interrupted, for example by pressing
1.154 rillig 4426: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.174 leot 4427: when one of the commands fails (like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1 dsieger 4428: </li></ul></div>
4429: </div>
1.41 asau 4430: <div class="sect1">
1.1 dsieger 4431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4432: <a name="makefile.variables"></a>14.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4433: <p><code class="filename">Makefile</code> variables contain strings that
1.154 rillig 4434: can be processed using the five operators <code class="code">=</code>,
4435: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.174 leot 4436: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1 dsieger 4437: page.</p>
4438: <p>When a variable's value is parsed from a
1.154 rillig 4439: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
4440: the backslash character <code class="code">\</code> are handled specially. If a
4441: backslash is the last character in a line, that backslash is removed
4442: from the line and the line continues with the next line of the file.</p>
4443: <p>The <code class="code">#</code> character starts a comment that reaches
4444: until the end of the line. To get an actual <code class="code">#</code> character,
4445: such as in a URL, write <code class="code">\#</code> instead.</p>
1.108 rillig 4446: <p>The evaluation of variables either happens immediately or lazy.
1.154 rillig 4447: It happens immediately when the variable occurs on the right-hand
4448: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
1.108 rillig 4449: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
4450: In the other cases, it is evaluated lazily.</p>
1.1 dsieger 4451: <p>Some of the modifiers split the string into words and then
1.154 rillig 4452: operate on the words, others operate on the string as a whole. When a
4453: string is split into words, double quotes and single quotes are
1.174 leot 4454: interpreted as delimiters, just like in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sh+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.41 asau 4455: <div class="sect2">
1.1 dsieger 4456: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4457: <a name="makefile.variables.names"></a>14.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4458: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4459: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4460: are reserved for use by the pkgsrc infrastructure. They shall
1.154 rillig 4461: not be used by packages.</p></li>
1.23 wiz 4462: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4463: lowercase variable names for the iteration
4464: variables.</p></li>
1.154 rillig 4465: <li class="listitem"><p>All list variables should have a plural name,
4466: such as <code class="varname">PKG_OPTIONS</code> or
1.1 dsieger 4467: <code class="varname">DISTFILES</code>.</p></li>
4468: </ul></div>
4469: </div>
4470: </div>
1.41 asau 4471: <div class="sect1">
1.1 dsieger 4472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4473: <a name="makefile.code"></a>14.3. Code snippets</h2></div></div></div>
1.41 asau 4474: <div class="sect2">
1.1 dsieger 4475: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4476: <a name="adding-to-list"></a>14.3.1. Adding things to a list</h3></div></div></div>
1.108 rillig 4477: <p>When adding a string that possibly contains whitespace or quotes to
4478: a list (example 1), it must be quoted using the <code class="code">:Q</code>
4479: modifier.</p>
4480: <p>When adding another list to a list (example 2), it must not be
4481: quoted, since its elements are already quoted.</p>
1.1 dsieger 4482: <pre class="programlisting">
1.108 rillig 4483: STRING= foo * bar `date`
4484: LIST= # empty
4485: ANOTHER_LIST= a=b c=d
4486:
4487: LIST+= ${STRING:Q} # 1
4488: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4489: </pre>
4490: </div>
1.41 asau 4491: <div class="sect2">
1.1 dsieger 4492: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4493: <a name="echo-literal"></a>14.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.108 rillig 4494: <p>Echoing a string containing special characters needs special
4495: work.</p>
1.1 dsieger 4496: <pre class="programlisting">
4497: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 4498: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4499:
4500: all:
4501: echo ${STRING} # 1
1.108 rillig 4502: echo ${STRING:Q} # 2
4503: printf '%s\n' ${STRING:Q}'' # 3
4504: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
4505: </pre>
4506: <p>Example 1 leads to a syntax error in the shell, as the characters
4507: are just copied.</p>
4508: <p>Example 2 quotes the string so that the shell interprets it
4509: correctly. But the echo command may additionally interpret strings with a
4510: leading dash or those containing backslashes.</p>
1.174 leot 4511: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.139 leot 4512: interprets the format string, but not the next argument. The trailing
4513: single quotes handle the case when the string is empty. In that case, the
4514: :Q modifier would result in an empty string too, which would then be
1.174 leot 4515: skipped by the shell. For <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.139 leot 4516: but other programs may care.</p>
1.108 rillig 4517: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
4518: need to be quoted because the quoting has already been done
4519: when adding elements to the list.</p>
1.1 dsieger 4520: </div>
1.41 asau 4521: <div class="sect2">
1.1 dsieger 4522: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4523: <a name="cflags-gnu-configure"></a>14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
1.108 rillig 4524: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
4525: GNU-style configure script (especially those that call other configure
4526: scripts), it must not have leading or trailing whitespace, since
4527: otherwise the configure script gets confused. To trim leading and
4528: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
4529: following example:</p>
1.1 dsieger 4530: <pre class="programlisting">
4531: CPPFLAGS= # empty
1.108 rillig 4532: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
1.1 dsieger 4533: CPPFLAGS+= ${MY_CPPFLAGS}
4534:
4535: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4536:
4537: all:
4538: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
1.108 rillig 4539: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4540: </pre>
1.108 rillig 4541: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
4542: trailing whitespace because the <code class="code">+=</code> operator always adds a
4543: space.</p>
4544: </div>
4545: <div class="sect2">
4546: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4547: <a name="empty-variables"></a>14.3.4. Handling possibly empty variables</h3></div></div></div>
1.108 rillig 4548: <p>When a possibly empty variable is used in a shell program, it may
4549: lead to a syntax error.</p>
4550: <pre class="programlisting">
4551: EGFILES= # empty
4552:
4553: install-examples: # produces a syntax error in the shell
4554: for egfile in ${EGFILES}; do \
4555: echo "Installing $$egfile"; \
4556: done
4557: </pre>
4558: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.174 leot 4559: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.108 rillig 4560: To fix this syntax error, use one of the snippets below.</p>
4561: <pre class="programlisting">
4562: EMPTY= # empty
4563:
4564: install-examples:
4565: for egfile in ${EGFILES} ""; do \
4566: [ -n "$$egfile" ] || continue; \
4567: echo "Installing $$egfile"; \
1.1 dsieger 4568: done
1.108 rillig 4569: </pre>
4570: <p>In this case, an empty string is appended to the iteration list (to
4571: prevent the syntax error) and filtered out later.</p>
4572: <pre class="programlisting">
4573: EGFILES= # empty
1.1 dsieger 4574:
1.108 rillig 4575: install-examples:
4576: .for egfile in ${EGFILES}
4577: echo "Installing ${egfile}"
1.1 dsieger 4578: .endfor
4579: </pre>
1.154 rillig 4580: <p>If one of the filenames contains special characters, it should be
4581: enclosed in single or double quotes.</p>
1.108 rillig 4582: <p>To have a shell command test whether a make variable is empty, use
4583: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1 dsieger 4584: </div>
4585: </div>
4586: </div>
1.41 asau 4587: <div class="chapter">
1.1 dsieger 4588: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4589: <a name="plist"></a>Chapter 15. PLIST issues</h2></div></div></div>
1.1 dsieger 4590: <div class="toc">
4591: <p><b>Table of Contents</b></p>
1.100 leot 4592: <dl class="toc">
1.154 rillig 4593: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
4594: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
4595: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
4596: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
4597: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
4598: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
4599: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
4600: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
4601: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 4602: </dl>
4603: </div>
4604: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 4605: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 4606: the package (relative to the <code class="filename">${PREFIX}</code>
4607: directory it's been installed in) plus some additional statements
1.174 leot 4608: - see the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1 dsieger 4609: This chapter addresses some issues that need attention when
4610: dealing with the <code class="filename">PLIST</code> file (or files, see
4611: below!).</p>
1.41 asau 4612: <div class="sect1">
1.1 dsieger 4613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4614: <a name="rcs-id"></a>15.1. RCS ID</h2></div></div></div>
1.1 dsieger 4615: <p>Be sure to add a RCS ID line as the first thing in any
4616: <code class="filename">PLIST</code> file you write:</p>
4617: <pre class="programlisting">
1.121 sevan 4618: @comment $NetBSD $
1.111 sevan 4619: </pre>
1.123 wiz 4620: <p>An artificial space has been added between NetBSD and $, this is a
1.121 sevan 4621: workaround here to prevent CVS expanding to the filename of the guide. When
1.125 leot 4622: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 4623: </div>
1.41 asau 4624: <div class="sect1">
1.1 dsieger 4625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4626: <a name="automatic-plist-generation"></a>15.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 4627: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 4628: to output a PLIST that matches any new files since the package
1.154 rillig 4629: was extracted. See <a class="xref" href="#build.helpful-targets" title="19.17. Other helpful targets">Section 19.17, “Other helpful targets”</a> for
1.1 dsieger 4630: more information on this target.</p>
4631: </div>
1.41 asau 4632: <div class="sect1">
1.1 dsieger 4633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4634: <a name="print-PLIST"></a>15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 4635: </h2></div></div></div>
4636: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
4637: of AWK patterns and actions that are used to filter the output of
4638: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
4639: scripting you like to it, but be careful with quoting.</p>
4640: <p>For example, to get all files inside the
4641: <code class="filename">libdata/foo</code> directory removed from the
4642: resulting PLIST:</p>
4643: <pre class="programlisting">
4644: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.111 sevan 4645: </pre>
1.1 dsieger 4646: </div>
1.41 asau 4647: <div class="sect1">
1.1 dsieger 4648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4649: <a name="plist.misc"></a>15.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 4650: <p>A number of variables are substituted automatically in
4651: PLISTs when a package is installed on a system. This includes the
4652: following variables:</p>
1.41 asau 4653: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4654: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
4655: <dd>
4656: <p>Some packages like emacs and perl embed information
4657: about which architecture they were built on into the
4658: pathnames where they install their files. To handle this
4659: case, PLIST will be preprocessed before actually used, and
4660: the symbol
1.23 wiz 4661: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 4662: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 4663: same is done if the string
4664: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
4665: PLIST somewhere - use this on packages that have GNU
4666: autoconf-created configure scripts.</p>
1.41 asau 4667: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 4668: <h3 class="title">Legacy note</h3>
4669: <p>There used to be a symbol
1.23 wiz 4670: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 4671: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 4672: -m</strong></span>, but that's no longer supported and has
4673: been removed.</p>
4674: </div>
4675: </dd>
4676: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
4677: <dd>
4678: <p>Some packages want to embed the OS name and version
4679: into some paths. To do this, use these variables in the
4680: <code class="filename">PLIST</code>:
4681: </p>
1.41 asau 4682: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4683: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">“<span class="quote"><span class="command"><strong>uname -s</strong></span></span>”</span></p></li>
4684: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">“<span class="quote">solaris</span>”</span>)</p></li>
4685: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.1 dsieger 4686: </ul></div>
4687: </dd>
4688: </dl></div>
1.88 tnn 4689: <p>For a list of values which are replaced by
4690: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
4691: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
4692: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1 dsieger 4693: <p>If you want to change other variables not listed above, you
4694: can add variables and their expansions to this variable in the
1.154 rillig 4695: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="13.5. Optional files">Section 13.5, “Optional files”</a>):</p>
1.1 dsieger 4696: <pre class="programlisting">
4697: PLIST_SUBST+= SOMEVAR="somevalue"
1.111 sevan 4698: </pre>
1.23 wiz 4699: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 4700: in the <code class="filename">PLIST</code> with
1.23 wiz 4701: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 4702: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
4703: the common case of conditionally including some
4704: <code class="filename">PLIST</code> entries. It can be done by adding
4705: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
4706: setting the corresponding <code class="varname">PLIST.foo</code> variable
4707: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 4708: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 4709: in the <code class="filename">PLIST</code> with either
1.23 wiz 4710: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
4711: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 4712: For example, in <code class="filename">Makefile</code>:</p>
4713: <pre class="programlisting">
1.112 rillig 4714: PLIST_VARS+= foo
1.18 snj 4715: .if <em class="replaceable"><code>condition</code></em>
1.112 rillig 4716: PLIST.foo= yes
1.18 snj 4717: .else
1.111 sevan 4718: </pre>
1.18 snj 4719: <p>And then in <code class="filename">PLIST</code>:</p>
4720: <pre class="programlisting">
1.121 sevan 4721: @comment $NetBSD $
1.18 snj 4722: bin/bar
4723: man/man1/bar.1
4724: ${PLIST.foo}bin/foo
4725: ${PLIST.foo}man/man1/foo.1
4726: ${PLIST.foo}share/bar/foo.data
1.111 sevan 4727: </pre>
1.123 wiz 4728: <p>An artificial space has been added between NetBSD and $, this is a
1.121 sevan 4729: workaround here to prevent CVS expanding to the filename of the guide. When
4730: adding the RCS ID the space should be ommited.</p>
1.1 dsieger 4731: </div>
1.41 asau 4732: <div class="sect1">
1.1 dsieger 4733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4734: <a name="manpage-compression"></a>15.5. Man page compression</h2></div></div></div>
1.1 dsieger 4735: <p>Man pages should be installed in compressed form if
4736: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
4737: and uncompressed otherwise. To handle this in the
1.23 wiz 4738: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 4739: appended/removed automatically for man pages according to
4740: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
4741: or not, see above for details. This modification of the
4742: <code class="filename">PLIST</code> file is done on a copy of it, not
4743: <code class="filename">PLIST</code> itself.</p>
4744: </div>
1.41 asau 4745: <div class="sect1">
1.1 dsieger 4746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4747: <a name="using-PLIST_SRC"></a>15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 4748: </h2></div></div></div>
4749: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
4750: in generating the binary package, set the variable
4751: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.174 leot 4752: The files are later concatenated using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1 dsieger 4753: important. The default for <code class="varname">PLIST_SRC</code> is
4754: <code class="filename">${PKGDIR}/PLIST</code>.</p>
4755: </div>
1.41 asau 4756: <div class="sect1">
1.1 dsieger 4757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4758: <a name="platform-specific-plist"></a>15.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 4759: <p>Some packages decide to install a different set of files based on
4760: the operating system being used. These differences can be
4761: automatically handled by using the following files:</p>
1.41 asau 4762: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4763: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
4764: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
4765: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
4766: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
4767: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 4768: </ul></div>
4769: </div>
1.41 asau 4770: <div class="sect1">
1.1 dsieger 4771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4772: <a name="build-plist"></a>15.8. Build-specific PLISTs</h2></div></div></div>
1.86 wiz 4773: <p>Some packages decide to generate hard-to-guess file names
4774: during installation that are hard to wire down.</p>
4775: <p>In such cases, you can set the
4776: <code class="varname">GENERATE_PLIST</code> variable to shell code
4777: terminated (with a semicolon) that will output PLIST entries which
4778: will be appended to the PLIST</p>
4779: <p>You can find one example in editors/xemacs:</p>
4780: <pre class="programlisting">
1.111 sevan 4781: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
4782: </pre>
1.86 wiz 4783: <p>which will append something like
4784: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
4785: <code class="filename">PLIST</code>.
4786: </p>
4787: </div>
4788: <div class="sect1">
4789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4790: <a name="faq.common-dirs"></a>15.9. Sharing directories between packages</h2></div></div></div>
1.23 wiz 4791: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 4792: multiple (and unrelated) packages install files. These
1.22 jakllsch 4793: directories were problematic because you had to add special
4794: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 4795: centralized package handle them.</p>
1.22 jakllsch 4796: <p>In pkgsrc, it is now easy: Each package should create
4797: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
4798: will remove any directories left empty after uninstalling a
4799: package.</p>
4800: <p>If a package needs an empty directory to work, create
4801: the directory during installation as usual, and also add an
4802: entry to the PLIST:
1.111 sevan 4803:
4804: </p>
1.1 dsieger 4805: <pre class="programlisting">
1.22 jakllsch 4806: @pkgdir path/to/empty/directory
1.111 sevan 4807: </pre>
1.22 jakllsch 4808: <p>
1.111 sevan 4809:
1.86 wiz 4810: or take a look at <code class="varname">MAKE_DIRS</code> and
4811: <code class="varname">OWN_DIRS</code>.
1.22 jakllsch 4812: </p>
1.1 dsieger 4813: </div>
4814: </div>
1.41 asau 4815: <div class="chapter">
1.1 dsieger 4816: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 4817: <a name="buildlink"></a>Chapter 16. Buildlink methodology</h2></div></div></div>
1.1 dsieger 4818: <div class="toc">
4819: <p><b>Table of Contents</b></p>
1.100 leot 4820: <dl class="toc">
1.154 rillig 4821: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
4822: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4823: <dd><dl>
1.154 rillig 4824: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
4825: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26 wiz 4826: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4827: and
4828: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
4829: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 4830: </dl></dd>
1.154 rillig 4831: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1 dsieger 4832: <dd><dl>
1.154 rillig 4833: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
4834: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1 dsieger 4835: </dl></dd>
4836: </dl>
4837: </div>
4838: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
4839: are seen by a package's configure and build processes. This is implemented
4840: in a two step process:</p>
1.23 wiz 4841: <div class="orderedlist"><ol class="orderedlist" type="1">
4842: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 4843: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
4844: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 4845: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 4846: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
4847: <code class="option">-L${LOCALBASE}/lib</code> into references to
4848: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
4849: native compiler on some operating systems look like GCC, so that
4850: packages that expect GCC won't require modifications to build with
4851: those native compilers.</p></li>
4852: </ol></div>
4853: <p>This normalizes the environment in which a package is built so that the
4854: package may be built consistently despite what other software may be
4855: installed. Please note that the normal system header and library paths,
4856: e.g. <code class="filename">/usr/include</code>,
4857: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
4858: designed to insulate the package build from non-system-supplied
4859: software.</p>
1.41 asau 4860: <div class="sect1">
1.1 dsieger 4861: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4862: <a name="converting-to-buildlink3"></a>16.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 4863: <p>The process of converting packages to use the buildlink3
1.23 wiz 4864: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 4865: The things to keep in mind are:</p>
1.23 wiz 4866: <div class="orderedlist"><ol class="orderedlist" type="1">
4867: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 4868: instead of the actual toolchain. Some packages are tricky,
4869: and the only way to know for sure is the check
4870: <code class="filename">${WRKDIR}/.work.log</code> to see if the
4871: wrappers are being invoked.</p></li>
1.23 wiz 4872: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 4873: the package Makefile, e.g. Java VMs, standalone shells,
4874: etc., because the code to symlink files into
4875: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 4876: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 4877: </p></li>
1.23 wiz 4878: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 4879: <code class="filename">buildlink3.mk</code> files that you list in a
4880: package's Makefile are added as dependencies for that package.
4881: </p></li>
4882: </ol></div>
4883: <p>If a dependency on a particular package is required for its libraries and
4884: headers, then we replace:</p>
4885: <pre class="programlisting">
4886: DEPENDS+= foo>=1.1.0:../../category/foo
4887: </pre>
4888: <p>with</p>
4889: <pre class="programlisting">
4890: .include "../../category/foo/buildlink3.mk"
4891: </pre>
4892: <p>The buildlink3.mk files usually define the required dependencies.
4893: If you need a newer version of the dependency when using buildlink3.mk
4894: files, then you can define it in your Makefile; for example:</p>
4895: <pre class="programlisting">
4896: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4897: .include "../../category/foo/buildlink3.mk"
4898: </pre>
4899: <p>There are several <code class="filename">buildlink3.mk</code>
4900: files in <code class="filename">pkgsrc/mk</code>
4901: that handle special package issues:</p>
1.41 asau 4902: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4903: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 4904: the native or a pkgsrc Berkeley DB implementation based on
4905: the values of <code class="varname">BDB_ACCEPTED</code> and
4906: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 4907: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 4908: comes with neither Curses nor NCurses, this will take care
1.137 leot 4909: 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.23 wiz 4910: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 4911: of <code class="varname">KRB5_ACCEPTED</code> to choose between
4912: adding a dependency on Heimdal or MIT-krb5 for packages that
4913: require a Kerberos 5 implementation.</p></li>
1.23 wiz 4914: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 4915: system-provided Motif installation or adds a dependency on
1.137 leot 4916: <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.23 wiz 4917: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.126 leot 4918: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
4919: to choose which Motif version will be used.</p></li>
1.55 ryoon 4920: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 4921: system-provided GNU readline or editline (libedit) installation,
1.137 leot 4922: 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>,
4923: <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.55 ryoon 4924: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
4925: If your package really needs GNU readline library, its Makefile
4926: should include <code class="filename">devel/readline/buildlink3.mk</code>
4927: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 4928: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 4929: variables that may be used by packages that use the
4930: Open Sound System (OSS) API.</p></li>
1.23 wiz 4931: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 4932: any of the Postgres versions in the variable
4933: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
4934: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 4935: the file for more information.</p></li>
1.23 wiz 4936: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 4937: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.137 leot 4938: 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.23 wiz 4939: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 4940: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
4941: library.</p></li>
4942: </ul></div>
4943: <p>The comments in those <code class="filename">buildlink3.mk</code>
4944: files provide a more complete
4945: description of how to use them properly.</p>
4946: </div>
1.41 asau 4947: <div class="sect1">
1.1 dsieger 4948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 4949: <a name="creating-buildlink3.mk"></a>16.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 4950: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 4951: included by Makefiles to indicate the need to compile and link
4952: against header files and libraries provided by the package. A
4953: <code class="filename">buildlink3.mk</code> file should always provide
4954: enough information to add the correct type of dependency
4955: relationship and include any other
4956: <code class="filename">buildlink3.mk</code> files that it needs to find
4957: headers and libraries that it needs in turn.</p>
4958: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.137 leot 4959: 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.1 dsieger 4960: package is highly recommended. For most packages, the following
4961: command will generate a good starting point for
4962: <code class="filename">buildlink3.mk</code> files:</p>
4963: <pre class="screen">
4964: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
4965: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
4966: </pre>
1.41 asau 4967: <div class="sect2">
1.1 dsieger 4968: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 4969: <a name="anatomy-of-bl3"></a>16.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 4970: <p>The following real-life example
4971: <code class="filename">buildlink3.mk</code> is taken
4972: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
4973: <pre class="programlisting">
1.18 snj 4974: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 4975:
1.112 rillig 4976: BUILDLINK_TREE+= tiff
1.1 dsieger 4977:
1.18 snj 4978: .if !defined(TIFF_BUILDLINK3_MK)
4979: TIFF_BUILDLINK3_MK:=
1.1 dsieger 4980:
1.112 rillig 4981: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4982: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
4983: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 4984:
4985: .include "../../devel/zlib/buildlink3.mk"
4986: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 4987: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 4988:
1.112 rillig 4989: BUILDLINK_TREE+= -tiff
1.1 dsieger 4990: </pre>
4991: <p>The header and footer manipulate
1.18 snj 4992: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 4993: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 4994: the dependency tree.</p>
4995: <p>The main section is protected from multiple inclusion
1.1 dsieger 4996: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
4997: added. Several important variables are set in the section:</p>
1.41 asau 4998: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4999: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5000: is the actual dependency recorded in the installed
5001: package; this should always be set using
1.10 hubertf 5002: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 5003: we're appending to any pre-existing list of values. This
5004: variable should be set to the first version of the
1.26 wiz 5005: package that had an backwards-incompatible API change.
1.1 dsieger 5006: </p></li>
1.23 wiz 5007: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5008: is the location of the <em class="replaceable"><code>pkg</code></em>
5009: pkgsrc directory.</p></li>
1.23 wiz 5010: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5011: (not shown above) controls whether we use
5012: <code class="varname">BUILD_DEPENDS</code> or
5013: <code class="varname">DEPENDS</code> to add the dependency on
5014: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5015: selected by setting
5016: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5017: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 5018: used.</p></li>
1.23 wiz 5019: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5020: and
5021: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5022: (not shown above) are lists of subdirectories of
5023: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5024: to add to the header and library search paths. These
1.23 wiz 5025: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 5026: respectively.</p></li>
1.23 wiz 5027: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5028: (not shown above) is the list of preprocessor flags to add
5029: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 5030: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 5031: should be avoided and instead be handled using
5032: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5033: above.</p></li>
5034: </ul></div>
5035: <p>The following variables are all optionally defined within
5036: this second section (protected against multiple inclusion) and
5037: control which package files are symlinked into
5038: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5039: transformed during the symlinking:</p>
1.41 asau 5040: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5041: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5042: (not shown above) is a shell glob pattern relative to
5043: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5044: to be symlinked into
5045: <code class="filename">${BUILDLINK_DIR}</code>,
5046: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 5047: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5048: (not shown above) is a shell pipeline that
5049: outputs to stdout a list of files relative to
5050: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5051: The resulting files are to be symlinked
5052: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5053: this takes the <code class="filename">+CONTENTS</code> of a
5054: <em class="replaceable"><code>pkg</code></em> and filters it through
5055: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 5056: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5057: (not shown above) is a filter command that filters
5058: <code class="filename">+CONTENTS</code> input into a list of files
5059: relative to
5060: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84 wiz 5061: on stdout. By default,
1.1 dsieger 5062: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5063: outputs the contents of the <code class="filename">include</code>
5064: and <code class="filename">lib</code> directories in the package
1.84 wiz 5065: <code class="filename">+CONTENTS</code>.</p></li>
1.23 wiz 5066: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5067: (not shown above) is a list of sed arguments used to
5068: transform the name of the source filename into a
1.10 hubertf 5069: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 5070: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5071: </ul></div>
1.18 snj 5072: <p>This section can additionally include any
1.1 dsieger 5073: <code class="filename">buildlink3.mk</code> needed for
5074: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5075: Including these <code class="filename">buildlink3.mk</code> files
5076: means that the headers and libraries for these
5077: dependencies are also symlinked into
5078: <code class="filename">${BUILDLINK_DIR}</code>
5079: whenever the <em class="replaceable"><code>pkg</code></em>
5080: <code class="filename">buildlink3.mk</code>
1.18 snj 5081: file is included. Dependencies are only added for directly
5082: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 5083: <p>When providing a <code class="filename">buildlink3.mk</code> and
5084: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 5085: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 5086: header files are automatically exposed when the package is
5087: use.</p>
5088: <p>In particular, if only an executable
5089: (<code class="filename">bin/foo</code>) is linked against a library, that
5090: library does not need to be propagated in the
5091: <code class="filename">buildlink3.mk</code> file.</p>
5092: <p>The following steps should help you decide if a
5093: <code class="filename">buildlink3.mk</code> file needs to be included:
5094: </p>
5095: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5096: <li class="listitem"><p>Look at the installed header files: What
5097: headers do they include? The packages providing these files
5098: must be buildlinked.</p></li>
1.49 wiz 5099: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5100: libraries and look against what other libraries they link.
5101: Some of the packages providing these probably need to be
5102: buildlinked; however, it's not automatic, since e.g. GTK on
5103: some systems pulls in the X libraries, so they will show up in
5104: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 5105: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 5106: used as a hint.</p></li>
1.47 wiz 5107: </ul></div>
5108: <p>
5109: </p>
1.1 dsieger 5110: </div>
1.41 asau 5111: <div class="sect2">
1.1 dsieger 5112: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5113: <a name="updating-buildlink-depends"></a>16.2.2. Updating
1.1 dsieger 5114: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5115: and
5116: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5117: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5118: <p>These two variables differ in that one describes source
5119: compatibility (API) and the other binary compatibility (ABI).
5120: The difference is that a change in the API breaks compilation of
5121: programs while changes in the ABI stop compiled programs from
5122: running.</p>
5123: <p>Changes to the
1.27 wiz 5124: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5125: variable in a <code class="filename">buildlink3.mk</code> file happen
5126: very rarely. One possible reason is that all packages depending
5127: on this already need a newer version. In case it is bumped see
5128: the description below.</p>
5129: <p>The most common example of an ABI change is that the major
5130: version of a shared library is increased. In this case,
5131: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5132: should be adjusted to require at least the new package version.
5133: Then the packages that depend on this package need their
5134: <code class="varname">PKGREVISION</code>s increased and, if they have
5135: <code class="filename">buildlink3.mk</code> files, their
5136: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5137: adjusted, too. This is needed so pkgsrc will require the correct
5138: package dependency and not settle for an older one when building
5139: the source.</p>
1.154 rillig 5140: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for
1.26 wiz 5141: more information about dependencies on other packages,
5142: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 5143: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5144: <p>Please take careful consideration before adjusting
5145: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5146: or
5147: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5148: as we don't want to cause unneeded package deletions and
5149: rebuilds. In many cases, new versions of packages work just
5150: fine with older dependencies.</p>
5151: <p>Also it is not needed to set
1.26 wiz 5152: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5153: when it is identical to
1.1 dsieger 5154: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5155: </div>
5156: </div>
1.41 asau 5157: <div class="sect1">
1.1 dsieger 5158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5159: <a name="writing-builtin.mk"></a>16.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5160: <p>Some packages in pkgsrc install headers and libraries that
5161: coincide with headers and libraries present in the base system.
5162: Aside from a <code class="filename">buildlink3.mk</code> file, these
5163: packages should also include a <code class="filename">builtin.mk</code>
5164: file that includes the necessary checks to decide whether using
5165: the built-in software or the pkgsrc software is
5166: appropriate.</p>
5167: <p>The only requirements of a builtin.mk file for
5168: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 5169: <div class="orderedlist"><ol class="orderedlist" type="1">
5170: <li class="listitem"><p>It should set
1.1 dsieger 5171: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5172: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 5173: after it is included.</p></li>
1.23 wiz 5174: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 5175: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5176: which is already set before the
5177: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 5178: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 5179: is <span class="emphasis"><em>very</em></span> important and takes careful
5180: attention to <code class="filename">Makefile</code> coding.</p></li>
5181: </ol></div>
1.41 asau 5182: <div class="sect2">
1.1 dsieger 5183: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5184: <a name="anatomy-of-builtin.mk"></a>16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.1 dsieger 5185: <p>The following is the recommended template for builtin.mk
5186: files:</p>
5187: <pre class="programlisting">
5188: .if !defined(IS_BUILTIN.foo)
5189: #
5190: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5191: # genuinely exists in the system or not.
5192: #
5193: IS_BUILTIN.foo?= no
5194:
5195: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5196: # version can be determined.
5197: #
5198: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5199: BUILTIN_PKG.foo?= foo-1.0
5200: . endif
5201: .endif # IS_BUILTIN.foo
5202:
5203: .if !defined(USE_BUILTIN.foo)
5204: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5205: . if defined(BUILTIN_PKG.foo)
5206: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5207: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5208: USE_BUILTIN.foo!= \
5209: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5210: && ${ECHO} "yes" || ${ECHO} "no"
5211: . endif
5212: . endfor
5213: . endif
5214: .endif # USE_BUILTIN.foo
5215:
5216: CHECK_BUILTIN.foo?= no
5217: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5218: #
5219: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5220: # "yes" or "no".
5221: #
5222: .endif # CHECK_BUILTIN.foo
5223: </pre>
5224: <p>The first section sets
5225: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5226: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5227: in the base system. This should not be a base system software
5228: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 5229: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 5230: included as part of the base system. This variable is only
5231: used internally within the <code class="filename">builtin.mk</code>
5232: file.</p>
5233: <p>The second section sets
5234: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5235: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5236: system if it exists (if
5237: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5238: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 5239: within the <code class="filename">builtin.mk</code> file.</p>
5240: <p>The third section sets
5241: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5242: and is <span class="emphasis"><em>required</em></span> in all
5243: <code class="filename">builtin.mk</code> files. The code in this
5244: section must make the determination whether the built-in
5245: software is adequate to satisfy the dependencies listed in
5246: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5247: This is typically done by comparing
5248: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5249: against each of the dependencies in
5250: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5251: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5252: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5253: end of the <code class="filename">builtin.mk</code> file. Note that
5254: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5255: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5256: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5257: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5258: that the built-in version of the software is similar enough to
5259: be used as a replacement.</p>
5260: <p>The last section is guarded by
5261: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5262: and includes code that uses the value of
5263: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5264: set in the previous section. This typically includes, e.g.,
5265: adding additional dependency restrictions and listing additional
5266: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5267: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5268: </div>
1.41 asau 5269: <div class="sect2">
1.1 dsieger 5270: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5271: <a name="native-or-pkgsrc-preference"></a>16.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5272: <p>When building packages, it's possible to choose whether to set
5273: a global preference for using either the built-in (native)
5274: version or the pkgsrc version of software to satisfy a
5275: dependency. This is controlled by setting
5276: <code class="varname">PREFER_PKGSRC</code> and
5277: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5278: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
1.1 dsieger 5279: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5280: use the pkgsrc versions of software, while
5281: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5282: built-in versions. Preferences are determined by the most
5283: specific instance of the package in either
5284: <code class="varname">PREFER_PKGSRC</code> or
5285: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5286: in neither or in both variables, then
5287: <code class="varname">PREFER_PKGSRC</code> has precedence over
5288: <code class="varname">PREFER_NATIVE</code>. For example, to require
5289: using pkgsrc versions of software for all but the most basic
5290: bits on a NetBSD system, you can set:</p>
5291: <pre class="programlisting">
5292: PREFER_PKGSRC= yes
5293: PREFER_NATIVE= getopt skey tcp_wrappers
5294: </pre>
5295: <p>A package <span class="emphasis"><em>must</em></span> have a
5296: <code class="filename">builtin.mk</code>
5297: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5298: otherwise it is simply ignored in that list.</p>
1.117 sevan 5299: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
5300: straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
5301: bootstrap.
5302: Switching between settings globally at a later date can introduce
5303: complications with dependency resolution. This is caused by packages
5304: built with the opposite preference being installed alongside each other.</p>
5305: <pre class="screen">
5306: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
5307: </pre>
1.1 dsieger 5308: </div>
5309: </div>
5310: </div>
1.41 asau 5311: <div class="chapter">
1.1 dsieger 5312: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5313: <a name="pkginstall"></a>Chapter 17. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5314: <div class="toc">
5315: <p><b>Table of Contents</b></p>
1.100 leot 5316: <dl class="toc">
1.154 rillig 5317: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
1.1 dsieger 5318: <dd><dl>
1.154 rillig 5319: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
5320: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
1.1 dsieger 5321: </dl></dd>
1.154 rillig 5322: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
1.1 dsieger 5323: <dd><dl>
1.154 rillig 5324: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5325: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
5326: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
5327: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
5328: </dl></dd>
5329: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
5330: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
5331: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
5332: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
5333: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
5334: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
5335: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.1 dsieger 5336: </dl>
5337: </div>
5338: <p>This chapter describes the framework known as
5339: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5340: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5341: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5342: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5343: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5344: provided that packages are correctly designed.</p></li>
1.23 wiz 5345: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5346: <li class="listitem"><p>Registration of system users and groups.</p></li>
5347: <li class="listitem"><p>Registration of system shells.</p></li>
5348: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5349: </ul></div>
5350: <p>The following sections inspect each of the above points in detail.</p>
5351: <p>You may be thinking that many of the things described here could be
5352: easily done with simple code in the package's post-installation target
5353: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5354: as the code in them is only executed when building from source. Machines
5355: using binary packages could not benefit from it at all (as the code itself
5356: could be unavailable). Therefore, the only way to achieve any of the items
5357: described above is by means of the installation scripts, which are
5358: automatically generated by pkginstall.</p>
1.41 asau 5359: <div class="sect1">
1.1 dsieger 5360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5361: <a name="files-and-dirs-outside-prefix"></a>17.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5362: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5363: of files and directories that belong to a package. The names used in it
5364: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5365: which means that it cannot register files outside this directory (absolute
5366: path names are not allowed). Despite this restriction, some packages need
5367: to install files outside this location; e.g., under
5368: <code class="filename">${VARBASE}</code> or
5369: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5370: is to create such files during installation time by using
5371: installation scripts.</p>
5372: <p>The generic installation scripts are shell scripts that can
5373: contain arbitrary code. The list of scripts to execute is taken from
5374: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5375: <code class="filename">INSTALL</code>. A similar variable exists for package
5376: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5377: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5378: commands, so they have the potential to create and manage files
5379: anywhere in the file system.</p>
5380: <p>Using these general installation files is not recommended, but
5381: may be needed in some special cases. One reason for avoiding them is
5382: that the user has to trust the packager that there is no unwanted or
5383: simply erroneous code included in the installation script. Also,
5384: previously there were many similar scripts for the same functionality,
5385: and fixing a common error involved finding and changing all of
5386: them.</p>
5387: <p>The pkginstall framework offers another, standardized way. It
5388: provides generic scripts to abstract the manipulation of such files
5389: and directories based on variables set in the package's
5390: <code class="filename">Makefile</code>. The rest of this section describes
5391: these variables.</p>
1.41 asau 5392: <div class="sect2">
1.1 dsieger 5393: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5394: <a name="dirs-outside-prefix"></a>17.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5395: <p>The following variables can be set to request the creation of
5396: directories anywhere in the file system:</p>
1.41 asau 5397: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108 rillig 5398: <li class="listitem">
5399: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5400: contain a list of directories that should be created and should attempt
5401: to be destroyed by the installation scripts. The difference between
5402: the two is that the latter prompts the administrator to remove any
5403: directories that may be left after deinstallation (because they were
1.108 rillig 5404: not empty), while the former does not. Example:</p>
5405: <pre class="programlisting">
5406: MAKE_DIRS+= ${VARBASE}/foo/private
5407: </pre>
5408: </li>
1.23 wiz 5409: <li class="listitem">
1.1 dsieger 5410: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5411: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5412: which directories should be created and should attempt to be destroyed
5413: by the installation scripts. Each tuple holds the following values,
5414: separated by spaces: the directory name, its owner, its group and its
5415: numerical mode. For example:</p>
5416: <pre class="programlisting">
1.108 rillig 5417: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5418: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5419: </pre>
5420: <p>The difference between the two is exactly the same as their
5421: non-<code class="varname">PERMS</code> counterparts.</p>
5422: </li>
5423: </ul></div>
5424: </div>
1.41 asau 5425: <div class="sect2">
1.1 dsieger 5426: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5427: <a name="files-outside-prefix"></a>17.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5428: <p>Creating non-empty files outside the installation prefix is tricky
5429: because the <code class="filename">PLIST</code> forces all files to be inside it.
5430: To overcome this problem, the only solution is to extract the file in the
5431: known place (i.e., inside the installation prefix) and copy it to the
5432: appropriate location during installation (done by the installation scripts
5433: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5434: file</em></span> in the following paragraphs, which describe the variables
5435: that can be used to automatically and consistently handle files outside the
5436: installation prefix:</p>
1.41 asau 5437: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5438: <li class="listitem">
1.1 dsieger 5439: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5440: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5441: During installation time, the master file is copied to the target one
5442: if and only if the latter does not exist. Upon deinstallation, the
5443: target file is removed provided that it was not modified by the
5444: installation.</p>
5445: <p>The difference between the two is that the latter prompts the
5446: administrator to remove any files that may be left after
5447: deinstallation (because they were not empty), while the former does
5448: not.</p>
5449: </li>
1.23 wiz 5450: <li class="listitem">
1.1 dsieger 5451: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5452: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5453: files as well as their target locations. For each of them, it also
5454: specifies their owner, their group and their numeric permissions, in
5455: this order. For example:</p>
5456: <pre class="programlisting">
1.108 rillig 5457: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5458: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5459: </pre>
5460: <p>The difference between the two is exactly the same as their
5461: non-<code class="varname">PERMS</code> counterparts.</p>
5462: </li>
5463: </ul></div>
5464: </div>
5465: </div>
1.41 asau 5466: <div class="sect1">
1.1 dsieger 5467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5468: <a name="conf-files"></a>17.2. Configuration files</h2></div></div></div>
1.1 dsieger 5469: <p>Configuration files are special in the sense that they are installed
5470: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5471: need special treatment during installation (most of which is automated by
5472: pkginstall). The main concept you must bear in mind is that files marked
5473: as configuration files are automatically copied to the right place (somewhere
5474: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5475: and only if</em></span> they didn't exist before. Similarly, they will not
5476: be removed if they have local modifications. This ensures that
5477: administrators never lose any custom changes they may have made.</p>
1.41 asau 5478: <div class="sect2">
1.1 dsieger 5479: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5480: <a name="conf-files-sysconfdir"></a>17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1 dsieger 5481: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5482: specifies where configuration files shall be installed. Its contents are
5483: set based upon the following variables:</p>
1.41 asau 5484: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5485: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5486: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5487: be overridden by the user to point to his preferred location (e.g.,
5488: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5489: Packages must not use it directly.</p></li>
1.23 wiz 5490: <li class="listitem">
1.1 dsieger 5491: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5492: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5493: for the package being built shall be installed. The definition of this
5494: variable only makes sense in the package's
5495: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5496: <p>As an example, consider the Apache package,
1.137 leot 5497: <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.1 dsieger 5498: configuration files under the
5499: <code class="filename">httpd/</code> subdirectory of
5500: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5501: Makefile.</p>
5502: </li>
1.23 wiz 5503: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 5504: variable that holds this package's configuration directory (if
5505: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5506: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5507: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 5508: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 5509: directory where the configuration files for the package identified by
5510: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5511: </ul></div>
5512: <p>Based on the above variables, pkginstall determines the value of
5513: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5514: variable that can be used within a package to refer to its configuration
5515: directory. The algorithm used to set its value is basically the
5516: following:</p>
1.23 wiz 5517: <div class="orderedlist"><ol class="orderedlist" type="1">
5518: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 5519: its value is used.</p></li>
1.23 wiz 5520: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 5521: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5522: <code class="filename">Makefile</code>, the resulting value is
5523: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 5524: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 5525: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5526: </ol></div>
5527: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.154 rillig 5528: automatically added to <code class="filename">OWN_DIRS</code>. See <a class="xref" href="#dirs-outside-prefix" title="17.1.1. Directory manipulation">Section 17.1.1, “Directory manipulation”</a> what this means. This does not apply to
1.16 jnemeth 5529: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5530: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 5531: </div>
1.41 asau 5532: <div class="sect2">
1.1 dsieger 5533: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5534: <a name="conf-files-configure"></a>17.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5535: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5536: known place, you need to teach each package where it shall install its
5537: files. In some cases you will have to patch the package Makefiles to
5538: achieve it. If you are lucky, though, it may be as easy as passing an
5539: extra flag to the configuration script; this is the case of GNU Autoconf-
5540: generated files:</p>
5541: <pre class="programlisting">
5542: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5543: </pre>
5544: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5545: for</em></span> its configuration files, not where they will be originally
5546: installed (although the difference is never explicit,
5547: unfortunately).</p>
5548: </div>
1.41 asau 5549: <div class="sect2">
1.1 dsieger 5550: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5551: <a name="conf-files-patching"></a>17.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5552: <p>As said before, pkginstall automatically handles configuration files.
5553: This means that <span class="strong"><strong>the packages themselves must not
5554: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5555: directly</strong></span>. Bad news is that many software installation scripts
5556: will, out of the box, mess with the contents of that directory. So what is
5557: the correct procedure to fix this issue?</p>
5558: <p>You must teach the package (usually by manually patching it) to
5559: install any configuration files under the examples hierarchy,
5560: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5561: <code class="filename">PLIST</code> registers them and the administrator always
5562: has the original copies available.</p>
5563: <p>Once the required configuration files are in place (i.e., under the
5564: examples hierarchy), the pkginstall framework can use them as master copies
5565: during the package installation to update what is in
5566: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5567: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.154 rillig 5568: used. Check out <a class="xref" href="#files-outside-prefix" title="17.1.2. File manipulation">Section 17.1.2, “File manipulation”</a> for information
1.1 dsieger 5569: about their syntax and their purpose. Here is an example, taken from the
1.137 leot 5570: <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.1 dsieger 5571: <pre class="programlisting">
5572: EGDIR= ${PREFIX}/share/doc/mutt/samples
5573: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5574: </pre>
5575: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5576: package and has no meaning outside it.</p>
5577: </div>
1.41 asau 5578: <div class="sect2">
1.1 dsieger 5579: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5580: <a name="conf-files-disable"></a>17.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5581: <p>The automatic copying of config files can be toggled by setting the
5582: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5583: installation.</p>
5584: </div>
5585: </div>
1.41 asau 5586: <div class="sect1">
1.1 dsieger 5587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5588: <a name="rcd-scripts"></a>17.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5589: <p>System startup scripts are special files because they must be
5590: installed in a place known by the underlying OS, usually outside the
1.154 rillig 5591: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="17.1. Files and directories outside the installation prefix">Section 17.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.1 dsieger 5592: can be used. However, pkginstall provides a special mechanism to handle
5593: these files.</p>
5594: <p>In order to provide system startup scripts, the package has
5595: to:</p>
1.23 wiz 5596: <div class="orderedlist"><ol class="orderedlist" type="1">
5597: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 5598: the <code class="literal">.sh</code> suffix appended. Considering the
1.137 leot 5599: <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.1 dsieger 5600: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 5601: <li class="listitem">
1.1 dsieger 5602: <p>Tell pkginstall to handle it, appending the name of the script,
5603: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5604: Continuing the previous example:</p>
5605: <pre class="programlisting">
5606: RCD_SCRIPTS+= cupsd
5607: </pre>
5608: </li>
5609: </ol></div>
5610: <p>Once this is done, pkginstall will do the following steps for each
5611: script in an automated fashion:</p>
1.23 wiz 5612: <div class="orderedlist"><ol class="orderedlist" type="1">
5613: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 5614: substitutions described in the <code class="filename">FILES_SUBST</code>
5615: variable.</p></li>
1.23 wiz 5616: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 5617: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
5618: that this master file must be explicitly registered in the
5619: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 5620: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 5621: from the examples hierarchy into the system-wide startup scripts
5622: directory.</p></li>
5623: </ol></div>
1.41 asau 5624: <div class="sect2">
1.1 dsieger 5625: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5626: <a name="rcd-scripts-disable"></a>17.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 5627: <p>The automatic copying of config files can be toggled by setting the
5628: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
5629: installation. Note that the scripts will be always copied inside the
5630: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
5631: matter what the value of this variable is.</p>
5632: </div>
5633: </div>
1.41 asau 5634: <div class="sect1">
1.1 dsieger 5635: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5636: <a name="users-and-groups"></a>17.4. System users and groups</h2></div></div></div>
1.1 dsieger 5637: <p>If a package needs to create special users and/or groups during
5638: installation, it can do so by using the pkginstall framework.</p>
5639: <p>Users can be created by adding entries to the
5640: <code class="varname">PKG_USERS</code> variable. Each entry has the following
5641: syntax:</p>
5642: <pre class="programlisting">
5643: user:group
5644: </pre>
5645: <p>Further specification of user details may be done by setting
5646: per-user variables.
5647: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
5648: numeric UID for the user.
5649: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
5650: user's description or comment.
5651: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
5652: user's home directory, and defaults to
5653: <code class="filename">/nonexistent</code> if not specified.
5654: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
5655: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
5656: not specified.</p>
5657: <p>Similarly, groups can be created by adding entries to the
5658: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
5659: <pre class="programlisting">
5660: group
5661: </pre>
5662: <p>The numeric GID of the group may be set by defining
5663: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
5664: <p>If a package needs to create the users and groups at an earlier
1.116 wiz 5665: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
5666: <code class="literal">configure</code>,<code class="literal">build</code>, or
5667: <code class="literal">pre-install</code> to indicate the phase before which the
5668: users and groups are created. In this case, the numeric UIDs and GIDs
5669: of the created users and groups are automatically hardcoded into the
5670: final installation scripts.</p>
1.1 dsieger 5671: </div>
1.41 asau 5672: <div class="sect1">
1.1 dsieger 5673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5674: <a name="shells"></a>17.5. System shells</h2></div></div></div>
1.1 dsieger 5675: <p>Packages that install system shells should register them in the shell
5676: database, <code class="filename">/etc/shells</code>, to make things easier to the
5677: administrator. This must be done from the installation scripts to keep
5678: binary packages working on any system. pkginstall provides an easy way to
5679: accomplish this task.</p>
5680: <p>When a package provides a shell interpreter, it has to set the
5681: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
5682: add some hooks to the installation scripts to handle it. Consider the
1.137 leot 5683: 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.1 dsieger 5684: <pre class="programlisting">
5685: PKG_SHELL= ${PREFIX}/bin/zsh
5686: </pre>
1.41 asau 5687: <div class="sect2">
1.1 dsieger 5688: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5689: <a name="shells-disable"></a>17.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 5690: <p>The automatic registration of shell interpreters can be disabled by
5691: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
5692: environment variable to <code class="literal">NO</code>.</p>
5693: </div>
5694: </div>
1.41 asau 5695: <div class="sect1">
1.1 dsieger 5696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5697: <a name="fonts"></a>17.6. Fonts</h2></div></div></div>
1.1 dsieger 5698: <p>Packages that install X11 fonts should update the database files
5699: that index the fonts within each fonts directory. This can easily be
5700: accomplished within the pkginstall framework.</p>
5701: <p>When a package installs X11 fonts, it must list the directories in
5702: which fonts are installed in the
5703: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 5704: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
5705: <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>. This will add hooks to the
1.1 dsieger 5706: installation scripts to run the appropriate commands to update the fonts
5707: database files within each of those directories. For convenience, if the
5708: directory path is relative, it is taken to be relative to the package's
1.137 leot 5709: 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.1 dsieger 5710: <pre class="programlisting">
1.67 wiz 5711: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5712: </pre>
1.41 asau 5713: <div class="sect2">
1.1 dsieger 5714: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 5715: <a name="fonts-disable"></a>17.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 5716: <p>The automatic update of fonts databases can be disabled by
5717: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
5718: environment variable to <code class="literal">NO</code>.</p>
5719: </div>
5720: </div>
5721: </div>
1.41 asau 5722: <div class="chapter">
1.1 dsieger 5723: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5724: <a name="options"></a>Chapter 18. Options handling</h2></div></div></div>
1.1 dsieger 5725: <div class="toc">
5726: <p><b>Table of Contents</b></p>
1.100 leot 5727: <dl class="toc">
1.154 rillig 5728: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
5729: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
5730: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
5731: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 5732: </dl>
5733: </div>
5734: <p>Many packages have the ability to be built to support different
5735: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5736: in pkgsrc that provides generic handling of those options that
5737: determine different ways in which the packages can be built. It's
5738: possible for the user to specify exactly which sets of options will be
5739: built into a package or to allow a set of global default options
5740: apply.</p>
1.7 rillig 5741: <p>There are two broad classes of behaviors that one might want to
5742: control via options. One is whether some particular feature is
5743: enabled in a program that will be built anyway, often by including or
5744: not including a dependency on some other package. The other is
5745: whether or not an additional program will be built as part of the
5746: package. Generally, it is better to make a split package for such
5747: additional programs instead of using options, because it enables
5748: binary packages to be built which can then be added separately. For
5749: example, the foo package might have minimal dependencies (those
5750: packages without which foo doesn't make sense), and then the foo-gfoo
5751: package might include the GTK frontend program gfoo. This is better
5752: than including a gtk option to foo that adds gfoo, because either that
5753: option is default, in which case binary users can't get foo without
5754: gfoo, or not default, in which case they can't get gfoo. With split
5755: packages, they can install foo without having GTK, and later decide to
5756: install gfoo (pulling in GTK at that time). This is an advantage to
5757: source users too, avoiding the need for rebuilds.</p>
5758: <p>Plugins with widely varying dependencies should usually be split
5759: instead of options.</p>
5760: <p>It is often more work to maintain split packages, especially if
5761: the upstream package does not support this. The decision of split
5762: vs. option should be made based on the likelihood that users will want
5763: or object to the various pieces, the size of the dependencies that are
5764: included, and the amount of work.</p>
5765: <p>A further consideration is licensing. Non-free parts, or parts
5766: that depend on non-free dependencies (especially plugins) should
5767: almost always be split if feasible.</p>
1.41 asau 5768: <div class="sect1">
1.1 dsieger 5769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5770: <a name="global-default-options"></a>18.1. Global default options</h2></div></div></div>
1.1 dsieger 5771: <p>Global default options are listed in
5772: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5773: that should be built into every package if that option is supported.
1.10 hubertf 5774: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5775: </div>
1.41 asau 5776: <div class="sect1">
1.1 dsieger 5777: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5778: <a name="converting-to-options"></a>18.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 5779: </h2></div></div></div>
5780: <p>The following example shows how
5781: <code class="filename">bsd.options.mk</code> should be used
5782: by the hypothetical ``wibble'' package, either in the package
5783: <code class="filename">Makefile</code>, or in a file,
5784: e.g. <code class="filename">options.mk</code>, that is included by the
5785: main package <code class="filename">Makefile</code>.</p>
5786: <pre class="programlisting">
5787: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5788: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5789: PKG_OPTIONS_OPTIONAL_GROUPS= database
5790: PKG_OPTIONS_GROUP.database= mysql pgsql
5791: PKG_SUGGESTED_OPTIONS= wibble-foo
5792: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5793: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5794:
5795: .include "../../mk/bsd.prefs.mk"
5796:
5797: # this package was previously named wibble2
5798: .if defined(PKG_OPTIONS.wibble2)
5799: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5800: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5801: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5802: .endif
5803:
5804: .include "../../mk/bsd.options.mk"
5805:
5806: # Package-specific option-handling
5807:
5808: ###
5809: ### FOO support
5810: ###
5811: .if !empty(PKG_OPTIONS:Mwibble-foo)
5812: CONFIGURE_ARGS+= --enable-foo
5813: .endif
5814:
5815: ###
5816: ### LDAP support
5817: ###
5818: .if !empty(PKG_OPTIONS:Mldap)
5819: . include "../../databases/openldap-client/buildlink3.mk"
5820: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5821: .endif
5822:
5823: ###
5824: ### database support
5825: ###
5826: .if !empty(PKG_OPTIONS:Mmysql)
5827: . include "../../mk/mysql.buildlink3.mk"
5828: .endif
5829: .if !empty(PKG_OPTIONS:Mpgsql)
5830: . include "../../mk/pgsql.buildlink3.mk"
5831: .endif
5832: </pre>
5833: <p>The first section contains the information about which build
5834: options are supported by the package, and any default options settings
5835: if needed.</p>
1.23 wiz 5836: <div class="orderedlist"><ol class="orderedlist" type="1">
5837: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.174 leot 5838: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1 dsieger 5839: options. It should be set to
5840: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5841: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5842: at the point where the options are processed.</p></li>
1.23 wiz 5843: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 5844: build options supported by the package.</p></li>
1.23 wiz 5845: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 5846: list of names of groups of mutually exclusive options. The options in
5847: each group are listed in
5848: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
5849: The most specific setting of any option from the group takes
5850: precedence over all other options in the group. Options from the
5851: groups will be automatically added to
5852: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 5853: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 5854: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
5855: packages will fail if no option from the group is
5856: selected.</p></li>
1.23 wiz 5857: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 5858: of names of sets of options. At least one option from each set must
5859: be selected. The options in each set are listed in
5860: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
5861: Options from the sets will be automatically added to
5862: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
5863: fail if no option from the set is selected.</p></li>
1.23 wiz 5864: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 5865: build options which are enabled by default.</p></li>
1.23 wiz 5866: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 5867: of
1.23 wiz 5868: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.10 hubertf 5869: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 5870: their option counterparts. Pairs should be added with
1.23 wiz 5871: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 5872: warning will be issued if the user uses a legacy
5873: variable.</p></li>
1.23 wiz 5874: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 5875: of
1.23 wiz 5876: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.1 dsieger 5877: pairs that map options that have been renamed to their new
1.23 wiz 5878: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 5879: the listing of global legacy options. A warning will be issued if
5880: the user uses a legacy option.</p></li>
1.23 wiz 5881: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 5882: options implied by deprecated variables used. This can be used for
5883: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
5884: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
5885: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 5886: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 5887: a list of warnings about deprecated variables or options used, and
5888: what to use instead.</p></li>
5889: </ol></div>
5890: <p>A package should never modify
5891: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
5892: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
5893: To suggest a default set of options, use
5894: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
5895: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
5896: including <code class="filename">bsd.options.mk</code>. If none of
5897: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
5898: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
5899: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
5900: happen with platform-specific options if none of them is supported on
5901: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
5902: empty list and the package is otherwise treated as not using the
5903: options framework.</p>
5904: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
5905: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
5906: build options, properly filtered to remove unsupported and duplicate
5907: options.</p>
5908: <p>The remaining sections contain the logic that is specific to
5909: each option. The correct way to check for an option is to check
5910: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
5911: <pre class="programlisting">
5912: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
5913: </pre>
5914: </div>
1.41 asau 5915: <div class="sect1">
1.1 dsieger 5916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5917: <a name="option-names"></a>18.3. Option Names</h2></div></div></div>
1.1 dsieger 5918: <p>Options that enable similar features in different packages (like
5919: optional support for a library) should use a common name in all
5920: packages that support it (like the name of the library). If another
5921: package already has an option with the same meaning, use the same
5922: name.</p>
5923: <p>Options that enable features specific to one package, where it's
5924: unlikely that another (unrelated) package has the same (or a similar)
5925: optional feature, should use a name prefixed with
5926: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
5927: <p>If a group of related packages share an optional feature
5928: specific to that group, prefix it with the name of the
1.23 wiz 5929: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 5930: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
5931: <p>For new options, add a line to
5932: <code class="filename">mk/defaults/options.description</code>. Lines have two
5933: fields, separated by tab. The first field is the option name, the
5934: second its description. The description should be a whole sentence
5935: (starting with an uppercase letter and ending with a period) that
1.23 wiz 5936: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
5937: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 5938: </div>
1.41 asau 5939: <div class="sect1">
1.7 rillig 5940: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5941: <a name="option-build"></a>18.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 5942: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7 rillig 5943: different dependencies based on the options with which the package was
5944: built. For querying these options, the file
5945: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
5946: typical example looks like this:</p>
5947: <pre class="programlisting">
5948: pkgbase := libpurple
5949: .include "../../mk/pkg-build-options.mk"
5950:
5951: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
5952: ...
5953: .endif
5954: </pre>
5955: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
5956: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
5957: options of the libpurple package, which can then be queried like
5958: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
5959: file. See the file <code class="filename">pkg-build-options.mk</code> for more
5960: details.</p>
5961: </div>
1.1 dsieger 5962: </div>
1.41 asau 5963: <div class="chapter">
1.1 dsieger 5964: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 5965: <a name="build"></a>Chapter 19. The build process</h2></div></div></div>
1.1 dsieger 5966: <div class="toc">
5967: <p><b>Table of Contents</b></p>
1.100 leot 5968: <dl class="toc">
1.154 rillig 5969: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
5970: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
5971: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
5972: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
5973: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
5974: <dd><dl>
5975: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
5976: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
5977: </dl></dd>
5978: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
5979: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
5980: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
5981: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
5982: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
5983: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
5984: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
5985: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
5986: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
5987: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
5988: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
5989: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
1.1 dsieger 5990: </dl>
5991: </div>
1.41 asau 5992: <div class="sect1">
1.1 dsieger 5993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 5994: <a name="build.intro"></a>19.1. Introduction</h2></div></div></div>
1.1 dsieger 5995: <p>This chapter gives a detailed description on how a package is
5996: built. Building a package is separated into different
5997: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
5998: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 5999: described in the following sections. Each phase is split into
1.1 dsieger 6000: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6001: containing phase, prefixed by one of <code class="varname">pre-</code>,
6002: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6003: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6004: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6005: <p>Never override the regular targets (like
6006: <code class="varname">fetch</code>), if you have to, override the
6007: <code class="varname">do-*</code> ones instead.</p>
6008: <p>The basic steps for building a program are always the same. First
6009: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6010: the local system and then extracted. After any pkgsrc-specific patches
6011: to compile properly are applied, the software can be configured, then
6012: built (usually by compiling), and finally the generated binaries, etc.
6013: can be put into place on the system.</p>
6014: <p>To get more details about what is happening at each step,
6015: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6016: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6017: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6018: </div>
1.41 asau 6019: <div class="sect1">
1.1 dsieger 6020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6021: <a name="build.prefix"></a>19.2. Program location</h2></div></div></div>
1.1 dsieger 6022: <p>Before outlining the process performed by the NetBSD package system in
6023: the next section, here's a brief discussion on where programs are
6024: installed, and which variables influence this.</p>
6025: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6026: where all files of the final program shall be installed. It is
6027: usually set to <code class="varname">LOCALBASE</code>
6028: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6029: for pkgs in the <code class="filename">cross</code> category. The value of
6030: <code class="varname">PREFIX</code> needs to be put
6031: into the various places in the program's source where paths to
1.154 rillig 6032: these files are encoded. See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, “<code class="filename">patches/*</code>”</a> and <a class="xref" href="#fixes.libtool" title="21.3.1. Shared libraries - libtool">Section 21.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.1 dsieger 6033: <p>When choosing which of these variables to use,
6034: follow the following rules:</p>
1.41 asau 6035: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6036: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 6037: where the current pkg will be installed. When referring to a
6038: pkg's own installation path, use
1.23 wiz 6039: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6040: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 6041: are installed. If you need to construct a -I or -L argument
6042: to the compiler to find includes and libraries installed by
1.23 wiz 6043: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 6044: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6045: installed all packages in <code class="filename">/usr/local</code>. As
6046: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6047: administrator, this variable is a misnomer.</p></li>
1.23 wiz 6048: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 6049: distribution (from xsrc, etc.) is installed. When looking for
6050: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 6051: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
1.99 sevan 6052: <li class="listitem"><p>X11-based packages using imake must set
6053: <code class="varname">USE_IMAKE</code> to be installed correctly under
6054: <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 6055: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.174 leot 6056: install files according to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1 dsieger 6057: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6058: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6059: </ul></div>
6060: </div>
1.41 asau 6061: <div class="sect1">
1.1 dsieger 6062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6063: <a name="build.builddirs"></a>19.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 6064: <p>When building a package, various directories are used to store
1.1 dsieger 6065: source files, temporary files, pkgsrc-internal files, and so on. These
6066: directories are explained here.</p>
6067: <p>Some of the directory variables contain relative pathnames. There
6068: are two common base directories for these relative directories:
6069: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6070: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6071: inside the package itself.</p>
1.41 asau 6072: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6073: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6074: <dd><p>This is an absolute pathname that points to the pkgsrc
6075: root directory. Generally, you don't need
6076: it.</p></dd>
6077: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6078: <dd><p>This is an absolute pathname that points to the
6079: current package.</p></dd>
6080: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6081: <dd><p>This is a pathname relative to
6082: <code class="varname">PKGSRCDIR</code> that points to the current
6083: package.</p></dd>
6084: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6085: <dd><p>This is an absolute pathname pointing to the directory
6086: where all work takes place. The distfiles are extracted to this
6087: directory. It also contains temporary directories and log files used by
6088: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6089: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6090: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6091: <dd><p>This is an absolute pathname pointing to the directory
6092: where the distfiles are extracted. It is usually a direct subdirectory
6093: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6094: that isn't hidden. This variable may be changed by a package
6095: <code class="filename">Makefile</code>.</p></dd>
6096: </dl></div>
1.14 jmcneill 6097: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6098: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 6099: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 6100: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6101: If users would like to have their pkgsrc trees behave in a
6102: read-only manner, then the value of
6103: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6104: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 6105: </div>
1.41 asau 6106: <div class="sect1">
1.1 dsieger 6107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6108: <a name="build.running"></a>19.4. Running a phase</h2></div></div></div>
1.10 hubertf 6109: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 6110: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6111: phase. This will automatically run all phases that are required for this
6112: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 6113: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 6114: the package will be built, but not installed.</p>
6115: </div>
1.41 asau 6116: <div class="sect1">
1.1 dsieger 6117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6118: <a name="build.fetch"></a>19.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6119: <p>The first step in building a package is to fetch the
6120: distribution files (distfiles) from the sites that are providing
6121: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6122: phase.</p>
1.41 asau 6123: <div class="sect2">
1.1 dsieger 6124: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6125: <a name="build.fetch.what"></a>19.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1 dsieger 6126: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6127: defines all URLs from where the distfile, whose name is
6128: derived from the <code class="varname">DISTNAME</code> variable, is
6129: fetched. The more complicated cases are described
6130: below.</p>
6131: <p>The variable <code class="varname">DISTFILES</code> specifies
6132: the list of distfiles that have to be fetched. Its value
1.66 asau 6133: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
6134: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1 dsieger 6135: so that most packages don't need to define it at all.
6136: <code class="varname">EXTRACT_SUFX</code> is
6137: <code class="literal">.tar.gz</code> by default, but can be changed
6138: freely. Note that if your package requires additional
6139: distfiles to the default one, you cannot just append the
6140: additional filenames using the <code class="literal">+=</code>
6141: operator, but you have write for example:</p>
6142: <pre class="programlisting">
1.66 asau 6143: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 6144: </pre>
6145: <p>Each distfile is fetched from a list of sites, usually
6146: <code class="varname">MASTER_SITES</code>. If the package has multiple
6147: <code class="varname">DISTFILES</code> or multiple
6148: <code class="varname">PATCHFILES</code> from different sites, you can
6149: set
6150: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6151: to the list of URLs where the file
6152: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6153: (including the suffix) can be found.</p>
6154: <pre class="programlisting">
6155: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6156: DISTFILES+= foo-file.tar.gz
6157: SITES.foo-file.tar.gz= \
1.174 leot 6158: https://www.somewhere.com/somehow/ \
6159: https://www.somewhereelse.com/mirror/somehow/
1.1 dsieger 6160: </pre>
6161: <p>When actually fetching the distfiles, each item from
6162: <code class="varname">MASTER_SITES</code> or
6163: <code class="varname">SITES.*</code> gets the name of each distfile
6164: appended to it, without an intermediate slash. Therefore,
6165: all site values have to end with a slash or other separator
6166: character. This allows for example to set
6167: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6168: that gets the name of the distfile as a parameter. In this
6169: case, the definition would look like:</p>
6170: <pre class="programlisting">
1.174 leot 6171: MASTER_SITES= https://www.example.com/download.cgi?file=
1.1 dsieger 6172: </pre>
1.22 jakllsch 6173: <p> The exception to this rule are URLs starting with a dash.
1.66 asau 6174: In that case the URL is taken as is, fetched and the result
6175: stored under the name of the distfile. You can use this style
6176: for the case when the download URL style does not match the
6177: above common case. For example, if permanent download URL is a
6178: redirector to the real download URL, or the download file name
6179: is offered by an HTTP Content-Disposition header. In the
6180: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
6181: created instead of the default
6182: <code class="filename">v1.0.0.tar.gz</code>.</p>
6183: <pre class="programlisting">
6184: DISTNAME= foo-1.0.0
1.174 leot 6185: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
1.66 asau 6186: </pre>
1.1 dsieger 6187: <p>There are some predefined values for
6188: <code class="varname">MASTER_SITES</code>, which can be used in
6189: packages. The names of the variables should speak for
6190: themselves.</p>
1.156 leot 6191: <table border="0" summary="Simple list" class="simplelist">
6192: <tr>
6193: <td>MASTER_SITE_APACHE</td>
6194: <td>MASTER_SITE_BACKUP</td>
6195: </tr>
6196: <tr>
6197: <td>MASTER_SITE_CRATESIO</td>
6198: <td>MASTER_SITE_CYGWIN</td>
6199: </tr>
6200: <tr>
6201: <td>MASTER_SITE_DEBIAN</td>
6202: <td>MASTER_SITE_FREEBSD</td>
6203: </tr>
6204: <tr>
6205: <td>MASTER_SITE_FREEBSD_LOCAL</td>
6206: <td>MASTER_SITE_GENTOO</td>
6207: </tr>
6208: <tr>
6209: <td>MASTER_SITE_GITHUB</td>
6210: <td>MASTER_SITE_GNOME</td>
6211: </tr>
6212: <tr>
6213: <td>MASTER_SITE_GNU</td>
6214: <td>MASTER_SITE_GNUSTEP</td>
6215: </tr>
6216: <tr>
6217: <td>MASTER_SITE_HASKELL_HACKAGE</td>
6218: <td>MASTER_SITE_IFARCHIVE</td>
6219: </tr>
6220: <tr>
6221: <td>MASTER_SITE_KDE</td>
6222: <td>MASTER_SITE_MOZILLA</td>
6223: </tr>
6224: <tr>
6225: <td>MASTER_SITE_MOZILLA_ALL</td>
6226: <td>MASTER_SITE_MYSQL</td>
6227: </tr>
6228: <tr>
6229: <td>MASTER_SITE_NETLIB</td>
6230: <td>MASTER_SITE_OPENBSD</td>
6231: </tr>
6232: <tr>
6233: <td>MASTER_SITE_OPENOFFICE</td>
6234: <td>MASTER_SITE_OSDN</td>
6235: </tr>
6236: <tr>
6237: <td>MASTER_SITE_PERL_CPAN</td>
6238: <td>MASTER_SITE_PGSQL</td>
6239: </tr>
6240: <tr>
6241: <td>MASTER_SITE_PYPI</td>
6242: <td>MASTER_SITE_RUBYGEMS</td>
6243: </tr>
6244: <tr>
6245: <td>MASTER_SITE_R_CRAN</td>
6246: <td>MASTER_SITE_SOURCEFORGE</td>
6247: </tr>
6248: <tr>
6249: <td>MASTER_SITE_SUNSITE</td>
6250: <td>MASTER_SITE_SUSE</td>
6251: </tr>
6252: <tr>
6253: <td>MASTER_SITE_TEX_CTAN</td>
6254: <td>MASTER_SITE_XCONTRIB</td>
6255: </tr>
6256: <tr>
6257: <td>MASTER_SITE_XEMACS</td>
6258: <td>MASTER_SITE_XORG</td>
6259: </tr>
6260: </table>
1.1 dsieger 6261: <p>Some explanations for the less self-explaining ones:
6262: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6263: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.25 spz 6264: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.1 dsieger 6265: <p>If you choose one of these predefined sites, you may
6266: want to specify a subdirectory of that site. Since these
6267: macros may expand to more than one actual site, you
6268: <span class="emphasis"><em>must</em></span> use the following construct to
6269: specify a subdirectory:</p>
6270: <pre class="programlisting">
6271: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6272: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6273: </pre>
6274: <p>Note the trailing slash after the subdirectory
6275: name.</p>
6276: </div>
1.41 asau 6277: <div class="sect2">
1.1 dsieger 6278: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 6279: <a name="build.fetch.how"></a>19.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6280: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6281: all the distfiles exist in a local directory
6282: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6283: user). If the files do not exist, they are fetched using
6284: commands of the form</p>
6285: <pre class="programlisting">
6286: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6287: </pre>
6288: <p>where <code class="literal">${site}</code> varies through
6289: several possibilities in turn: first,
6290: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6291: sites specified in either <code class="varname">SITES.file</code> if
6292: defined, else <code class="varname">MASTER_SITES</code> or
6293: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6294: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6295: all except the first and the last can be optionally sorted
6296: by the user, via setting either
6297: <code class="varname">MASTER_SORT_RANDOM</code>, and
6298: <code class="varname">MASTER_SORT_AWK</code> or
6299: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6300: <p> The specific command and arguments used depend on the
6301: <code class="varname">FETCH_USING</code> parameter. The example above is
6302: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6303: <p>The distfiles mirror run by the NetBSD Foundation uses the
6304: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6305: distfiles, if they are freely distributable. Packages setting
6306: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6307: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6308: mirrored.</p>
6309: </div>
6310: </div>
1.41 asau 6311: <div class="sect1">
1.1 dsieger 6312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6313: <a name="build.checksum"></a>19.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6314: <p>After the distfile(s) are fetched, their checksum is
6315: generated and compared with the checksums stored in the
6316: distinfo file. If the checksums don't match, the build is
6317: aborted. This is to ensure the same distfile is used for
6318: building, and that the distfile wasn't changed, e.g. by some
6319: malign force, deliberately changed distfiles on the master
6320: distribution site or network lossage.</p>
6321: </div>
1.41 asau 6322: <div class="sect1">
1.1 dsieger 6323: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6324: <a name="build.extract"></a>19.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6325: <p>When the distfiles are present on the local system, they
6326: need to be extracted, as they usually come in the form of some
6327: compressed archive format.</p>
6328: <p>By default, all <code class="varname">DISTFILES</code> are
6329: extracted. If you only need some of them, you can set the
6330: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6331: files.</p>
6332: <p>Extracting the files is usually done by a little
6333: program, <code class="filename">mk/extract/extract</code>, which
6334: already knows how to extract various archive formats, so most
6335: likely you will not need to change anything here. But if you
6336: need, the following variables may help you:</p>
1.41 asau 6337: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6338: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6339: <dd><p>Use these variables to override the default
6340: options for an extract command, which are defined in
6341: <code class="filename">mk/extract/extract</code>.</p></dd>
6342: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6343: <dd><p>This variable can be set to
1.14 jmcneill 6344: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6345: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6346: absolute pathname pointing to the command with which tar
1.14 jmcneill 6347: archives should be extracted. It is preferred to choose bsdtar over gtar
6348: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6349: </dl></div>
6350: <p>If the <code class="filename">extract</code> program doesn't
6351: serve your needs, you can also override the
6352: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6353: command used for extracting the files. This command is
6354: executed in the <code class="filename">${WRKSRC}</code>
6355: directory. During execution of this command, the shell
6356: variable <code class="varname">extract_file</code> holds the absolute
6357: pathname of the file that is going to be extracted.</p>
6358: <p>And if that still does not suffice, you can override the
6359: <code class="varname">do-extract</code> target in the package
6360: Makefile.</p>
6361: </div>
1.41 asau 6362: <div class="sect1">
1.1 dsieger 6363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6364: <a name="build.patch"></a>19.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6365: <p>After extraction, all the patches named by the
6366: <code class="varname">PATCHFILES</code>, those present in the patches
6367: subdirectory of the package as well as in
6368: $LOCALPATCHES/$PKGPATH (e.g.
6369: <code class="filename">/usr/local/patches/graphics/png</code>) are
6370: applied. Patchfiles ending in <code class="filename">.Z</code> or
6371: <code class="filename">.gz</code> are uncompressed before they are
6372: applied, files ending in <code class="filename">.orig</code> or
6373: <code class="filename">.rej</code> are ignored. Any special options to
1.174 leot 6374: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.154 rillig 6375: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, “<code class="filename">patches/*</code>”</a> for more details.</p>
1.180 ! rillig 6376: <p>By default <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
! 6377: fail if the expected text from the patch context is not found in the
! 6378: patched file. If that happens, fix the patch file by comparing it
! 6379: with the actual text in the file to be patched.</p>
1.1 dsieger 6380: </div>
1.41 asau 6381: <div class="sect1">
1.1 dsieger 6382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6383: <a name="build.tools"></a>19.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6384: <p>This is covered in <a class="xref" href="#tools" title="Chapter 20. Tools needed for building or running">Chapter 20, <i>Tools needed for building or running</i></a>.
1.1 dsieger 6385: </p>
6386: </div>
1.41 asau 6387: <div class="sect1">
1.1 dsieger 6388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6389: <a name="build.wrapper"></a>19.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6390: <p>This phase creates wrapper programs for the compilers and
6391: linkers. The following variables can be used to tweak the
6392: wrappers.</p>
1.41 asau 6393: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6394: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6395: <dd><p>The command used to print progress
6396: messages. Does nothing by default. Set to
6397: <code class="literal">${ECHO}</code> to see the progress
6398: messages.</p></dd>
6399: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6400: <dd><p>This variable can be set to
6401: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6402: depending on whether you want additional information in the
6403: wrapper log file.</p></dd>
6404: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6405: <dd><p>This variable can be set to
6406: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6407: on whether the wrapper should use its cache, which will
6408: improve the speed. The default value is
6409: <code class="literal">yes</code>, but is forced to
6410: <code class="literal">no</code> if the platform does not support
6411: it.</p></dd>
6412: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6413: <dd><p>A list of reordering commands. A reordering
6414: command has the form
6415: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6416: It ensures that that
6417: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6418: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6419: </p></dd>
6420: </dl></div>
6421: </div>
1.41 asau 6422: <div class="sect1">
1.1 dsieger 6423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6424: <a name="build.configure"></a>19.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6425: <p>Most pieces of software need information on the header
6426: files, system calls, and library routines which are available
6427: on the platform they run on. The process of determining this
6428: information is known as configuration, and is usually
6429: automated. In most cases, a script is supplied with the
6430: distfiles, and its invocation results in generation of header
6431: files, Makefiles, etc.</p>
6432: <p>If the package contains a configure script, this can be
6433: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6434: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6435: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6436: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6437: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6438: <pre class="programlisting">
6439: .for d in ${CONFIGURE_DIRS}
6440: cd ${WRKSRC} \
6441: && cd ${d} \
6442: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6443: .endfor
6444: </pre>
6445: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6446: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6447: <code class="varname">WRKSRC</code>. In each of these directories, the
6448: configure script is run with the environment
6449: <code class="varname">CONFIGURE_ENV</code> and arguments
6450: <code class="varname">CONFIGURE_ARGS</code>. The variables
6451: <code class="varname">CONFIGURE_ENV</code>,
6452: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6453: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6454: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6455: package.</p>
1.37 wiz 6456: <p>If the program uses the Perl way of configuration (mainly Perl
6457: modules, but not only), i.e. a file called
6458: <code class="filename">Makefile.PL</code>, it should include
6459: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6460: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6461: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6462: <p>If the program uses an <code class="filename">Imakefile</code>
6463: for configuration, the appropriate steps can be invoked by
6464: setting <code class="varname">USE_IMAKE</code> to
1.99 sevan 6465: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
6466: You can add variables to xmkmf's environment by adding them to the
1.1 dsieger 6467: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6468: <p>If the program uses <code class="filename">cmake</code>
6469: for configuration, the appropriate steps can be invoked by
1.23 wiz 6470: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6471: You can add variables to cmake's environment by adding them to the
6472: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6473: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6474: The top directory argument is given by the
6475: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6476: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6477: <p>If there is no configure step at all, set
1.23 wiz 6478: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6479: </div>
1.41 asau 6480: <div class="sect1">
1.1 dsieger 6481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6482: <a name="build.build"></a>19.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6483: <p>For building a package, a rough equivalent of the
6484: following code is executed.</p>
6485: <pre class="programlisting">
6486: .for d in ${BUILD_DIRS}
6487: cd ${WRKSRC} \
6488: && cd ${d} \
6489: && env ${MAKE_ENV} \
6490: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6491: -f ${MAKE_FILE} \
6492: ${BUILD_TARGET}
6493: .endfor
6494: </pre>
6495: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 6496: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6497: <code class="varname">WRKSRC</code>. In each of these directories,
6498: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6499: <code class="varname">MAKE_ENV</code> and arguments
6500: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6501: <code class="varname">MAKE_ENV</code>,
6502: <code class="varname">BUILD_MAKE_FLAGS</code>,
6503: <code class="varname">MAKE_FILE</code> and
6504: <code class="varname">BUILD_TARGET</code> may all be changed by the
6505: package.</p>
6506: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 6507: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
6508: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 6509: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 6510: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
6511: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 6512: <p>If there is no build step at all, set
1.23 wiz 6513: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6514: </div>
1.41 asau 6515: <div class="sect1">
1.1 dsieger 6516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6517: <a name="build.test"></a>19.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6518: <p>[TODO]</p>
6519: </div>
1.41 asau 6520: <div class="sect1">
1.1 dsieger 6521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6522: <a name="build.install"></a>19.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6523: <p>Once the build stage has completed, the final step is to
6524: install the software in public directories, so users can
6525: access the programs and files.</p>
6526: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6527: equivalent of the following code is executed. Additionally,
6528: before and after this code, much magic is performed to do
6529: consistency checks, registering the package, and so on.</p>
6530: <pre class="programlisting">
6531: .for d in ${INSTALL_DIRS}
6532: cd ${WRKSRC} \
6533: && cd ${d} \
6534: && env ${MAKE_ENV} \
6535: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6536: -f ${MAKE_FILE} \
6537: ${INSTALL_TARGET}
6538: .endfor
6539: </pre>
6540: <p>The variable's meanings are analogous to the ones in the
6541: <span class="emphasis"><em>build</em></span> phase.
6542: <code class="varname">INSTALL_DIRS</code> defaults to
6543: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 6544: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
6545: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 6546: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6547: defined.</p>
6548: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6549: variables are useful. They are all variations of the
1.174 leot 6550: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1 dsieger 6551: permissions preset. <code class="varname">INSTALL</code> is the plain
6552: install command. The specialized variants, together with their
6553: intended use, are:</p>
1.41 asau 6554: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6555: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6556: <dd><p>directories that contain
6557: binaries</p></dd>
6558: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6559: <dd><p>directories that contain
6560: scripts</p></dd>
6561: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6562: <dd><p>directories that contain shared and static
6563: libraries</p></dd>
6564: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6565: <dd><p>directories that contain data
6566: files</p></dd>
6567: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6568: <dd><p>directories that contain man
6569: pages</p></dd>
1.100 leot 6570: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
6571: <dd><p>directories that contain data files for games
6572: </p></dd>
1.1 dsieger 6573: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6574: <dd><p>binaries that can be stripped from debugging
6575: symbols</p></dd>
6576: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6577: <dd><p>binaries that cannot be
6578: stripped</p></dd>
6579: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6580: <dd><p>game
6581: binaries</p></dd>
6582: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6583: <dd><p>shared and static
6584: libraries</p></dd>
6585: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6586: <dd><p>data files</p></dd>
6587: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6588: <dd><p>data files for
6589: games</p></dd>
6590: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6591: <dd><p>man pages</p></dd>
6592: </dl></div>
6593: <p>Some other variables are:</p>
1.41 asau 6594: <div class="variablelist"><dl class="variablelist">
1.106 tnn 6595: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.174 leot 6596: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?strip+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.106 tnn 6597: when installing binaries. Any debugging sections and symbols present in
6598: binaries will be preserved.
6599: </p></dd>
1.1 dsieger 6600: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6601: <dd><p>A list of directories relative to
6602: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6603: beginning of the <span class="emphasis"><em>install</em></span> phase.
6604: The package is supposed to create all needed directories itself
6605: before installing files to it and list all other directories here.
6606: </p></dd>
6607: </dl></div>
6608: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 6609: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 6610: mostly relevant for packages in the <code class="filename">regress</code>
6611: category.</p>
6612: </div>
1.41 asau 6613: <div class="sect1">
1.1 dsieger 6614: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6615: <a name="build.package"></a>19.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6616: <p>Once the install stage has completed, a binary package of
6617: the installed files can be built. These binary packages can be
6618: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6619: the <span class="command"><strong>make bin-install</strong></span> or by using
6620: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6621: <p>By default, the binary packages are created in
6622: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6623: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6624: one for each category in the <code class="varname">CATEGORIES</code>
6625: variable. <code class="varname">PACKAGES</code> defaults to
6626: <code class="filename">pkgsrc/packages</code>.</p>
6627: </div>
1.41 asau 6628: <div class="sect1">
1.1 dsieger 6629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6630: <a name="build.clean"></a>19.16. Cleaning up</h2></div></div></div>
1.1 dsieger 6631: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 6632: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 6633: to clean the work directories of all dependencies too, use
1.10 hubertf 6634: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 6635: </div>
1.41 asau 6636: <div class="sect1">
1.1 dsieger 6637: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 6638: <a name="build.helpful-targets"></a>19.17. Other helpful targets</h2></div></div></div>
1.41 asau 6639: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6640: <dt><span class="term">pre/post-*</span></dt>
6641: <dd><p>For any of the main targets described in the
6642: previous section, two auxiliary targets exist with
1.23 wiz 6643: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.1 dsieger 6644: prefix for the main target's name. These targets are
6645: invoked before and after the main target is called,
6646: allowing extra configuration or installation steps be
6647: performed from a package's Makefile, for example, which
6648: a program's configure script or install target
6649: omitted.</p></dd>
6650: <dt><span class="term">do-*</span></dt>
6651: <dd><p>Should one of the main targets do the wrong thing,
6652: and should there be no variable to fix this, you can
6653: redefine it with the do-* target. (Note that redefining
6654: the target itself instead of the do-* target is a bad
6655: idea, as the pre-* and post-* targets won't be called
6656: anymore, etc.) You will not usually need to do
6657: this.</p></dd>
6658: <dt><span class="term">reinstall</span></dt>
6659: <dd>
1.10 hubertf 6660: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 6661: you noticed some file was not installed properly, you
6662: can repeat the installation with this target, which will
1.23 wiz 6663: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 6664: <p>This is the default value of
6665: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 6666: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 6667: package</strong></span>, where the defaults are
1.23 wiz 6668: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 6669: respectively.</p>
6670: </dd>
6671: <dt><span class="term">deinstall</span></dt>
6672: <dd>
1.174 leot 6673: <p>This target does a <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1 dsieger 6674: current directory, effectively de-installing the
6675: package. The following variables can be used to tune the
6676: behaviour:</p>
1.41 asau 6677: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6678: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.174 leot 6679: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1 dsieger 6680: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
6681: <dd><p>Remove all packages that require (depend on)
6682: the given package. This can be used to remove any
6683: packages that may have been pulled in by a given
1.10 hubertf 6684: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 6685: DEINSTALLDEPENDS=1</strong></span> is done in
6686: <code class="filename">pkgsrc/x11/kde</code>, this is
6687: likely to remove whole KDE. Works by adding
1.174 leot 6688: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1 dsieger 6689: command line.</p></dd>
6690: </dl></div>
6691: </dd>
6692: <dt><span class="term">bin-install</span></dt>
6693: <dd><p>Install a binary package from local disk and via FTP
6694: from a list of sites (see the
6695: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 6696: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 6697: available anywhere. The arguments given to
1.10 hubertf 6698: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 6699: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
6700: operation, etc.</p></dd>
1.95 wiz 6701: <dt><span class="term">install-clean</span></dt>
6702: <dd><p>This target removes the state files for the "install" and later
6703: phases so that the "install" target may be re-invoked. This can be
6704: used after editing the PLIST to install the package without
6705: rebuilding it.</p></dd>
6706: <dt><span class="term">build-clean</span></dt>
6707: <dd><p>This target removes the state files for the "build" and later
6708: phases so that the "build" target may be re-invoked.</p></dd>
1.1 dsieger 6709: <dt><span class="term">update</span></dt>
6710: <dd>
6711: <p>This target causes the current package to be
6712: updated to the latest version. The package and all
6713: depending packages first get de-installed, then current
6714: versions of the corresponding packages get compiled and
6715: installed. This is similar to manually noting which
6716: packages are currently installed, then performing a
1.10 hubertf 6717: series of <span class="command"><strong>make deinstall</strong></span> and
6718: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 6719: <code class="varname">UPDATE_TARGET</code> is set to) for these
6720: packages.</p>
1.23 wiz 6721: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 6722: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 6723: update</strong></span> was interrupted for some reason.
6724: However, in this case, make sure you don't call
1.10 hubertf 6725: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 6726: list of dependent packages in <code class="varname">WRKDIR</code>.
6727: Otherwise, you lose the ability to automatically update
6728: the current package along with the dependent packages
6729: you have installed.</p>
1.10 hubertf 6730: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 6731: update</strong></span> will only work as long as the package
6732: tree remains unchanged. If the source code for one of
6733: the packages to be updated has been changed, resuming
1.10 hubertf 6734: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 6735: fail!</p>
6736: <p>The following variables can be used either on the
1.10 hubertf 6737: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
6738: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 6739: update</strong></span>:</p>
1.41 asau 6740: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6741: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
6742: <dd><p>Install target to recursively use for the
6743: updated package and the dependent packages.
6744: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 6745: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 6746: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 6747: targets are <span class="quote">“<span class="quote">package</span>”</span> or
6748: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
6749: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 6750: endless loop!</p></dd>
6751: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
6752: <dd><p>Don't clean up after updating. Useful if
6753: you want to leave the work sources of the updated
6754: packages around for inspection or other purposes.
6755: Be sure you eventually clean up the source tree
1.23 wiz 6756: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 6757: or you may run into troubles with old source code
6758: still lying around on your next
1.10 hubertf 6759: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 6760: update</strong></span>.</p></dd>
6761: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
6762: <dd><p>Deinstall each package before installing
6763: (making <code class="varname">DEPENDS_TARGET</code>). This
6764: may be necessary if the
1.23 wiz 6765: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 6766: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 6767: update</strong></span>.</p></dd>
6768: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
6769: <dd><p>Allows you to disable recursion and hardcode
6770: the target for packages. The default is
1.23 wiz 6771: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 6772: facilitating a recursive update of prerequisite
6773: packages. Only set
6774: <code class="varname">DEPENDS_TARGET</code> if you want to
6775: disable recursive updates. Use
6776: <code class="varname">UPDATE_TARGET</code> instead to just
6777: set a specific target for each package to be
1.10 hubertf 6778: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 6779: (see above).</p></dd>
6780: </dl></div>
6781: </dd>
6782: <dt><span class="term">clean-update</span></dt>
6783: <dd>
6784: <p>Clean the source tree for all packages that would
1.10 hubertf 6785: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 6786: from the current directory. This target should not be
6787: used if the current package (or any of its depending
6788: packages) have already been de-installed (e.g., after
1.10 hubertf 6789: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 6790: some packages you intended to update. As a rule of
6791: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 6792: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 6793: and only if you have a dirty package tree (e.g., if you
6794: used <code class="varname">NOCLEAN</code>).</p>
6795: <p>If you are unsure about whether your tree is
1.10 hubertf 6796: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 6797: clean</strong></span> at the top of the tree, or use the
6798: following sequence of commands from the directory of the
6799: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 6800: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 6801: time, otherwise you lose all the packages you wanted to
6802: update!):</p>
6803: <pre class="screen">
6804: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
6805: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
6806: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
6807: </pre>
6808: <p>The following variables can be used either on the
1.10 hubertf 6809: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
6810: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 6811: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6812: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 6813: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 6814: reconstruct the list of directories to update for
1.10 hubertf 6815: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 6816: update</strong></span> successfully installed all
6817: packages you wanted to update. Normally, this is
1.10 hubertf 6818: done automatically on <span class="command"><strong>make
1.1 dsieger 6819: update</strong></span>, but may have been suppressed by
6820: the <code class="varname">NOCLEAN</code> variable (see
6821: above).</p></dd>
6822: </dl></div>
6823: </dd>
6824: <dt><span class="term">replace</span></dt>
6825: <dd>
6826: <p>Update the installation of the current package. This
6827: differs from update in that it does not replace dependent
1.137 leot 6828: 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.1 dsieger 6829: target to work.</p>
6830: <p><span class="emphasis"><em>Be careful when using this
6831: target!</em></span> There are no guarantees that dependent
6832: packages will still work, in particular they will most
1.10 hubertf 6833: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 6834: library package whose shared library major version changed
6835: between your installed version and the new one. For this
6836: reason, this target is not officially supported and only
6837: recommended for advanced users.</p>
6838: </dd>
6839: <dt><span class="term">info</span></dt>
1.174 leot 6840: <dd><p>This target invokes <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1 dsieger 6841: package. You can use this to check which version of a
6842: package is installed.</p></dd>
6843: <dt><span class="term">index</span></dt>
6844: <dd>
6845: <p>This is a top-level command, i.e. it should be used in
6846: the <code class="filename">pkgsrc</code> directory. It creates a
6847: database of all packages in the local pkgsrc tree, including
6848: dependencies, comment, maintainer, and some other useful
6849: information. Individual entries are created by running
1.10 hubertf 6850: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 6851: directories. This index file is saved as
6852: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 6853: verbose format by running <span class="command"><strong>make
1.1 dsieger 6854: print-index</strong></span>. You can search in it with
1.10 hubertf 6855: <span class="command"><strong>make search
1.1 dsieger 6856: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
6857: extract a list of all packages that depend on a particular
1.10 hubertf 6858: one by running <span class="command"><strong>make show-deps
1.1 dsieger 6859: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
6860: <p>Running this command takes a very long time, some
6861: hours even on fast machines!</p>
6862: </dd>
6863: <dt><span class="term">readme</span></dt>
6864: <dd>
6865: <p>This target generates a
6866: <code class="filename">README.html</code> file, which can be
1.137 leot 6867: 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.1 dsieger 6868: contain references to any packages which are in the
6869: <code class="varname">PACKAGES</code> directory on the local
6870: host. The generated files can be made to refer to URLs
6871: based on <code class="varname">FTP_PKG_URL_HOST</code> and
6872: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
6873: wanted to generate <code class="filename">README.html</code>
6874: files which pointed to binary packages on the local
6875: machine, in the directory
6876: <code class="filename">/usr/packages</code>, set
6877: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
6878: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
6879: <code class="varname">${PACKAGES}</code> directory and its
6880: subdirectories will be searched for all the binary
6881: packages.</p>
6882: <p>The target can be run at the toplevel or in category
6883: directories, in which case it descends recursively.</p>
6884: </dd>
6885: <dt><span class="term">readme-all</span></dt>
6886: <dd><p>This is a top-level command, run it in
6887: <code class="filename">pkgsrc</code>. Use this target to create a
6888: file <code class="filename">README-all.html</code> which contains a
6889: list of all packages currently available in the NetBSD
6890: Packages Collection, together with the category they belong
6891: to and a short description. This file is compiled from the
6892: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 6893: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 6894: readme</strong></span>.</p></dd>
6895: <dt><span class="term">cdrom-readme</span></dt>
6896: <dd><p>This is very much the same as the
1.23 wiz 6897: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 6898: used when generating a pkgsrc tree to be written to a
6899: CD-ROM. This target also produces
6900: <code class="filename">README.html</code> files, and can be made
6901: to refer to URLs based on
6902: <code class="varname">CDROM_PKG_URL_HOST</code> and
6903: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
6904: <dt><span class="term">show-distfiles</span></dt>
6905: <dd><p>This target shows which distfiles and patchfiles
6906: are needed to build the package
6907: (<code class="varname">ALLFILES</code>, which contains all
6908: <code class="varname">DISTFILES</code> and
6909: <code class="varname">PATCHFILES</code>, but not
6910: <code class="filename">patches/*</code>).</p></dd>
6911: <dt><span class="term">show-downlevel</span></dt>
6912: <dd><p>This target shows nothing if the package is not
6913: installed. If a version of this package is installed,
6914: but is not the version provided in this version of
6915: pkgsrc, then a warning message is displayed. This target
6916: can be used to show which of your installed packages are
6917: downlevel, and so the old versions can be deleted, and
6918: the current ones added.</p></dd>
6919: <dt><span class="term">show-pkgsrc-dir</span></dt>
6920: <dd><p>This target shows the directory in the pkgsrc
6921: hierarchy from which the package can be built and
6922: installed. This may not be the same directory as the one
6923: from which the package was installed. This target is
6924: intended to be used by people who may wish to upgrade
6925: many packages on a single host, and can be invoked from
6926: the top-level pkgsrc Makefile by using the
1.23 wiz 6927: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 6928: <dt><span class="term">show-installed-depends</span></dt>
6929: <dd><p>This target shows which installed packages match
6930: the current package's <code class="varname">DEPENDS</code>. Useful
6931: if out of date dependencies are causing build
6932: problems.</p></dd>
1.95 wiz 6933: <dt><span class="term">print-build-depends-list</span></dt>
6934: <dd><p>This target shows the list of packages that the current package
6935: depends on for building.</p></dd>
6936: <dt><span class="term">print-run-depends-list</span></dt>
6937: <dd><p>This target shows the list of packages that the current package
6938: depends on for running.</p></dd>
1.1 dsieger 6939: <dt><span class="term">check-shlibs</span></dt>
6940: <dd><p>After a package is installed, check all its
6941: binaries and (on ELF platforms) shared libraries to see
6942: if they find the shared libs they need. Run by default
1.10 hubertf 6943: if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1 dsieger 6944: <dt><span class="term">print-PLIST</span></dt>
6945: <dd>
1.23 wiz 6946: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 6947: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 6948: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 6949: -newer work/.extract_done</strong></span>. An attempt is made
6950: to care for shared libs etc., but it is
6951: <span class="emphasis"><em>strongly</em></span> recommended to review the
6952: result before putting it into
6953: <code class="filename">PLIST</code>. On upgrades, it's useful to
6954: diff the output of this command against an already
6955: existing <code class="filename">PLIST</code> file.</p>
1.174 leot 6956: <p>If the package installs files via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1 dsieger 6957: other methods that don't update file access times, be
6958: sure to add these files manually to your
1.23 wiz 6959: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
6960: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 6961: them!</p>
1.154 rillig 6962: <p>See <a class="xref" href="#print-PLIST" title="15.3. Tweaking output of make print-PLIST">Section 15.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.1 dsieger 6963: information on this target.</p>
6964: </dd>
6965: <dt><span class="term">bulk-package</span></dt>
6966: <dd>
6967: <p>Used to do bulk builds. If an appropriate binary
6968: package already exists, no action is taken. If not, this
6969: target will compile, install and package it (and its
6970: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.154 rillig 6971: properly. See <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.66 asau 6972: builds)</i></a>).
1.1 dsieger 6973: After creating the binary package, the sources, the
6974: just-installed package and its required packages are
6975: removed, preserving free disk space.</p>
6976: <p><span class="emphasis"><em>Beware that this target may deinstall
6977: all packages installed on a system!</em></span></p>
6978: </dd>
6979: <dt><span class="term">bulk-install</span></dt>
6980: <dd>
6981: <p>Used during bulk-installs to install required
6982: packages. If an up-to-date binary package is available,
1.174 leot 6983: it will be installed via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10 hubertf 6984: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 6985: but the installed binary won't be removed.</p>
6986: <p>A binary package is considered
1.23 wiz 6987: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.174 leot 6988: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.41 asau 6989: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6990: <li class="listitem"><p>None of the package's files
1.1 dsieger 6991: (<code class="filename">Makefile</code>, ...) were modified
6992: since it was built.</p></li>
1.23 wiz 6993: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 6994: packages were modified since it was built.</p></li>
6995: </ul></div>
6996: <p><span class="emphasis"><em>Beware that this target may deinstall
6997: all packages installed on a system!</em></span></p>
6998: </dd>
6999: </dl></div>
7000: </div>
7001: </div>
1.41 asau 7002: <div class="chapter">
1.1 dsieger 7003: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 7004: <a name="tools"></a>Chapter 20. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7005: <div class="toc">
7006: <p><b>Table of Contents</b></p>
1.100 leot 7007: <dl class="toc">
1.154 rillig 7008: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
7009: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
7010: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 7011: </dl>
7012: </div>
7013: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7014: by pkgsrc and also for individual packages to define what commands
1.156 leot 7015: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
1.1 dsieger 7016: or for later run-time of an installed packaged (such as
7017: <code class="varname">DEPENDS</code>).
7018: If the native system provides an adequate tool, then in many cases, a pkgsrc
7019: package will not be used.</p>
7020: <p>When building a package, the replacement tools are
7021: made available in a directory (as symlinks or wrapper scripts)
7022: that is early in the executable search path. Just like the buildlink
7023: system, this helps with consistent builds.</p>
7024: <p>A tool may be needed to help build a specific package. For example,
7025: perl, GNU make (gmake) or yacc may be needed.</p>
7026: <p>Also a tool may be needed, for example, because the native system's supplied
7027: tool may be inefficient for building a package with pkgsrc.
7028: For example, a package may need GNU awk, bison (instead of
7029: yacc) or a better sed.</p>
7030: <p>The tools used by a package can be listed by running
1.10 hubertf 7031: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 7032: <div class="sect1">
1.1 dsieger 7033: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7034: <a name="pkgsrc-tools"></a>20.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7035: <p>The default set of tools used by pkgsrc is defined in
7036: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 7037: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7038: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 7039: These can be seen by running:
1.10 hubertf 7040: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 7041: <p>If a package needs a specific program to build
7042: then the <code class="varname">USE_TOOLS</code> variable can be used
7043: to define the tools needed.</p>
7044: </div>
1.41 asau 7045: <div class="sect1">
1.1 dsieger 7046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7047: <a name="package-tools"></a>20.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 7048: <p>In the following examples, the :run means that it is needed at
7049: run-time (and becomes a DEPENDS).
1.1 dsieger 7050: The default is a build dependency which can be set with
7051: :build. (So in this example, it is the same as gmake:build
7052: and pkg-config:build.)</p>
7053: <pre class="programlisting">
7054: USE_TOOLS+= gmake perl:run pkg-config
7055: </pre>
7056: <p>When using the tools framework, a
7057: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7058: which contains the full path to the appropriate tool. For example,
1.23 wiz 7059: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 7060: on Linux systems.</p>
7061: <p>If you always need a pkgsrc version of the
7062: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7063: </p>
7064: </div>
1.41 asau 7065: <div class="sect1">
1.1 dsieger 7066: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7067: <a name="platform-tools"></a>20.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7068: <p>When improving or porting pkgsrc to a new platform, have a look
7069: at (or create) the corresponding platform specific make file fragment under
7070: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7071: the name of the common tools. For example:</p>
7072: <pre class="programlisting">
7073: .if exists(/usr/bin/bzcat)
7074: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7075: .elif exists(/usr/bin/bzip2)
7076: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7077: .endif
7078:
7079: TOOLS_PLATFORM.true?= true # shell builtin
7080: </pre>
7081: </div>
7082: </div>
1.41 asau 7083: <div class="chapter">
1.1 dsieger 7084: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 7085: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 7086: <div class="toc">
7087: <p><b>Table of Contents</b></p>
1.100 leot 7088: <dl class="toc">
1.154 rillig 7089: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 7090: <dd><dl>
1.154 rillig 7091: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
7092: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7093: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7094: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7095: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7096: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7097: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7098: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7099: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7100: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7101: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7102: </dl></dd>
7103: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7104: <dd><dl>
7105: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7106: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
7107: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7108: </dl></dd>
7109: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7110: <dd><dl>
7111: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7112: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7113: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
7114: </dl></dd>
7115: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7116: <dd><dl>
7117: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7118: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
7119: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
7120: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
7121: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
7122: </dl></dd>
7123: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7124: <dd><dl>
7125: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7126: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 7127: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7128: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
7129: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 7130: </dl></dd>
7131: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7132: <dd><dl>
7133: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7134: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7135: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7136: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7137: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7138: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
7139: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7140: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
7141: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
7142: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
7143: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
7144: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
7145: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
7146: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
7147: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
7148: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
7149: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
7150: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1 dsieger 7151: emulation</a></span></dt>
1.154 rillig 7152: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
7153: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7154: </dl></dd>
1.154 rillig 7155: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7156: </dl>
7157: </div>
1.41 asau 7158: <div class="sect1">
1.1 dsieger 7159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7160: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 7161: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7162: different platforms. As a result, it is important to ensure,
7163: where possible, that packages in pkgsrc are portable. This
7164: chapter mentions some particular details you should pay
7165: attention to while working on pkgsrc.</p>
1.41 asau 7166: <div class="sect2">
1.1 dsieger 7167: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7168: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 7169: </h3></div></div></div>
7170: <p>The pkgsrc user can configure pkgsrc by overriding several
7171: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7172: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7173: want to use those variables in the preprocessor directives of
1.174 leot 7174: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 7175: <code class="literal">.for</code>), you need to include the file
7176: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7177: loads the user preferences.</p>
7178: <p>But note that some variables may not be completely defined
7179: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7180: included, as they may contain references to variables that are
1.108 rillig 7181: not yet defined. In shell commands (the lines in
7182: <code class="filename">Makefile</code> that are indented with a tab) this
7183: is no problem, since variables are only expanded when they are
7184: used. But in the preprocessor directives mentioned above and in
7185: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7186: dependencies</code>) the variables are expanded at load
7187: time.</p>
1.41 asau 7188: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7189: <h3 class="title">Note</h3>
1.108 rillig 7190: <p>To check whether a variable can be used at load time,
7191: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7192: </div>
7193: </div>
1.41 asau 7194: <div class="sect2">
1.1 dsieger 7195: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7196: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7197: <p>Occasionally, packages require interaction from the user,
7198: and this can be in a number of ways:</p>
1.41 asau 7199: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7200: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7201: interaction such as entering username/password or accepting a
7202: license on a web page.</p></li>
1.23 wiz 7203: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7204: passwords.</p></li>
1.23 wiz 7205: <li class="listitem"><p>help to configure the package before it is built</p></li>
7206: <li class="listitem"><p>help during the build process</p></li>
7207: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7208: </ul></div>
1.108 rillig 7209: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7210: variable to define which stages need interaction. This should be
7211: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7212: <pre class="programlisting">
7213: INTERACTIVE_STAGE= configure install
1.111 sevan 7214: </pre>
1.1 dsieger 7215: <p>The user can then decide to skip this package by setting the
1.108 rillig 7216: <code class="varname">BATCH</code> variable. Packages that require interaction
7217: are also excluded from bulk builds.</p>
1.1 dsieger 7218: </div>
1.41 asau 7219: <div class="sect2">
1.1 dsieger 7220: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7221: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7222: <p>Authors of software can choose the licence under which software
7223: can be copied. The Free Software Foundation has declared some
7224: licenses "Free", and the Open Source Initiative has a definition of
7225: "Open Source".</p>
7226: <p>By default, pkgsrc allows packages with Free or Open Source
7227: licenses to be built. To allow packages with other licenses to be
7228: built as well, the pkgsrc user needs to add these licenses to the
7229: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7230: that this variable only affects which packages may be
7231: <span class="emphasis"><em>built</em></span>, while the license terms often also
7232: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7233: <p>One might want to only install packages with a BSD license,
1.108 rillig 7234: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7235: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7236: user can override the default by setting the
7237: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7238: of "+=". The licenses accepted by default are defined in the
7239: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7240: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7241: <p>The license tag mechanism is intended to address
7242: copyright-related issues surrounding building, installing and
7243: using a package, and not to address redistribution issues (see
7244: <code class="varname">RESTRICTED</code> and
1.111 sevan 7245: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7246: Packages with redistribution restrictions should set these
7247: tags.</p>
1.1 dsieger 7248: <p>Denoting that a package may be copied according to a
7249: particular license is done by placing the license in
7250: <code class="filename">pkgsrc/licenses</code> and setting the
7251: <code class="varname">LICENSE</code> variable to a string identifying the
1.137 leot 7252: 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.1 dsieger 7253: <pre class="programlisting">
7254: LICENSE= xv-license
1.111 sevan 7255: </pre>
1.1 dsieger 7256: <p>When trying to build, the user will get a notice that the
7257: package is covered by a license which has not been placed in the
7258: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7259: <pre class="programlisting">
7260: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7261: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7262: ===> To view the license, enter "/usr/bin/make show-license".
7263: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7264: ===> ACCEPTABLE_LICENSES+=xv-license
7265: *** Error code 1
1.111 sevan 7266: </pre>
1.10 hubertf 7267: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7268: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7269: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7270: convey to pkgsrc that it should not in the future fail because of
7271: that license:</p>
7272: <pre class="programlisting">
7273: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7274: </pre>
7275: <p>The use of <code class="varname">LICENSE=shareware</code>,
7276: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7277: is deprecated because it does not crisply refer to a particular
7278: license text. Another problem with such usage is that it does not
7279: enable a user to tell pkgsrc to proceed for a single package
7280: without also telling pkgsrc to proceed for all packages with that
7281: tag.</p>
7282: <div class="sect3">
7283: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7284: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7285: <p>When adding a package with a new license, the following steps
7286: are required:</p>
7287: <div class="orderedlist"><ol class="orderedlist" type="1">
7288: <li class="listitem">
1.169 rillig 7289: <p>Check whether the license qualifies as Free or Open Source by
7290: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7291: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7292: Open Source Initiative</a>. If this is the case, the filename in
7293: <code class="filename">pkgsrc/licenses/</code> does not need the
7294: <code class="filename">-license</code> suffix, and the license name should be
7295: added to:</p>
1.48 rodent 7296: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7297: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7298: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7299: <li class="listitem"><p>default_acceptable_licenses in
7300: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7301: </ul></div>
7302: </li>
1.169 rillig 7303: <li class="listitem"><p>The license text should be added to
7304: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7305: licenses can be seen in this directory.</p></li>
1.48 rodent 7306: </ol></div>
1.111 sevan 7307: </div>
7308: <div class="sect3">
7309: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7310: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7311: <p>When the license changes (in a way other than formatting),
1.111 sevan 7312: make sure that the new license has a different name (e.g.,
1.1 dsieger 7313: append the version number if it exists, or the date). Just
7314: because a user told pkgsrc to build programs under a previous
7315: version of a license does not mean that pkgsrc should build
7316: programs under the new licenses. The higher-level point is that
7317: pkgsrc does not evaluate licenses for reasonableness; the only
7318: test is a mechanistic test of whether a particular text has been
1.111 sevan 7319: approved by either of two bodies (FSF or OSI).</p>
7320: </div>
1.1 dsieger 7321: </div>
1.41 asau 7322: <div class="sect2">
1.1 dsieger 7323: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7324: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7325: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7326: By declaring the restrictions, package tools can
1.1 dsieger 7327: automatically refrain from e.g. placing binary packages on FTP
7328: sites.</p>
1.111 sevan 7329: <p>There are four possible restrictions, which are
1.1 dsieger 7330: the cross product of sources (distfiles) and binaries not being
7331: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7332: language in any license, and because non-Free licenses tend to be
7333: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7334: CD-ROM.
7335:
7336: "FTP" means making the source or binary file available over the
7337: Internet at no charge.
7338:
7339: "CD-ROM" means making the source or binary available on some kind of
7340: media, together with other source and binary packages, which is sold
7341: for a distribution charge.
1.1 dsieger 7342: </p>
7343: <p>In order to encode these restrictions, the package system
7344: defines five make variables that can be set to note these
7345: restrictions:</p>
1.41 asau 7346: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7347: <li class="listitem">
1.1 dsieger 7348: <p><code class="varname">RESTRICTED</code></p>
7349: <p>This variable should be set whenever a restriction
7350: exists (regardless of its kind). Set this variable to a
7351: string containing the reason for the restriction. It should
7352: be understood that those wanting to understand the restriction
7353: will have to read the license, and perhaps seek advice of
7354: counsel.</p>
7355: </li>
1.23 wiz 7356: <li class="listitem">
1.1 dsieger 7357: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7358: <p>Binaries may not be placed on CD-ROM containing other
7359: binary packages, for which a distribution charge may be made.
7360: In this case, set this variable to
7361: <code class="varname">${RESTRICTED}</code>.</p>
7362: </li>
1.23 wiz 7363: <li class="listitem">
1.1 dsieger 7364: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7365: <p>Binaries may not made available on the Internet without
7366: charge. In this case, set this variable to
7367: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7368: binary packages will not be included on ftp.NetBSD.org.</p>
7369: </li>
1.23 wiz 7370: <li class="listitem">
1.1 dsieger 7371: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7372: <p>Distfiles may not be placed on CD-ROM, together with
7373: other distfiles, for which a fee may be charged. In this
7374: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7375: </p>
7376: </li>
1.23 wiz 7377: <li class="listitem">
1.1 dsieger 7378: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7379: <p>Distfiles may not made available via FTP at no charge.
7380: In this case, set this variable to
7381: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7382: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7383: </li>
7384: </ul></div>
1.111 sevan 7385: <p>Please note that packages will be removed from pkgsrc when the
7386: distfiles are not distributable and cannot be obtained for a period
7387: of one full quarter branch. Packages with manual/interactive fetch
7388: must have a maintainer and it is his/her responsibility to ensure
7389: this.</p>
1.1 dsieger 7390: </div>
1.41 asau 7391: <div class="sect2">
1.1 dsieger 7392: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7393: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175 gutterid 7394: <p>Your package may depend on some other package being present,
7395: and there are various ways of expressing this dependency.
7396: pkgsrc supports the <code class="varname">DEPENDS</code>,
7397: <code class="varname">BUILD_DEPENDS</code>,
7398: <code class="varname">TOOL_DEPENDS</code>, and
7399: <code class="varname">TEST_DEPENDS</code> definitions, the
1.1 dsieger 7400: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7401: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7402: to handle dependencies, and which uses the variables named above.
1.154 rillig 7403: See <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a> for more information.</p>
1.175 gutterid 7404: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7405: definition registers that pre-requisite in the binary package so it
7406: will be pulled in when the binary package is later installed, whilst
7407: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7408: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7409: dependency that is only needed for building or testing the resulting
7410: package. See also <a class="xref" href="#creating" title="Chapter 12. Creating a new pkgsrc package from scratch">Chapter 12, <i>Creating a new pkgsrc package from scratch</i></a> for more information.</p>
1.1 dsieger 7411: <p>This means that if you only need a package present whilst
1.175 gutterid 7412: you are building or testing, it should be noted as a
7413: <code class="varname">TOOL_DEPENDS</code>,
7414: <code class="varname">BUILD_DEPENDS</code>, or
7415: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.156 leot 7416: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7417: packages, i.e. packages for the architecture where the package
7418: is built;
7419: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175 gutterid 7420: packages, i.e., packages for the architecture for which the package
1.156 leot 7421: is built.</p>
1.175 gutterid 7422: <p>The format for a <code class="varname">DEPENDS</code>,
7423: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7424: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1 dsieger 7425: <pre class="programlisting">
7426: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7427: </pre>
1.23 wiz 7428: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7429: may include any of the wildcard version numbers recognized by
1.174 leot 7430: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7431: <div class="orderedlist"><ol class="orderedlist" type="1">
7432: <li class="listitem">
1.1 dsieger 7433: <p>If your package needs another package's binaries or
1.54 wiz 7434: libraries to build and run, and if that package has a
1.1 dsieger 7435: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7436: <pre class="programlisting">
7437: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7438: </pre>
1.1 dsieger 7439: </li>
1.23 wiz 7440: <li class="listitem">
1.54 wiz 7441: <p>If your package needs another package's binaries or
7442: libraries only for building, and if that package has a
7443: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7444: <pre class="programlisting">
7445: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7446: </pre>
1.54 wiz 7447: <p>but set
7448: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7449: to make it a build dependency only. This case is rather
7450: rare.</p>
7451: </li>
7452: <li class="listitem">
1.25 spz 7453: <p>If your package needs binaries from another package to build,
1.156 leot 7454: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7455: <pre class="programlisting">
1.156 leot 7456: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7457: </pre>
1.1 dsieger 7458: </li>
1.156 leot 7459: <li class="listitem"><p>If your package needs static libraries to link against, header
7460: files to include, etc. from another package to build,
7461: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7462: <li class="listitem"><p>If your package needs a library with which to link and
7463: there is no <code class="filename">buildlink3.mk</code> file
7464: available, create one. Using
7465: <code class="varname">DEPENDS</code> won't be sufficient because the
7466: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7467: <li class="listitem">
1.25 spz 7468: <p>If your package needs some executable to be able to run
7469: correctly and if there's no
7470: <code class="filename">buildlink3.mk</code> file, this is specified
7471: using the <code class="varname">DEPENDS</code> variable. The
1.137 leot 7472: <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.129 wiz 7473: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7474: when it runs, and that is specified:</p>
1.1 dsieger 7475: <pre class="programlisting">
1.129 wiz 7476: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7477: </pre>
1.25 spz 7478: </li>
1.175 gutterid 7479: <li class="listitem"><p>If your package includes a test suite that has extra
7480: dependencies only required for this purpose (frequently this
7481: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7482: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25 spz 7483: <li class="listitem">
7484: <p>You can use wildcards in package dependencies. Note that
7485: such wildcard dependencies are retained when creating binary
7486: packages. The dependency is checked when installing the binary
7487: package and any package which matches the pattern will be
7488: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7489: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7490: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7491: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7492: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7493: <p>Wildcards can also be used to specify that a package
7494: will only build against a certain minimum version of a
7495: pre-requisite:</p>
7496: <pre class="programlisting">
1.25 spz 7497: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7498: </pre>
1.25 spz 7499: <p>This means that the package will build using version 6.0
7500: of ImageMagick or newer. Such a dependency may be warranted
7501: if, for example, the command line options of an executable
7502: have changed.</p>
7503: <p>If you need to depend on minimum versions of libraries,
7504: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 7505: <p>For security fixes, please update the package
1.154 rillig 7506: vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, “Handling packages with security problems”</a> for more
1.1 dsieger 7507: information.</p>
7508: </li>
7509: </ol></div>
7510: <p>If your package needs files from another package to build,
7511: add the relevant distribution files to
7512: <code class="varname">DISTFILES</code>, so they will be extracted
1.137 leot 7513: 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.1 dsieger 7514: (It relies on the jpeg sources being present in source form
7515: during the build.)</p>
7516: </div>
1.41 asau 7517: <div class="sect2">
1.1 dsieger 7518: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7519: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7520: <p>Your package may conflict with other packages a user might
7521: already have installed on his system, e.g. if your package
7522: installs the same set of files as another package in the pkgsrc
1.80 wiz 7523: tree or has the same <code class="varname">PKGNAME</code>.</p>
1.142 leot 7524: <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>
7525: 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>
7526: install the same shared library, thus you set in
7527: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7528: <pre class="programlisting">
7529: CONFLICTS= Xaw-Xpm-[0-9]*
7530: </pre>
7531: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7532: <pre class="programlisting">
7533: CONFLICTS= libXaw3d-[0-9]*
7534: </pre>
1.174 leot 7535: <p><a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.142 leot 7536: that conflict with existing packages and abort. However, in many
7537: situations this is too late in the process. Binary package managers
7538: will not know about the conflict until they attempt to install the
7539: package after already downloading it and all its dependencies.
7540: Users may also waste time building a package and its dependencies
7541: only to find out at the end that it conflicts with another package
7542: they have installed.</p>
7543: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7544: should be added in all cases where it is known that packages conflict
7545: with each other. These <code class="varname">CONFLICTS</code> entries are
1.174 leot 7546: exported in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.142 leot 7547: managers to inform users that packages cannot be installed onto
7548: the target system.</p>
1.1 dsieger 7549: </div>
1.41 asau 7550: <div class="sect2">
1.1 dsieger 7551: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7552: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7553: <p>There are several reasons why a package might be
7554: instructed to not build under certain circumstances. If the
7555: package builds and runs on most platforms, the exceptions
1.83 dholland 7556: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7557: the package builds and runs on a small handful of platforms,
7558: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7559: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7560: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7561: (OS-version-platform) that can use glob-style
7562: wildcards.</p>
7563: <p>If a package is not appropriate for some platforms (as
1.114 maya 7564: opposed to merely broken), a different set of variables should be
1.83 dholland 7565: used as this affects failure reporting and statistics.
7566: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7567: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7568: the package is appropriate for only a small handful of platforms
7569: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7570: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7571: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7572: (OS-version-platform) that can use glob-style
7573: wildcards.</p>
7574: <p>Some packages are tightly bound to a specific version of an
1.137 leot 7575: 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.1 dsieger 7576: backwards compatible with other versions of the OS, and should be
7577: uploaded to a version specific directory on the FTP server. Mark
7578: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7579: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7580: the package system internals, but may be used in the
7581: future.</p>
7582: <p>If the package should be skipped (for example, because it
7583: provides functionality already provided by the system), set
7584: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7585: the package should fail because some preconditions are not met,
7586: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7587: message.</p>
7588: </div>
1.41 asau 7589: <div class="sect2">
1.1 dsieger 7590: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7591: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7592: <p>To ensure that a package may not be deleted, once it has been
7593: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7594: be set in the package Makefile. This will be carried into any
7595: binary package that is made from this pkgsrc entry. A
1.23 wiz 7596: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.174 leot 7597: not be deleted using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 7598: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7599: </div>
1.41 asau 7600: <div class="sect2">
1.1 dsieger 7601: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7602: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7603: <p>When a vulnerability is found, this should be noted in
7604: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 7605: and after committing that file, ask pkgsrc-security@NetBSD.org to
7606: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7607: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7608: <code class="varname">PKGREVISION</code> should be increased (this is of
7609: course not necessary if the problem is fixed by using a newer
7610: release of the software), and the pattern in the
7611: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7612: <p>Also, if the fix should be applied to the stable pkgsrc
7613: branch, be sure to submit a pullup request!</p>
7614: <p>Binary packages already on ftp.NetBSD.org will be handled
7615: semi-automatically by a weekly cron job.</p>
7616: </div>
1.41 asau 7617: <div class="sect2">
1.1 dsieger 7618: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7619: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 7620: <p>When making fixes to an existing package it can be useful
7621: to change the version number in <code class="varname">PKGNAME</code>. To
7622: avoid conflicting with future versions by the original author, a
1.23 wiz 7623: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.1 dsieger 7624: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7625: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7626: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7627: <pre class="programlisting">
7628: DISTNAME= foo-17.42
7629: PKGREVISION= 9
1.111 sevan 7630: </pre>
1.1 dsieger 7631: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7632: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7633: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7634: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7635: <code class="varname">PKGNAME_NOREV</code>.</p>
7636: <p>When a new release of the package is released, the
7637: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7638: minor release of the above package, things should be like:</p>
7639: <pre class="programlisting">
7640: DISTNAME= foo-17.43
1.111 sevan 7641: </pre>
1.1 dsieger 7642: <p><code class="varname">PKGREVISION</code> should be incremented for any
7643: non-trivial change in the resulting binary package. Without a
7644: <code class="varname">PKGREVISION</code> bump, someone with the previous
7645: version installed has no way of knowing that their package is out
7646: of date. Thus, changes without increasing
7647: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7648: trivial that no reasonable person would want to upgrade", and this
7649: is the rough test for when increasing
7650: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7651: changes that do not merit increasing
7652: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7653: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7654: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 7655: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7656: comments in Makefile.</p></li>
7657: <li class="listitem"><p>Changing build variables if the resulting binary
7658: package is the same.</p></li>
7659: <li class="listitem"><p>Changing
7660: <code class="filename">DESCR</code>.</p></li>
7661: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7662: default options don't change.</p></li>
1.1 dsieger 7663: </ul></div>
7664: <p>Examples of changes that do merit an increase to
7665: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7666: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7667: <li class="listitem"><p>Security fixes</p></li>
7668: <li class="listitem"><p>Changes or additions to a patch
7669: file</p></li>
7670: <li class="listitem"><p>Changes to the
7671: <code class="filename">PLIST</code></p></li>
7672: <li class="listitem"><p>A dependency is changed or
7673: renamed.</p></li>
1.1 dsieger 7674: </ul></div>
7675: <p>PKGREVISION must also be incremented when dependencies have ABI
7676: changes.</p>
7677: </div>
1.41 asau 7678: <div class="sect2">
1.1 dsieger 7679: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7680: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.180 ! rillig 7681: <p>When you want to replace the same text in multiple files, or
! 7682: multiple times in the same file, it is cumbersome to maintain a patch
! 7683: file for this. This is where the SUBST framework steps in. It provides an
! 7684: easy-to-use interface for replacing text in files. It just needs the
! 7685: following information:</p>
! 7686: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
! 7687: <li class="listitem"><p>In which phase of the package build cycle should the
! 7688: replacement happen?</p></li>
! 7689: <li class="listitem"><p>In which files should the replacement
1.172 rillig 7690: happen?</p></li>
1.180 ! rillig 7691: <li class="listitem"><p>Which text should be replaced with
! 7692: what?</p></li>
1.172 rillig 7693: </ul></div>
7694: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180 ! rillig 7695: variables. A minimal example is:</p>
! 7696: <pre class="programlisting">
! 7697: SUBST_CLASSES+= paths
! 7698: SUBST_STAGE.paths= pre-configure
! 7699: SUBST_FILES.paths= src/*.c
! 7700: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
! 7701: </pre>
! 7702: <p>Translated into English, it means: In the pre-configure stage (that
! 7703: is, after applying the patches from the patches/ directory and before
! 7704: running the configure script and the portability check), replace the text
! 7705: <code class="literal">/usr/local</code> with the content of the variable
! 7706: <code class="varname">PREFIX</code>.</p>
! 7707: <p>Each SUBST block starts by appending an identifier to
! 7708: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
! 7709: identifier can be chosen freely by the package. If there should ever be
! 7710: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
! 7711: early, so don't worry about name collisions.</p>
! 7712: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
! 7713: SUBST block are parameterized using this identifier. In the remainder of
! 7714: this section, these parameterized variables are written as
! 7715: <code class="varname">SUBST_STAGE.*</code>.</p>
! 7716: <pre class="programlisting">
! 7717: SUBST_CLASSES+= paths
! 7718: SUBST_STAGE.paths= pre-configure
! 7719: SUBST_MESSAGE.paths= Fixing absolute paths.
! 7720: SUBST_FILES.paths= src/*.c
! 7721: SUBST_FILES.paths+= scripts/*.sh
! 7722: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
! 7723: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
! 7724: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
! 7725: </pre>
! 7726: <p>To get a complete picture about the SUBST substitutions, run
! 7727: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
! 7728: expected, run pkglint on the package, which detects several typical
! 7729: mistakes surrounding the SUBST blocks. For any questions that might
! 7730: remain after this, have a look at
! 7731: <code class="filename">mk/subst.mk</code>.</p>
! 7732: <div class="sect3">
! 7733: <div class="titlepage"><div><div><h4 class="title">
! 7734: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
! 7735: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
! 7736: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
! 7737: <code class="literal">pre-configure</code> is used most often, by far. The most
! 7738: popular stages are, in chronological order:</p>
! 7739: <div class="variablelist"><dl class="variablelist">
! 7740: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
! 7741: <dd>
! 7742: <p>The substitutions are applied immediately after the
! 7743: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
! 7744: package will leave no traces of the original files.</p>
! 7745: <p>When the substitution applies to files for which there is also a
! 7746: patch in the <code class="filename">patches/</code> directory, this means that the
! 7747: patches will be computed based on the result of the substitution. When
! 7748: these patches are sent to the upstream maintainer later, to be fixed in
! 7749: the upstream package, these patches may no longer match what the upstream
! 7750: author is used to. Because of this, <code class="literal">pre-configure</code> is
! 7751: often a better choice.</p>
! 7752: </dd>
! 7753: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
! 7754: <dd>
! 7755: <p>The substitutions are applied after the patches from the
! 7756: <code class="filename">patches/</code> directory. This makes it possible to run
! 7757: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
! 7758: can be edited using the tools pkgvi and mkpatches 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.</p>
! 7759: <p>When updating the patches, it is helpful to explicitly separate the
! 7760: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
! 7761: configure</strong></span>, and to only edit the patches between these commands.
! 7762: Otherwise the substitutions from the SUBST block will end up in the patch
! 7763: file. When this happens in really obvious ways, pkglint will complain
! 7764: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
! 7765: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
! 7766: can only detect these really obvious
! 7767: cases.</p>
! 7768: </dd>
! 7769: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
! 7770: <dd><p>This stage should only be used if the package defines a
! 7771: <code class="literal">pre-configure</code> action itself, and the substitution must
! 7772: happen after that. Typical examples are packages that use the
! 7773: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
! 7774: script from
! 7775: <code class="filename">configure.ac</code>.</p></dd>
! 7776: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
! 7777: <dd><p>This stage is used to fix up any mistakes by the
! 7778: configure stage.</p></dd>
! 7779: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
! 7780: <dd><p>This stage should only be used for substitutions that are
! 7781: clearly related to building the package, not for fixing the
! 7782: configuration. Substitutions for pathnames (such as replacing
! 7783: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
! 7784: user names (such as replacing <code class="literal">@MY_USER@</code> with the
! 7785: actual username) belong in pre-configure or post-configure
! 7786: instead.</p></dd>
! 7787: <dt><span class="term"><code class="literal">post-build</code></span></dt>
! 7788: <dd>
! 7789: <p>Just as with pre-build, this stage should only be used
! 7790: for substitutions that are clearly related to building the package, not
! 7791: for fixing the configuration. Substitutions for pathnames (such as
! 7792: replacing <code class="filename">/usr/local</code> with
! 7793: <code class="literal">${PREFIX}</code>) or user names (such as replacing
! 7794: <code class="literal">@MY_USER@</code> with the actual username) belong in
! 7795: pre-configure or post-configure instead.</p>
! 7796: <p>A typical use is to update pkg-config files to include the rpath
! 7797: compiler options.</p>
! 7798: </dd>
! 7799: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
! 7800: <dd><p>In general, the install phase should be as simple as
! 7801: possible. As with the pre-build and post-build stages, it should not be
! 7802: used to fix pathnames or user names, these belong in pre-configure
! 7803: instead. There are only few legitimate use cases for applying
! 7804: substitutions in this stage.</p></dd>
! 7805: </dl></div>
! 7806: </div>
! 7807: <div class="sect3">
! 7808: <div class="titlepage"><div><div><h4 class="title">
! 7809: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the time where the substitutions happen</h4></div></div></div>
! 7810: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
! 7811: filename patterns. These patterns are relative to
! 7812: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
! 7813: A typical example is:</p>
! 7814: <pre class="programlisting">
! 7815: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
! 7816: </pre>
! 7817: <p>The above patterns, especially the last, are quite broad. The SUBST
! 7818: implementation checks that each filename pattern that is mentioned here
! 7819: has an effect. For example, if none of the
! 7820: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
! 7821: and substituted, that filename pattern is redundant and should be left
! 7822: out. If the text to be substituted occurs in some of the files from a
! 7823: single pattern, but not in all of them, that is totally ok, and the SUBST
! 7824: framework will only print an INFO message for those files.</p>
! 7825: <p>If there is a good reason for having redundant filename patterns,
! 7826: set <code class="varname">SUBST_NOOP_OK.path=yes</code> in the above
! 7827: example.</p>
! 7828: <p>Another popular way of choosing the files for the substitutions is
! 7829: via a shell command, like this:</p>
! 7830: <pre class="programlisting">
! 7831: C_FILES_CMD= cd ${WRKSRC} && ${FIND} -name '*.c'
! 7832: SUBST_FILES.path= ${C_FILES_CMD:sh}
! 7833: </pre>
! 7834: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
! 7835: freely chosen and independent of the SUBST framework.</p>
! 7836: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
! 7837: lists each file individually. Thereby chances are higher that there are
! 7838: filename patterns in which no substitution happens. Since the SUBST
! 7839: framework cannot know whether the filename patterns in
! 7840: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
! 7841: Makefile (where any redundant filename pattern would be suspicious) or
! 7842: been generated by a shell command (in which redundant filename patterns
! 7843: are more likely and to be expected), it will complain about these
! 7844: redundant filename patterns. Therefore, SUBST blocks that use a shell
! 7845: command to generate the list of filename patterns often need to set
! 7846: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
! 7847: </div>
! 7848: <div class="sect3">
! 7849: <div class="titlepage"><div><div><h4 class="title">
! 7850: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
! 7851: <p>In most cases, the substitutions are given using one or more
! 7852: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
! 7853: <pre class="programlisting">
! 7854: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
! 7855: </pre>
! 7856: <p>Each of the sed commands needs to be preceded by the
! 7857: <code class="literal">-e</code> option and should be specified on a line of its
! 7858: own, to avoid hiding short sed commands at the end of a line.</p>
! 7859: <p>Since the sed commands often contain shell metacharacters as the
! 7860: separator (the <code class="literal">|</code> in the above example), it is common
! 7861: to enclose them in single quotes.</p>
! 7862: <p>A common substitution is to replace placeholders of the form
! 7863: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
! 7864: <code class="literal">${VARNAME}</code>. A typical example is:</p>
! 7865: <pre class="programlisting">
! 7866: SUBST_VARS.path= PREFIX
! 7867: </pre>
! 7868: <p>This type of substitutions is typically done by the GNU configure
! 7869: scripts, but in some cases these need to be overridden. The same pattern
! 7870: is also used when a package defines patches that replace previously
! 7871: hard-coded paths like <code class="literal">/usr/local</code> with a
! 7872: <code class="literal">@PREFIX@</code> placeholder first, which then gets
! 7873: substituted by the actual <code class="literal">${PREFIX}</code> in the
! 7874: pre-configure stage. In many of these cases, it works equally well to
! 7875: just use the SUBST framework to directly replace
! 7876: <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>, thereby
! 7877: omitting the intermediate patch file.</p>
! 7878: <p>If the above is not flexible enough, it is possible to not use sed
! 7879: at all for the substitution but to specify an entirely different command,
! 7880: like this:</p>
1.1 dsieger 7881: <pre class="programlisting">
1.180 ! rillig 7882: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
! 7883: </pre>
! 7884: <p>This is used for the few remaining packages in which the
! 7885: distributed files use Windows-style line endings that need to be
! 7886: converted to UNIX-style line endings.</p>
! 7887: </div>
! 7888: <div class="sect3">
! 7889: <div class="titlepage"><div><div><h4 class="title">
! 7890: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
! 7891: <p>When a SUBST block is applied during a package build, a message is
! 7892: logged. The default message is fine for most purposes but can be
! 7893: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
! 7894: message.</p>
! 7895: </div>
1.1 dsieger 7896: </div>
7897: </div>
1.41 asau 7898: <div class="sect1">
1.1 dsieger 7899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7900: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 7901: <div class="sect2">
1.1 dsieger 7902: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7903: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 7904: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 7905: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 7906: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
7907: with the name of each file to download as an argument, expecting
7908: it to output the URL of the directory from which to download
1.137 leot 7909: 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.1 dsieger 7910: example of this usage.</p>
7911: <p>If the download can't be automated, because the user must
7912: submit personal information to apply for a password, or must pay
7913: for the source, or whatever, you can set
7914: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
7915: displayed to the user before aborting the build. Example:</p>
7916: <pre class="programlisting">
7917: FETCH_MESSAGE= "Please download the files"
7918: FETCH_MESSAGE+= " "${DISTFILES:Q}
7919: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 7920: </pre>
1.1 dsieger 7921: </div>
1.41 asau 7922: <div class="sect2">
1.1 dsieger 7923: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7924: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1 dsieger 7925: <p>Sometimes authors of a software package make some
7926: modifications after the software was released, and they put up a
7927: new distfile without changing the package's version number. If a
7928: package is already in pkgsrc at that time, the checksum will
7929: no longer match. The contents of the new distfile should be
7930: compared against the old one before changing anything, to make
7931: sure the distfile was really updated on purpose, and that
7932: no trojan horse or so crept in.
7933: Please mention that the distfiles were compared and what was found
1.53 rodent 7934: in your commit message.</p>
1.109 wiz 7935: <p>Then, the correct way to work around this is to set
7936: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
7937: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
7938: python or ruby packages, where <code class="varname">PKGNAME</code> includes
7939: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 7940: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 7941: subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, “How to handle incrementing versions when fixing an existing package”</a> for more details.) In case this
1.1 dsieger 7942: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 7943: including the <code class="filename">nbX</code> suffix) or a date stamp can
7944: be appended, like
7945: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 7946: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
7947: name does not contain a version and the distfile is apt to change. In
7948: cases where the likelihood of this is very small,
7949: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
7950: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
7951: distfile name changes, even if a package is being moved or
7952: renamed.</p>
1.53 rodent 7953: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 7954: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
7955: path in the filenames.
1.53 rodent 7956: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 7957: Furthermore, a mail to the package's authors seems appropriate
7958: telling them that changing distfiles after releases without
7959: changing the file names is not good practice.</p>
7960: </div>
1.88 tnn 7961: <div class="sect2">
7962: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7963: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 7964: <p>Helper methods exist for packages hosted on github.com which
7965: will often have distfile names that clash with other packages, for
7966: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
7967: from below:</p>
1.88 tnn 7968: <div class="sect3">
7969: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7970: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 7971: <p>If your distfile URL looks similar to
1.174 leot 7972: <code class="literal">https://github.com/username/exampleproject/archive/v1.0.zip</code>,
1.169 rillig 7973: then you are packaging a tagged release.</p>
1.88 tnn 7974: <pre class="programlisting">
7975: DISTNAME= exampleproject-1.0
1.90 tnn 7976: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
7977: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7978: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 7979: EXTRACT_SUFX= .zip
7980: </pre>
7981: </div>
7982: <div class="sect3">
7983: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7984: <a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
1.169 rillig 7985: <p>If your distfile URL looks similar to
1.174 leot 7986: <code class="literal">https://github.com​/example​/example​/archive​/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>,
1.169 rillig 7987: then you are packaging a specific commit not tied to a
7988: release.</p>
1.88 tnn 7989: <pre class="programlisting">
7990: DISTNAME= example-1.0
1.107 jnemeth 7991: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 7992: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
7993: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 7994: </pre>
1.88 tnn 7995: </div>
7996: <div class="sect3">
7997: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7998: <a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
1.169 rillig 7999: <p>If your distfile URL looks similar to
1.174 leot 8000: <code class="literal">https://github.com​/username/exampleproject​/releases​/download​/rel-1.6​/offensive-1.6.zip</code>,
1.169 rillig 8001: then you are packaging a release.</p>
1.88 tnn 8002: <pre class="programlisting">
8003: DISTNAME= offensive-1.6
1.90 tnn 8004: PKGNAME= ${DISTNAME:S/offensive/proper/}
8005: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8006: GITHUB_PROJECT= exampleproject
8007: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8008: EXTRACT_SUFX= .zip
1.111 sevan 8009: </pre>
1.88 tnn 8010: </div>
8011: </div>
1.1 dsieger 8012: </div>
1.41 asau 8013: <div class="sect1">
1.1 dsieger 8014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8015: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8016: <div class="sect2">
1.1 dsieger 8017: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8018: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8019: <p>pkgsrc supports many different machines, with different
8020: object formats like a.out and ELF, and varying abilities to do
8021: shared library and dynamic loading at all. To accompany this,
8022: varying commands and options have to be passed to the
8023: compiler, linker, etc. to get the Right Thing, which can be
8024: pretty annoying especially if you don't have all the machines
8025: at your hand to test things. The
1.137 leot 8026: <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.23 wiz 8027: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8028: both static and dynamic libraries from a set of source files,
8029: thus being platform-independent.</p>
8030: <p>Here's how to use libtool in a package in seven simple
8031: steps:</p>
1.23 wiz 8032: <div class="orderedlist"><ol class="orderedlist" type="1">
8033: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8034: Makefile.</p></li>
1.23 wiz 8035: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8036: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8037: add it to the definition of <code class="varname">CC</code>, if only
8038: libraries are being built in a given Makefile. This one command
8039: will build both PIC and non-PIC library objects, so you need not
8040: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8041: <li class="listitem">
1.1 dsieger 8042: <p>For the linking of the library, remove any
1.23 wiz 8043: <span class="quote">“<span class="quote">ar</span>”</span>, <span class="quote">“<span class="quote">ranlib</span>”</span>, and <span class="quote">“<span class="quote">ld
8044: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8045: <pre class="programlisting">
8046: ${LIBTOOL} --mode=link \
8047: ${CC} -o ${.TARGET:.a=.la} \
8048: ${OBJS:.o=.lo} \
8049: -rpath ${PREFIX}/lib \
8050: -version-info major:minor
1.111 sevan 8051: </pre>
1.1 dsieger 8052: <p>Note that the library is changed to have a
8053: <code class="filename">.la</code> extension, and the objects are
8054: changed to have a <code class="filename">.lo</code>
8055: extension. Change <code class="varname">OBJS</code> as
8056: necessary. This automatically creates all of the
8057: <code class="filename">.a</code>,
8058: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8059: necessary) in the build directory. Be sure to include
1.23 wiz 8060: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8061: minor are zero, as libtool will otherwise strip off the
8062: shared library version.</p>
8063: <p>From the libtool manual:</p>
8064: <pre class="programlisting">
8065: So, libtool library versions are described by three integers:
8066:
8067: CURRENT
8068: The most recent interface number that this library implements.
8069:
8070: REVISION
8071: The implementation number of the CURRENT interface.
8072:
8073: AGE
8074: The difference between the newest and oldest interfaces that
8075: this library implements. In other words, the library implements
8076: all the interface numbers in the range from number `CURRENT -
8077: AGE' to `CURRENT'.
8078:
8079: If two libraries have identical CURRENT and AGE numbers, then the
8080: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 8081: </pre>
1.23 wiz 8082: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8083: different results for a.out and ELF (excluding symlinks)
8084: in only one case. An ELF library of the form
1.23 wiz 8085: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8086: will have a symlink of
1.23 wiz 8087: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8088: on an a.out platform. This is handled
8089: automatically.</p>
1.23 wiz 8090: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8091: directory of the library being built.</p>
8092: <p>In the <code class="filename">PLIST</code>, include only the
8093: <code class="filename">.la</code> file, the other files will be
8094: added automatically.</p>
8095: </li>
1.23 wiz 8096: <li class="listitem">
1.1 dsieger 8097: <p>When linking shared object (<code class="filename">.so</code>)
1.174 leot 8098: files, i.e. files that are loaded via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 8099: shared libraries, use <span class="quote">“<span class="quote">-module
8100: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8101: tacked on.</p>
8102: <p>The <code class="filename">PLIST</code> file gets the
8103: <code class="filename">foo.so</code> entry.</p>
8104: </li>
1.23 wiz 8105: <li class="listitem">
1.1 dsieger 8106: <p>When linking programs that depend on these libraries
8107: <span class="emphasis"><em>before</em></span> they are installed, preface
1.174 leot 8108: the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ld+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8109: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8110: libraries (static or shared), but please be aware that
8111: libtool will not allow you to specify a relative path in
1.23 wiz 8112: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8113: expects you to change that argument to be the
8114: <code class="filename">.la</code> file. e.g.</p>
8115: <pre class="programlisting">
8116: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 8117: </pre>
1.1 dsieger 8118: <p>should be changed to:</p>
8119: <pre class="programlisting">
8120: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 8121: </pre>
1.1 dsieger 8122: <p>and it will do the right thing with the libraries.</p>
8123: </li>
1.23 wiz 8124: <li class="listitem">
1.174 leot 8125: <p>When installing libraries, preface the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8126: or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8127: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8128: <code class="filename">.la</code>. e.g.</p>
8129: <pre class="programlisting">
1.22 jakllsch 8130: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 8131: </pre>
1.1 dsieger 8132: <p>This will install the static <code class="filename">.a</code>,
8133: shared library, any needed symlinks, and run
1.174 leot 8134: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 8135: </li>
1.23 wiz 8136: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8137: the <code class="filename">.la</code>
8138: file (this is a change from previous behaviour).</p></li>
8139: </ol></div>
8140: </div>
1.41 asau 8141: <div class="sect2">
1.1 dsieger 8142: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8143: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8144: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8145: package Makefile. This will override the package's own libtool
8146: in most cases. For older libtool using packages, libtool is
8147: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8148: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8149: configure; find work*/ -name libtool</strong></span>.</p>
8150: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8151: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8152: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8153: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8154: package's libtool script(s), set it as appropriate.</p>
8155: <p>If you do not need <code class="filename">*.a</code> static
8156: libraries built and installed, then use
8157: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8158: <p>If your package makes use of the platform-independent library
8159: for loading dynamic shared objects, that comes with libtool
8160: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8161: <p>Some packages use libtool incorrectly so that the package
8162: may not work or build in some circumstances. Some of the more
8163: common errors are:</p>
1.41 asau 8164: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8165: <li class="listitem">
1.1 dsieger 8166: <p>The inclusion of a shared object (-module) as a dependent library in an
8167: executable or library. This in itself isn't a problem if one of two things
8168: has been done:</p>
1.23 wiz 8169: <div class="orderedlist"><ol class="orderedlist" type="1">
8170: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8171: <code class="filename">libfoo.la</code>, not
8172: <code class="filename">foo.la</code></p></li>
1.23 wiz 8173: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8174: </ol></div>
8175: </li>
1.23 wiz 8176: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8177: The function lt_dlinit() should be called and the macro
8178: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8179: executables.</p></li>
8180: </ul></div>
8181: </div>
1.41 asau 8182: <div class="sect2">
1.1 dsieger 8183: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8184: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8185: <p>If a package needs GNU autoconf or automake to be executed
8186: to regenerate the configure script and Makefile.in makefile
8187: templates, then they should be executed in a pre-configure
8188: target.</p>
8189: <p>For packages that need only autoconf:</p>
8190: <pre class="programlisting">
8191: AUTOCONF_REQD= 2.50 # if default version is not good enough
8192: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8193: ...
8194:
8195: pre-configure:
8196: cd ${WRKSRC} && autoconf
8197:
8198: ...
1.111 sevan 8199: </pre>
1.1 dsieger 8200: <p>and for packages that need automake and autoconf:</p>
8201: <pre class="programlisting">
8202: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8203: USE_TOOLS+= automake # use "automake14" for automake-1.4
8204: ...
8205:
8206: pre-configure:
8207: set -e; cd ${WRKSRC}; \
8208: aclocal; autoheader; automake -a --foreign -i; autoconf
8209:
8210: ...
1.111 sevan 8211: </pre>
1.1 dsieger 8212: <p>Packages which use GNU Automake will almost certainly
8213: require GNU Make.</p>
8214: <p>There are times when the configure process makes
8215: additional changes to the generated files, which then causes
8216: the build process to try to re-execute the automake sequence.
8217: This is prevented by touching various files in the configure
8218: stage. If this causes problems with your package you can set
8219: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8220: Makefile.</p>
8221: </div>
8222: </div>
1.41 asau 8223: <div class="sect1">
1.1 dsieger 8224: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8225: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 8226: <div class="sect2">
1.1 dsieger 8227: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8228: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8229: <p>Compilers for the C, C++, and Fortran languages comes with
8230: the NetBSD base system. By default, pkgsrc assumes that a package
8231: is written in C and will hide all other compilers (via the wrapper
1.154 rillig 8232: framework, see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8233: <p>To declare which language's compiler a package needs, set
8234: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 8235: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8236: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8237: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8238: written in C++, usually need a C compiler for the configure
8239: phase.</p>
8240: </div>
1.41 asau 8241: <div class="sect2">
1.1 dsieger 8242: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8243: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 8244: <p>If a program is written in Java, use the Java framework in
8245: pkgsrc. The package must include
8246: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8247: provides the following variables:</p>
1.41 asau 8248: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8249: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8250: dependency on the JDK is added. If
1.23 wiz 8251: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8252: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8253: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8254: JDK.</p></li>
1.23 wiz 8255: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8256: a package needs a Java2 implementation. The supported values
1.23 wiz 8257: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8258: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8259: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8260: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8261: above. This variable is not set by default.</p></li>
1.24 wiz 8262: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8263: automatically set to the runtime location of the used Java
8264: implementation dependency. It may be used to set
8265: <code class="varname">JAVA_HOME</code> to a good value if the program
8266: needs this variable to be defined.
8267: </p></li>
1.1 dsieger 8268: </ul></div>
8269: </div>
1.41 asau 8270: <div class="sect2">
1.1 dsieger 8271: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8272: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8273: <p>If your package contains interpreted perl scripts, add
1.23 wiz 8274: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8275: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8276: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8277: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8278: that you want adjusted. Every occurrence of
8279: <code class="filename">*/bin/perl</code> in a she-bang line will be
8280: replaced with the full path to the perl executable.</p>
1.1 dsieger 8281: <p>If a particular version of perl is needed, set the
8282: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8283: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.154 rillig 8284: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing perl modules">Section 21.6.6, “Packages installing perl modules”</a> for information
1.1 dsieger 8285: about handling perl modules.</p>
8286: </div>
1.41 asau 8287: <div class="sect2">
1.1 dsieger 8288: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8289: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 8290: <p><code class="varname">REPLACE_SH</code>,
8291: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8292: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8293: hash bangs in files. Please use the appropriate one, prefering
8294: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74 wiz 8295: Each should contain a list of scripts, relative to
8296: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8297: occurrence of the matching shell in a she-bang line will be
8298: replaced with the full path to the shell executable.
1.40 wiz 8299: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8300: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8301: </div>
1.41 asau 8302: <div class="sect2">
1.40 wiz 8303: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8304: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 8305: <p>Currently, there is no special handling for other languages
8306: in pkgsrc. If a compiler package provides a
8307: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8308: just add a (build) dependency on the appropriate compiler
8309: package.</p>
8310: </div>
8311: </div>
1.41 asau 8312: <div class="sect1">
1.1 dsieger 8313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8314: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8315: <p>The most common failures when building a package are that
8316: some platforms do not provide certain header files, functions or
8317: libraries, or they provide the functions in a library that the
8318: original package author didn't know. To work around this, you
8319: can rewrite the source code in most cases so that it does not
8320: use the missing functions or provides a replacement function.</p>
1.41 asau 8321: <div class="sect2">
1.1 dsieger 8322: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8323: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8324: <p>If a package already comes with a GNU configure script, the
8325: preferred way to fix the build failure is to change the
8326: configure script, not the code. In the other cases, you can
8327: utilize the C preprocessor, which defines certain macros
8328: depending on the operating system and hardware architecture it
8329: compiles for. These macros can be queried using for example
8330: <code class="varname">#if defined(__i386)</code>. Almost every operating
8331: system, hardware architecture and compiler has its own macro.
8332: For example, if the macros <code class="varname">__GNUC__</code>,
8333: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8334: are all defined, you know that you are using NetBSD on an i386
8335: compatible CPU, and your compiler is GCC.</p>
8336: <p>The list of the following macros for hardware and
8337: operating system depends on the compiler that is used. For
8338: example, if you want to conditionally compile code on Solaris,
8339: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8340: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8341: <div class="sect3">
1.1 dsieger 8342: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8343: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1 dsieger 8344: <p>To distinguish between 4.4 BSD-derived systems and the
8345: rest of the world, you should use the following code.</p>
8346: <pre class="programlisting">
8347: #include <sys/param.h>
8348: #if (defined(BSD) && BSD >= 199306)
8349: /* BSD-specific code goes here */
8350: #else
8351: /* non-BSD-specific code goes here */
8352: #endif
8353: </pre>
8354: <p>If this distinction is not fine enough, you can also test
8355: for the following macros.</p>
8356: <pre class="programlisting">
1.45 obache 8357: Cygwin __CYGWIN__
8358: DragonFly __DragonFly__
1.1 dsieger 8359: FreeBSD __FreeBSD__
1.45 obache 8360: Haiku __HAIKU__
1.1 dsieger 8361: Interix __INTERIX
8362: IRIX __sgi (TODO: get a definite source for this)
8363: Linux linux, __linux, __linux__
1.83 dholland 8364: Mac OS X __APPLE__
1.45 obache 8365: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8366: Minix3 __minix
1.1 dsieger 8367: NetBSD __NetBSD__
8368: OpenBSD __OpenBSD__
8369: Solaris sun, __sun
8370: </pre>
8371: </div>
1.41 asau 8372: <div class="sect3">
1.1 dsieger 8373: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8374: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1 dsieger 8375: <pre class="programlisting">
8376: i386 i386, __i386, __i386__
8377: MIPS __mips
8378: SPARC sparc, __sparc
8379: </pre>
8380: </div>
1.41 asau 8381: <div class="sect3">
1.1 dsieger 8382: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8383: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1 dsieger 8384: <pre class="programlisting">
8385: GCC __GNUC__ (major version), __GNUC_MINOR__
8386: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8387: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8388: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8389: </pre>
8390: </div>
8391: </div>
1.41 asau 8392: <div class="sect2">
1.1 dsieger 8393: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8394: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8395: <p>Some source files trigger bugs in the compiler, based on
8396: combinations of compiler version and architecture and almost
8397: always relation to optimisation being enabled. Common symptoms
8398: are gcc internal errors or never finishing compiling a
8399: file.</p>
8400: <p>Typically, a workaround involves testing the
8401: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8402: optimisation for that combination of file,
1.87 tnn 8403: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8404: <p>This used to be a big problem in the past, but is rarely
8405: needed now as compiler technology has matured. If you still need
8406: to add a compiler specific workaround, please do so in the file
8407: <code class="filename">hacks.mk</code> and describe the symptom and
8408: compiler version as detailed as possible.</p>
1.1 dsieger 8409: </div>
1.41 asau 8410: <div class="sect2">
1.1 dsieger 8411: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8412: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8413: <p>Compilation sometimes fails with an error message like this:</p>
8414: <pre class="programlisting">
8415: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8416: fatal error: pango/pango.h: No such file or directory
8417: </pre>
8418: <p>The proper way to fix this problem depends on the type of the
8419: header, which is described in the following sections.</p>
8420: <div class="sect3">
8421: <div class="titlepage"><div><div><h4 class="title">
8422: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8423: <p>If the header name looks like it comes from a different package,
8424: that other package should be included via the buildlink3
8425: framework.</p>
8426: <p>First, look whether the header is somewhere in the buildlink3
8427: directory below <code class="varname">WRKDIR</code>. In the above case of
8428: the missing Pango header:</p>
8429: <pre class="programlisting">
8430: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8431: </pre>
8432: <p>In the case of Pango, the output is:</p>
8433: <pre class="programlisting">
8434: work/.buildlink/include/pango-1.0/pango/pango.h
8435: </pre>
8436: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8437: in the <code class="filename">.buildlink</code> directory, it would have been
8438: found automatically. There is an extra <code class="filename">pango-1.0</code>
8439: path component though, which means that the compiler command line must
8440: contain an option of the form
8441: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8442: most cases this option is generated by the configure script, which can be examined using:</p>
8443: <pre class="programlisting">
8444: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8445: -I/usr/pkg/include/pango-1.0
8446: -I/usr/pkg/include/pango-1.0
8447: -I/usr/pkg/include/pango-1.0
8448: -I/usr/pkg/include/pango-1.0
8449: -I/usr/pkg/include/pango-1.0
8450: </pre>
8451: <p>This looks good. These options are transformed by the buildlink
8452: wrapper to refer to the correct path inside
8453: <code class="filename">work/.buildlink</code>.</p>
8454: <p>Since the compilation fails though, examine the compiler command
8455: lines in <code class="filename">work/.work.log</code> to see whether the
8456: <code class="literal">-I</code> option is included in the particular command
8457: line.</p>
8458: <p>To further analyze the situation, run <span class="command"><strong>bmake
8459: build-env</strong></span>, which sets up an interactive, realistic environment
8460: including all the pkgsrc wrapper commands and environment variables. From
8461: there, try to compile some simple example programs that use the
8462: header.</p>
8463: </div>
8464: <div class="sect3">
8465: <div class="titlepage"><div><div><h4 class="title">
8466: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8467: <p>If the name of the header seems to come from the package itself,
8468: and if the build is run with parallel jobs, the package may have some
8469: undeclared dependencies between the <code class="filename">.c</code> and the
8470: <code class="filename">.h</code> files, and a C file is compiled before its
8471: required header is generated.</p>
8472: <p>To see whether the build runs with parallel jobs, run
8473: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8474: like this:</p>
8475: <pre class="programlisting">
8476: usr MAKE_JOBS= 7
8477: pkg MAKE_JOBS_SAFE # undefined
8478: def _MAKE_JOBS_N= 7
8479: </pre>
8480: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8481: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8482: package could have disabled parallel builds by setting
8483: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8484: in this case it hasn't.</p>
8485: <p>To see whether the build failure is caused by parallel builds,
8486: first save the exact error message and a bit of context, maybe you need
8487: it later for reporting a bug. Next, run:</p>
8488: <pre class="programlisting">
8489: MAKE_JOBS_SAFE=no bmake clean build
8490: </pre>
8491: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8492: report</a> against the pkgsrc package, including the exact error
8493: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8494: </div>
1.173 rillig 8495: <div class="sect3">
8496: <div class="titlepage"><div><div><h4 class="title">
8497: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8498: <p>Pkgsrc does not work reliably if any of
8499: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8500: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8501: bootstrap program prevents installing pkgsrc in symlink-based
8502: directories. Existing pkgsrc installations are not checked for symlinks
8503: though.</p>
8504: <p>The "No such file or directory" error messages are a typical
8505: symptom of symlinks, and it's quite difficult to find out that this is
8506: the actual cause.</p>
8507: </div>
8508: <div class="sect3">
8509: <div class="titlepage"><div><div><h4 class="title">
8510: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8511: <p>When building a hierarchy of packages, it may happen that one
8512: package is built and then pkgsrc is updated. This situation can provoke
8513: various hard to diagnose build errors. To clean up the situation:</p>
8514: <pre class="programlisting">
8515: <code class="prompt">$</code> (cd ../../ && test -f mk/bsd.pkg.mk && rm -rf */*/work)
8516: </pre>
8517: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
8518: this command in the wrong directory.)</p>
8519: <p>If you have set <code class="varname">WRKOBJDIR</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, remove
8520: that directory as well.</p>
8521: </div>
8522: <div class="sect3">
8523: <div class="titlepage"><div><div><h4 class="title">
8524: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
8525: <p>On platforms other than BSD, third-party packages are installed in
8526: <code class="filename">/usr/include</code>, together with the base system. This
8527: means that pkgsrc cannot distinguish between headers provided by the base
8528: system (which it needs) and headers from third-party packages (which are
8529: often included in pkgsrc as well). This can lead to subtle version
8530: mismatches.</p>
8531: <p>In pkgsrc installations that have been active for several years, it
8532: may happen that some files are manually deleted. To exclude this unlikely
8533: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
8534: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
8535: check/fix dependencies.</p>
8536: <p>If all of the above doesn't help, see <a class="xref" href="#help-user" title="Chapter 2. Getting help">Chapter 2, <i>Getting help</i></a>
8537: for contact information. Be prepared to describe what you have tried so
8538: far and what any error messages were.</p>
8539: </div>
1.172 rillig 8540: </div>
8541: <div class="sect2">
8542: <div class="titlepage"><div><div><h3 class="title">
8543: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 8544: </h3></div></div></div>
1.1 dsieger 8545: <p>This error message often means that a package did not
8546: link to a shared library it needs. The following functions are
8547: known to cause this error message over and over.</p>
8548: <div class="informaltable">
1.106 tnn 8549: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 8550: <colgroup>
8551: <col>
8552: <col>
8553: <col>
8554: </colgroup>
8555: <thead><tr>
8556: <th>Function</th>
8557: <th>Library</th>
8558: <th>Affected platforms</th>
8559: </tr></thead>
8560: <tbody>
8561: <tr>
8562: <td>accept, bind, connect</td>
8563: <td>-lsocket</td>
8564: <td>Solaris</td>
8565: </tr>
8566: <tr>
8567: <td>crypt</td>
8568: <td>-lcrypt</td>
8569: <td>DragonFly, NetBSD</td>
8570: </tr>
8571: <tr>
8572: <td>dlopen, dlsym</td>
8573: <td>-ldl</td>
8574: <td>Linux</td>
8575: </tr>
8576: <tr>
8577: <td>gethost*</td>
8578: <td>-lnsl</td>
8579: <td>Solaris</td>
8580: </tr>
8581: <tr>
8582: <td>inet_aton</td>
8583: <td>-lresolv</td>
8584: <td>Solaris</td>
8585: </tr>
8586: <tr>
8587: <td>nanosleep, sem_*, timer_*</td>
8588: <td>-lrt</td>
8589: <td>Solaris</td>
8590: </tr>
8591: <tr>
8592: <td>openpty</td>
8593: <td>-lutil</td>
8594: <td>Linux</td>
8595: </tr>
8596: </tbody>
8597: </table>
8598: </div>
8599: <p>To fix these linker errors, it is often sufficient to say
8600: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8601: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8602: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8603: bmake</strong></span>.</p>
1.41 asau 8604: <div class="sect3">
1.1 dsieger 8605: <div class="titlepage"><div><div><h4 class="title">
1.172 rillig 8606: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8607: <p>When you are using the SunPro compiler, there is another
8608: possibility. That compiler cannot handle the following code:</p>
8609: <pre class="programlisting">
8610: extern int extern_func(int);
8611:
8612: static inline int
8613: inline_func(int x)
8614: {
8615: return extern_func(x);
8616: }
8617:
8618: int main(void)
8619: {
8620: return 0;
8621: }
8622: </pre>
8623: <p>It generates the code for <code class="function">inline_func</code> even if
8624: that function is never used. This code then refers to
8625: <code class="function">extern_func</code>, which can usually not be resolved. To
8626: solve this problem you can try to tell the package to disable inlining
8627: of functions.</p>
8628: </div>
8629: </div>
1.41 asau 8630: <div class="sect2">
1.1 dsieger 8631: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8632: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 8633: <p>Sometimes packages fail to build because the compiler runs
8634: into an operating system specific soft limit. With the
8635: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94 wiz 8636: to unlimit the resources. Currently, the allowed values are any combination of
8637: <span class="quote">“<span class="quote">cputime</span>”</span>, <span class="quote">“<span class="quote">datasize</span>”</span>,
8638: <span class="quote">“<span class="quote">memorysize</span>”</span>, and <span class="quote">“<span class="quote">stacksize</span>”</span>.
1.1 dsieger 8639: Setting this variable is similar to running the shell builtin
1.10 hubertf 8640: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8641: segment size or maximum stack size of a process, respectively, to
8642: their hard limits.</p>
8643: </div>
8644: </div>
1.41 asau 8645: <div class="sect1">
1.1 dsieger 8646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8647: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 8648: <div class="sect2">
1.1 dsieger 8649: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8650: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8651: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8652: with some operating systems cannot create more than one
8653: directory at a time. As such, you should call
8654: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8655: <pre class="programlisting">
8656: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8657: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 8658: </pre>
1.23 wiz 8659: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8660: dir2</code></span>”</span> to the
1.1 dsieger 8661: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8662: automatically do the right thing.</p>
8663: </div>
1.41 asau 8664: <div class="sect2">
1.1 dsieger 8665: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8666: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8667: <p>In general, documentation should be installed into
8668: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8669: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8670: includes the version number of the package).</p>
8671: <p>Many modern packages using GNU autoconf allow to set the
8672: directory where HTML documentation is installed with the
1.23 wiz 8673: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8674: is needed because otherwise the documentation ends up in
8675: <code class="filename">${PREFIX}/share/doc/html</code> or other
8676: places.</p>
8677: <p>An exception to the above is that library API documentation
1.137 leot 8678: 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.1 dsieger 8679: browsers (devhelp) should be left at their default location, which
8680: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8681: documentation can be recognized from files ending in
8682: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8683: (It is also acceptable to install such files in
8684: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8685: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8686: <code class="filename">.devhelp*</code> file must be directly in that
8687: directory then, no additional subdirectory level is allowed in
8688: this case. This is usually achieved by using
1.23 wiz 8689: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8690: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8691: though.)</p>
8692: </div>
1.41 asau 8693: <div class="sect2">
1.1 dsieger 8694: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8695: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8696: <p>Certain packages, most of them in the games category, install
8697: a score file that allows all users on the system to record their
8698: highscores. In order for this to work, the binaries need to be
8699: installed setgid and the score files owned by the appropriate
1.35 wiz 8700: group and/or owner (traditionally the "games" user/group). Set
8701: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8702: following variables, documented in more detail in
8703: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8704: behaviour: <code class="varname">GAMEDATAMODE</code>,
8705: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 8706: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
8707: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
8708: <code class="varname">GAMEDATA_PERMS</code> and
8709: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
8710: <p>An example that illustrates some of the variables described above is
8711: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
8712: used to properly set directory permissions of the directory where the
8713: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
8714: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
8715: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
8716: binary:</p>
8717: <pre class="programlisting">
1.112 rillig 8718: USE_GAMESGROUP= yes
1.100 leot 8719:
1.112 rillig 8720: BUILD_DEFS+= VARBASE
1.100 leot 8721:
1.112 rillig 8722: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
8723: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
8724: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 8725: </pre>
1.100 leot 8726: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
8727: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
8728: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
8729: needed to be accessed by setgid games and
8730: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 8731: <p>A package should therefore never hard code file ownership or
1.100 leot 8732: access permissions but rely on <code class="varname">*_PERMS</code> as described above
8733: or alternatively on <code class="varname">INSTALL_GAME</code>,
8734: <code class="varname">INSTALL_GAME_DATA</code> and
8735: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 8736: </div>
1.41 asau 8737: <div class="sect2">
1.1 dsieger 8738: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8739: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8740: <p><code class="varname">DESTDIR</code> support means that a package
8741: installs into a staging directory, not the final location of the
8742: files. Then a binary package is created which can be used for
8743: installation as usual. There are two ways: Either the package must
1.23 wiz 8744: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8745: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8746: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8747: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 8748: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
8749: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 8750: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8751: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8752: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8753: the inclusion.</p></li>
1.23 wiz 8754: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8755: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8756: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8757: automatically. Many manual rules and pre/post-install often are
8758: incorrect; fix them.</p></li>
1.23 wiz 8759: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8760: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8761: <li class="listitem"><p>In general, packages should support
1.4 rillig 8762: <code class="varname">UNPRIVILEGED</code> to be able to use
8763: DESTDIR.</p></li>
8764: </ul></div>
8765: </div>
1.41 asau 8766: <div class="sect2">
1.4 rillig 8767: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8768: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8769: <p>Your package may also contain scripts with hardcoded paths to
8770: other interpreters besides (or as well as) perl. To correct the
8771: full pathname to the script interpreter, you need to set the
8772: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8773: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8774: <pre class="programlisting">
8775: REPLACE_INTERPRETER+= tcl
8776: REPLACE.tcl.old= .*/bin/tclsh
8777: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8778: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8779: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 8780: </pre>
1.41 asau 8781: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8782: <h3 class="title">Note</h3>
8783: <p>Before March 2006, these variables were called
8784: <code class="varname">_REPLACE.*</code> and
8785: <code class="varname">_REPLACE_FILES.*</code>.</p>
8786: </div>
8787: </div>
1.41 asau 8788: <div class="sect2">
1.1 dsieger 8789: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8790: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8791: <p>Makefiles of packages providing perl5 modules should include
8792: the Makefile fragment
8793: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8794: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8795: configuration for such modules as well as various hooks to tune
8796: this configuration. See comments in this file for
8797: details.</p>
8798: <p>Perl5 modules will install into different places depending
8799: on the version of perl used during the build process. To
8800: address this, pkgsrc will append lines to the
8801: <code class="filename">PLIST</code> corresponding to the files listed in
8802: the installed <code class="filename">.packlist</code> file generated by
8803: most perl5 modules. This is invoked by defining
8804: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 8805: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
8806: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
8807: e.g.:</p>
1.1 dsieger 8808: <pre class="programlisting">
1.47 wiz 8809: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 8810: </pre>
1.47 wiz 8811: <p>The perl5 config variables
8812: <code class="varname">installarchlib</code>,
8813: <code class="varname">installscript</code>,
8814: <code class="varname">installvendorbin</code>,
8815: <code class="varname">installvendorscript</code>,
8816: <code class="varname">installvendorarch</code>,
8817: <code class="varname">installvendorlib</code>,
8818: <code class="varname">installvendorman1dir</code>, and
8819: <code class="varname">installvendorman3dir</code> represent those
8820: locations in which components of perl5 modules may be installed,
8821: provided as variable with uppercase and prefixed with
8822: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
8823: and may be used by perl5 packages that don't have a packlist.
8824: These variables are also substituted for in the
8825: <code class="filename">PLIST</code> as uppercase prefixed with
8826: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 8827: </div>
1.41 asau 8828: <div class="sect2">
1.1 dsieger 8829: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8830: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8831: <p>Some packages install info files or use the
1.23 wiz 8832: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8833: commands. <code class="varname">INFO_FILES</code> should be defined in
8834: the package Makefile so that <code class="filename">INSTALL</code> and
8835: <code class="filename">DEINSTALL</code> scripts will be generated to
8836: handle registration of the info files in the Info directory
1.23 wiz 8837: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8838: files registration is either provided by the system, or by a
8839: special purpose package automatically added as dependency if
8840: needed.</p>
8841: <p><code class="varname">PKGINFODIR</code> is the directory under
8842: <code class="filename">${PREFIX}</code> where info files are primarily
8843: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8844: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8845: <p>The info files for the package should be listed in the
8846: package <code class="filename">PLIST</code>; however any split info files
8847: need not be listed.</p>
1.23 wiz 8848: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8849: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8850: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8851: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8852: should be noted with the <code class="varname">TEXINFO_REQD</code>
8853: variable in the package <code class="filename">Makefile</code>. By
8854: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8855: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8856: does not match the required minimum, a build dependency on the
1.137 leot 8857: <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.1 dsieger 8858: be added automatically.</p>
8859: <p>The build and installation process of the software provided
8860: by the package should not use the
1.10 hubertf 8861: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8862: info files is the task of the package
8863: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8864: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8865: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8866: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8867: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8868: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8869: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8870: no effect except the logging of a message. The script overriding
1.10 hubertf 8871: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8872: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8873: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8874: </div>
1.41 asau 8875: <div class="sect2">
1.1 dsieger 8876: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8877: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8878: <p>All packages that install manual pages should install them
8879: into the same directory, so that there is one common place to look
8880: for them. In pkgsrc, this place is
8881: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8882: should be used in packages. The default for
8883: <code class="varname">PKGMANDIR</code> is
1.23 wiz 8884: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
8885: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 8886: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8887: <h3 class="title">Note</h3>
8888: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8889: is far from complete.</p>
8890: </div>
8891: <p>The <code class="filename">PLIST</code> files can just use
8892: <code class="filename">man/</code> as the top level directory for the man
8893: page file entries, and the pkgsrc framework will convert as
8894: needed. In all other places, the correct
8895: <code class="varname">PKGMANDIR</code> must be used.</p>
8896: <p>Packages that are
8897: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 8898: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 8899: <code class="filename">./configure</code>
8900: --mandir switch to set where the man pages should be installed.
8901: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8902: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8903: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8904: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 8905: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 8906: Or if the <code class="filename">./configure</code> script uses
8907: a non-standard use of --mandir, you can set
8908: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.154 rillig 8909: <p>See <a class="xref" href="#manpage-compression" title="15.5. Man page compression">Section 15.5, “Man page compression”</a> for
1.1 dsieger 8910: information on installation of compressed manual pages.</p>
8911: </div>
1.41 asau 8912: <div class="sect2">
1.1 dsieger 8913: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8914: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8915: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8916: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8917: you need to take some extra steps to make sure they get registered
8918: in the database:</p>
1.23 wiz 8919: <div class="orderedlist"><ol class="orderedlist" type="1">
8920: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8921: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8922: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8923: deinstallation time, and tells the package where to install
1.7 rillig 8924: GConf data files using some standard configure arguments. It
1.1 dsieger 8925: also disallows any access to the database directly from the
8926: package.</p></li>
1.23 wiz 8927: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 8928: <code class="filename">.schemas</code> files under
8929: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8930: installed under <code class="filename">${PREFIX}/etc</code>, you will
8931: need to manually patch the package.</p></li>
1.23 wiz 8932: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 8933: directory, as they will be handled automatically. See
1.154 rillig 8934: <a class="xref" href="#faq.conf" title="10.13. How do I change the location of configuration files?">Section 10.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.23 wiz 8935: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8936: your <code class="filename">Makefile</code> with a list of all
8937: <code class="filename">.schemas</code> files installed by the package, if
8938: any. Names must not contain any directories in them.</p></li>
1.23 wiz 8939: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8940: your <code class="filename">Makefile</code> with a
8941: list of all <code class="filename">.entries</code> files installed by the
8942: package, if any. Names must not contain any directories in
8943: them.</p></li>
8944: </ol></div>
8945: </div>
1.41 asau 8946: <div class="sect2">
1.1 dsieger 8947: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8948: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 8949: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 8950: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 8951: get registered in the database:</p>
1.23 wiz 8952: <div class="orderedlist"><ol class="orderedlist" type="1">
8953: <li class="listitem"><p>Include
1.18 snj 8954: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
8955: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 8956: takes care of rebuilding the scrollkeeper database at
8957: installation and deinstallation time, and disallows any access
8958: to it directly from the package.</p></li>
1.23 wiz 8959: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 8960: <code class="filename">libdata/scrollkeeper</code> directory, as they
8961: will be handled automatically.</p></li>
1.23 wiz 8962: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 8963: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
8964: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 8965: </ol></div>
8966: </div>
1.41 asau 8967: <div class="sect2">
1.1 dsieger 8968: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8969: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8970: <p>If a package installs font files, you will need to rebuild
8971: the fonts database in the directory where they get installed at
8972: installation and deinstallation time. This can be automatically
8973: done by using the pkginstall framework.</p>
8974: <p>You can list the directories where fonts are installed in the
8975: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8976: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 8977: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.1 dsieger 8978: Also make sure that the database file
8979: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8980: <p>Note that you should not create new directories for fonts;
8981: instead use the standard ones to avoid that the user needs to
8982: manually configure his X server to find them.</p>
8983: </div>
1.41 asau 8984: <div class="sect2">
1.1 dsieger 8985: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8986: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8987: <p>If a package installs GTK2 immodules or loaders, you need to
8988: take some extra steps to get them registered in the GTK2 database
8989: properly:</p>
1.23 wiz 8990: <div class="orderedlist"><ol class="orderedlist" type="1">
8991: <li class="listitem"><p>Include
1.1 dsieger 8992: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8993: <code class="filename">buildlink3.mk</code> file. This takes care of
8994: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 8995: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 8996: your package installs GTK2 immodules.</p></li>
1.23 wiz 8997: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 8998: GTK2 loaders.</p></li>
1.23 wiz 8999: <li class="listitem">
1.1 dsieger 9000: <p>Patch the package to not touch any of the GTK2
9001: databases directly. These are:</p>
1.41 asau 9002: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9003: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9004: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 9005: </ul></div>
9006: </li>
1.23 wiz 9007: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 9008: any entries under the <code class="filename">libdata/gtk-2.0</code>
9009: directory, as they will be handled automatically.</p></li>
9010: </ol></div>
9011: </div>
1.41 asau 9012: <div class="sect2">
1.1 dsieger 9013: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9014: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9015: <p>If a package installs SGML or XML data files that need to be
9016: registered in system-wide catalogs (like DTDs, sub-catalogs,
9017: etc.), you need to take some extra steps:</p>
1.23 wiz 9018: <div class="orderedlist"><ol class="orderedlist" type="1">
9019: <li class="listitem"><p>Include
1.1 dsieger 9020: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9021: your <code class="filename">Makefile</code>, which takes care of
9022: registering those files in system-wide catalogs at
9023: installation and deinstallation time.</p></li>
1.23 wiz 9024: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9025: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9026: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9027: any XML catalogs installed by the package.</p></li>
1.23 wiz 9028: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9029: to be added to the SGML catalog. These come in groups of
9030: three strings; see xmlcatmgr(1) for more information
9031: (specifically, arguments recognized by the 'add' action).
9032: Note that you will normally not use this variable.</p></li>
1.23 wiz 9033: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9034: to be added to the XML catalog. These come in groups of three
9035: strings; see xmlcatmgr(1) for more information (specifically,
9036: arguments recognized by the 'add' action). Note that you will
9037: normally not use this variable.</p></li>
9038: </ol></div>
9039: </div>
1.41 asau 9040: <div class="sect2">
1.1 dsieger 9041: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9042: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9043: <p>If a package provides extensions to the MIME database by
9044: installing <code class="filename">.xml</code> files inside
9045: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9046: need to take some extra steps to ensure that the database is kept
9047: consistent with respect to these new files:</p>
1.23 wiz 9048: <div class="orderedlist"><ol class="orderedlist" type="1">
9049: <li class="listitem"><p>Include
1.1 dsieger 9050: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9051: (avoid using the <code class="filename">buildlink3.mk</code> file from
9052: this same directory, which is reserved for inclusion from
9053: other <code class="filename">buildlink3.mk</code> files). It takes
9054: care of rebuilding the MIME database at installation and
9055: deinstallation time, and disallows any access to it directly
9056: from the package.</p></li>
1.23 wiz 9057: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9058: <code class="filename">share/mime</code> directory,
9059: <span class="emphasis"><em>except</em></span> for files saved under
9060: <code class="filename">share/mime/packages</code>. The former are
9061: handled automatically by
9062: the update-mime-database program, but the latter are
9063: package-dependent and must be removed by the package that
9064: installed them in the first place.</p></li>
1.23 wiz 9065: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9066: from the PLIST. They will be handled by the shared-mime-info
9067: package.</p></li>
9068: </ol></div>
9069: </div>
1.41 asau 9070: <div class="sect2">
1.1 dsieger 9071: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9072: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9073: <p>If a package uses intltool during its build, add
9074: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9075: which forces it to use the intltool package provided by pkgsrc,
9076: instead of the one bundled with the distribution file.</p>
9077: <p>This tracks intltool's build-time dependencies and uses the
9078: latest available version; this way, the package benefits of any
9079: bug fixes that may have appeared since it was released.</p>
9080: </div>
1.41 asau 9081: <div class="sect2">
1.1 dsieger 9082: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9083: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9084: <p>If a package contains a rc.d script, it won't be copied into
9085: the startup directory by default, but you can enable it, by adding
9086: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9087: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9088: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9089: it will automatically remove the scripts when the package is
9090: deinstalled.</p>
9091: </div>
1.41 asau 9092: <div class="sect2">
1.1 dsieger 9093: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9094: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9095: <p>If a package installs TeX packages into the texmf tree,
9096: the <code class="filename">ls-R</code> database of the tree needs to be
9097: updated.</p>
1.41 asau 9098: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9099: <h3 class="title">Note</h3>
1.22 jakllsch 9100: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9101: packages should install files
1.22 jakllsch 9102: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9103: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9104: </div>
1.23 wiz 9105: <div class="orderedlist"><ol class="orderedlist" type="1">
9106: <li class="listitem"><p>Include
1.22 jakllsch 9107: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9108: takes care of rebuilding the <code class="filename">ls-R</code>
9109: database at installation and deinstallation time.</p></li>
1.23 wiz 9110: <li class="listitem">
1.1 dsieger 9111: <p>If your package installs files into a texmf
9112: tree other than the one
1.22 jakllsch 9113: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9114: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9115: trees that need database update.</p>
9116: <p>If your package also installs font map files that need
1.10 hubertf 9117: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9118: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9119: set <code class="varname">TEX_MAP_FILES</code> and/or
9120: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9121: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9122: be run automatically at installation/deinstallation to
9123: enable/disable font map files for TeX output
9124: drivers.</p>
9125: </li>
1.23 wiz 9126: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9127: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9128: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9129: </ol></div>
9130: </div>
1.41 asau 9131: <div class="sect2">
1.1 dsieger 9132: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9133: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.1 dsieger 9134: emulation</h3></div></div></div>
9135: <p>There are some packages that provide libraries and
9136: executables for running binaries from a one operating system
9137: on a different one (if the latter supports it). One example
9138: is running Linux binaries on NetBSD.</p>
1.137 leot 9139: <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.1 dsieger 9140: helps in extracting and packaging Linux rpm packages.</p>
9141: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9142: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9143: if all libraries for each installed executable can be found by
9144: the dynamic linker. Since the standard dynamic linker is run,
9145: this fails for emulation packages, because the libraries used
9146: by the emulation are not in the standard directories.</p>
9147: </div>
1.41 asau 9148: <div class="sect2">
1.1 dsieger 9149: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9150: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9151: <p>If a package installs images under the
9152: <code class="filename">share/icons/hicolor</code> and/or updates the
9153: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9154: database, you need to take some extra steps to make sure that the
9155: shared theme directory is handled appropriately and that the cache
9156: database is rebuilt:</p>
1.23 wiz 9157: <div class="orderedlist"><ol class="orderedlist" type="1">
9158: <li class="listitem"><p>Include
1.1 dsieger 9159: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 9160: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 9161: entry that refers to the theme cache.</p></li>
1.23 wiz 9162: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 9163: directories from the <code class="filename">share/icons/hicolor</code>
9164: hierarchy because they will be handled automatically.</p></li>
9165: </ol></div>
9166: <p>The best way to verify that the PLIST is correct with
9167: respect to the last two points is to regenerate it using
1.10 hubertf 9168: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 9169: </div>
1.41 asau 9170: <div class="sect2">
1.1 dsieger 9171: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9172: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9173: <p>If a package installs <code class="filename">.desktop</code> files
9174: under <code class="filename">share/applications</code> and these include
1.53 rodent 9175: MIME information (MimeType key), you need to take extra steps to
9176: ensure that they are registered into the MIME database:</p>
1.23 wiz 9177: <div class="orderedlist"><ol class="orderedlist" type="1">
9178: <li class="listitem"><p>Include
1.1 dsieger 9179: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 9180: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 9181: <code class="filename">share/applications/mimeinfo.cache</code> file.
9182: It will be handled automatically.</p></li>
9183: </ol></div>
9184: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 9185: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 9186: print-PLIST</strong></span>.</p>
9187: </div>
9188: </div>
1.41 asau 9189: <div class="sect1">
1.1 dsieger 9190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9191: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9192: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 9193: immediately. In this case, one can plainly mark a package as broken. For
9194: this, one just sets the variable <code class="varname">BROKEN</code> to the
9195: reason why the package is broken (similar to the
1.162 rillig 9196: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
1.22 jakllsch 9197: the package will immediately be shown this message, and the build
9198: will not be even tried.</p>
9199: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 9200: intervals.</p>
9201: </div>
9202: </div>
1.41 asau 9203: <div class="chapter">
1.1 dsieger 9204: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9205: <a name="debug"></a>Chapter 22. Debugging</h2></div></div></div>
1.1 dsieger 9206: <p>To check out all the gotchas when building a package, here are
9207: the steps that I do in order to get a package working. Please note
9208: this is basically the same as what was explained in the previous
9209: sections, only with some debugging aids.</p>
1.41 asau 9210: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9211: <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>
9212: <li class="listitem">
1.137 leot 9213: <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.1 dsieger 9214: create a directory for a new package, change into it, then run
1.10 hubertf 9215: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 9216: <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>
9217: <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>
1.174 leot 9218: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg https://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
1.1 dsieger 9219: </li>
1.23 wiz 9220: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9221: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9222: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9223: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 9224: configure step to the package's
9225: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 9226: <li class="listitem">
1.1 dsieger 9227: <p>Make the package compile, doing multiple rounds of</p>
9228: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9229: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9230: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9231: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9232: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9233: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9234: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9235: <p>Doing this step as non-root user will ensure that no files
9236: are modified that shouldn't be, especially during the build
1.10 hubertf 9237: phase. <span class="command"><strong>mkpatches</strong></span>,
9238: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.137 leot 9239: 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.1 dsieger 9240: package.</p>
9241: </li>
1.23 wiz 9242: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
1.154 rillig 9243: necessary; see <a class="xref" href="#components.Makefile" title="13.1. Makefile">Section 13.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.23 wiz 9244: <li class="listitem">
1.1 dsieger 9245: <p>Generate a <code class="filename">PLIST</code>:</p>
9246: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9247: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9248: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9249: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9250: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9251: <p>You usually need to be <code class="username">root</code> to do
9252: this. Look if there are any files left:</p>
9253: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9254: <p>If this reveals any files that are missing in
9255: <code class="filename">PLIST</code>, add them.</p>
9256: </li>
1.23 wiz 9257: <li class="listitem">
1.1 dsieger 9258: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9259: package again and make a binary package:</p>
9260: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9261: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9262: </li>
1.23 wiz 9263: <li class="listitem">
1.1 dsieger 9264: <p>Delete the installed package:</p>
9265: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9266: </li>
1.23 wiz 9267: <li class="listitem">
1.10 hubertf 9268: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 9269: command, which shouldn't find anything now:</p>
9270: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9271: </li>
1.23 wiz 9272: <li class="listitem">
1.1 dsieger 9273: <p>Reinstall the binary package:</p>
9274: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9275: </li>
1.23 wiz 9276: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9277: <li class="listitem">
1.137 leot 9278: <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.1 dsieger 9279: reports:</p>
9280: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9281: </li>
1.154 rillig 9282: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a>.</p></li>
1.1 dsieger 9283: </ul></div>
9284: </div>
1.41 asau 9285: <div class="chapter">
1.1 dsieger 9286: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9287: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9288: <div class="toc">
9289: <p><b>Table of Contents</b></p>
1.100 leot 9290: <dl class="toc">
1.154 rillig 9291: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9292: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9293: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9294: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9295: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9296: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9297: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9298: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9299: </dl>
9300: </div>
1.41 asau 9301: <div class="sect1">
1.1 dsieger 9302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9303: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9304: <p>Our policy is that we accept binaries only from pkgsrc
9305: developers to guarantee that the packages don't contain any
9306: trojan horses etc. This is not to annoy anyone but rather to
9307: protect our users! You're still free to put up your home-made
9308: binary packages and tell the world where to get them. NetBSD
9309: developers doing bulk builds and wanting to upload them please
1.154 rillig 9310: see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.66 asau 9311: builds)</i></a>.</p>
1.1 dsieger 9312: </div>
1.41 asau 9313: <div class="sect1">
1.1 dsieger 9314: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9315: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9316: <p>First, check that your package is complete, compiles and
1.154 rillig 9317: runs well; see <a class="xref" href="#debug" title="Chapter 22. Debugging">Chapter 22, <i>Debugging</i></a> and the rest of this
1.174 leot 9318: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 9319: archive that contains all files that make up the package.
9320: Finally, send this package to the pkgsrc bug tracking system,
1.174 leot 9321: either with the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 9322: that, go to the web page
1.174 leot 9323: <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.21 snj 9324: which contains some instructions and a link to a form where you
9325: can submit packages. The
1.137 leot 9326: <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.21 snj 9327: also available as a substitute for either of the above two tools.
9328: </p>
1.1 dsieger 9329: <p>In the form of the problem report, the category should be
1.23 wiz 9330: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9331: and version number, and the description field should contain a
9332: short description of your package (contents of the COMMENT
9333: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 9334: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 9335: <p>If you want to submit several packages, please send a
9336: separate PR for each one, it's easier for us to track things
9337: that way.</p>
9338: <p>Alternatively, you can also import new packages into
1.23 wiz 9339: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.174 leot 9340: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.1 dsieger 9341: for details.</p>
9342: </div>
1.41 asau 9343: <div class="sect1">
1.1 dsieger 9344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9345: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9346: <p>Please note all package additions, updates, moves, and
9347: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9348: important to keep this file up to date and conforming to the
9349: existing format, because it will be used by scripts to
1.174 leot 9350: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9351: sites. Additionally, check the
9352: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9353: for the package you updated or removed, in case it was mentioned
9354: there.</p>
9355: <p>When the <code class="varname">PKGREVISION</code> of a package is
9356: bumped, the change should appear in
9357: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9358: related or otherwise relevant. Mass bumps that result from a
9359: dependency being updated should not be mentioned. In all other
9360: cases it's the developer's decision.</p>
9361: <p>There is a make target that helps in creating proper
1.10 hubertf 9362: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9363: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9364: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9365: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9366: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9367: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9368: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9369: For new packages, or package moves or removals, set the
9370: <code class="varname">CTYPE</code> variable on the command line to "Added",
9371: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9372: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9373: not the same as your NetBSD login name. The target also automatically
9374: removes possibly existing entries for the package in the
9375: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9376: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9377: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9378: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9379: makes the cvs commands use the main repository.
9380: </p>
1.1 dsieger 9381: </div>
1.41 asau 9382: <div class="sect1">
1.1 dsieger 9383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9384: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 9385: <p>For several years, there have been mirrors of pkgsrc in
9386: fossil, git, and hg. Standard practise when using these tools is to
9387: make the first line of a commit message function as a summary that
9388: can be read without the rest, such as is commonly done with "git log
9389: --oneline". For this reason, we have the following guidelines for
9390: pkgsrc commit messages:</p>
9391: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9392: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 9393: big picture in 65 characters or less. When a commit is for one
1.130 wiz 9394: package, include the name of the package. For updates, include the
9395: version to which it is updated.</p></li>
9396: <li class="listitem"><p>Leave the next line empty.</p></li>
9397: <li class="listitem"><p>Then come the details for the commit (changes in that
9398: package, reason for a change) and any relevant PRs. Wrap this
9399: section.</p></li>
9400: </ul></div>
9401: <p>Here is an example:
9402: </p>
9403: <pre class="programlisting">
9404: libxslt: update to 1.0.30
9405:
9406: Changes since 1.0.29:
9407: ...
9408: </pre>
9409: <p>
9410: </p>
9411: <p>Here is another example:
9412: </p>
9413: <pre class="programlisting">
9414: mk/bsd.pkg.mk: enable SSP by default on NetBSD
9415:
9416: (rationale)
9417: </pre>
9418: <p>
9419: </p>
9420: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
9421: allowed on the pkgsrc repository to change commit messages.</p>
9422: </div>
9423: <div class="sect1">
9424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9425: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9426: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9427: access to the pkgsrc repository.</p>
9428: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9429: Start by adding the directory and then files in the directory. Don't
9430: forget to add the new package to the category's
9431: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9432: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9433: <pre class="programlisting">
9434: <code class="prompt">$</code> cd .../pkgsrc/category
9435: <code class="prompt">$</code> cvs add pkgname
9436: <code class="prompt">$</code> cd pkgname
9437: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9438: <code class="prompt">$</code> cvs add patches/p*
9439: <code class="prompt">$</code> cvs status | less
1.34 wiz 9440: <code class="prompt">$</code> cvs commit
1.33 wiz 9441: <code class="prompt">$</code> cd ..
9442: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9443: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 9444: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 9445: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 9446: </pre>
1.1 dsieger 9447: <p>The commit message of the initial import should include part of the
9448: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9449: what the package is/does.</p>
1.33 wiz 9450: <p>Also mention the new package in
9451: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9452: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9453: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9454: </div>
1.41 asau 9455: <div class="sect1">
1.1 dsieger 9456: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9457: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9458: <p>Please always put a concise, appropriate and relevant summary of the
9459: changes between old and new versions into the commit log when updating
9460: a package. There are various reasons for this:</p>
1.41 asau 9461: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9462: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9463: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9464: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9465: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9466: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9467: repository is very useful for people who read the pkgsrc-changes mailing
9468: list, so that they can make tactical decisions about when to upgrade
9469: the package.</p></li>
9470: </ul></div>
9471: <p>Please also recognize that, just because a new version of a package
9472: has been released, it should not automatically be upgraded in the CVS
9473: repository. We prefer to be conservative in the packages that are
9474: included in pkgsrc - development or beta packages are not really the
9475: best thing for most places in which pkgsrc is used. Please use your
9476: judgement about what should go into pkgsrc, and bear in mind that
9477: stability is to be preferred above new and possibly untested features.</p>
9478: </div>
1.41 asau 9479: <div class="sect1">
1.1 dsieger 9480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9481: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 9482: <p>Renaming packages is not recommended.</p>
1.175 gutterid 9483: <p>When renaming packages, be sure to fix any references to the old name
1.20 snj 9484: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 9485: <p>
1.175 gutterid 9486: Also, when renaming a package, please add
1.167 leot 9487: the package name and version pattern(s) of the previous package
9488: to <code class="varname">SUPERSEDES</code>.
1.20 snj 9489: This may be repeated for multiple renames.
9490: The new package would be an exact replacement.
1.167 leot 9491: Example:
1.20 snj 9492: </p>
1.167 leot 9493: <pre class="programlisting">
9494: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
9495: SUPERSEDES+= optcomp-[0-9]*
9496: </pre>
1.23 wiz 9497: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9498: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9499: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9500: not be an exact replacement but is a suggestion for the replaced
9501: functionality.</p>
9502: </div>
1.41 asau 9503: <div class="sect1">
1.20 snj 9504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9505: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 9506: <p>It is preferred that packages are not renamed or moved, but if needed
9507: please follow these steps.
9508: </p>
1.23 wiz 9509: <div class="orderedlist"><ol class="orderedlist" type="1">
9510: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9511: <li class="listitem">
1.1 dsieger 9512: <p>Remove all CVS dirs.</p>
9513: <p>Alternatively to the first two steps you can also do:</p>
9514: <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>
9515: <p>and use that for further work.</p>
9516: </li>
1.23 wiz 9517: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9518: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9519: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9520: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9521: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9522: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9523: for doing an update using pkgsrc building; for example, it can
1.174 leot 9524: search the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20 snj 9525: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9526: new <code class="varname">PKGPATH</code> for that moved package. Note that
9527: it may have multiple matches, so the tool should also check on the
9528: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9529: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9530: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9531: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9532: place.</p></li>
1.23 wiz 9533: <li class="listitem">
1.1 dsieger 9534: <p>Check if any package depends on it:
9535: </p>
9536: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9537: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9538: </li>
1.23 wiz 9539: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9540: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9541: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9542: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9543: <li class="listitem">
1.1 dsieger 9544: <p>Commit the changed and removed files:</p>
9545: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9546: <p>(and any packages from step 5, of course).</p>
9547: </li>
9548: </ol></div>
9549: </div>
9550: </div>
1.41 asau 9551: <div class="chapter">
1.1 dsieger 9552: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9553: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9554: <p>This section contains the answers to questions that may
9555: arise when you are writing a package. If you don't find your
9556: question answered here, first have a look in the other chapters,
9557: and if you still don't have the answer, ask on the
9558: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9559: <div class="qandaset">
1.174 leot 9560: <a name="devfaq.qandaset"></a><dl>
1.154 rillig 9561: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9562: MAKEFLAGS, .MAKEFLAGS and
9563: MAKE_FLAGS?</a>
9564: </dt>
1.154 rillig 9565: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9566: MAKE, GMAKE and
9567: MAKE_PROGRAM?</a>
9568: </dt>
1.154 rillig 9569: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9570: CC, PKG_CC and
9571: PKGSRC_COMPILER?</a>
9572: </dt>
1.154 rillig 9573: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9574: BUILDLINK_LDFLAGS,
9575: BUILDLINK_LDADD and
9576: BUILDLINK_LIBS?</a>
9577: </dt>
1.154 rillig 9578: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9579: VARNAME=BUILDLINK_PREFIX.foo
9580: say it's empty?</a>
9581: </dt>
1.154 rillig 9582: <dt>24.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9583: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9584: don't understand the := inside
9585: it.</a>
9586: </dt>
1.154 rillig 9587: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9588: developers?</a>
9589: </dt>
1.154 rillig 9590: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9591: documentation?</a>
9592: </dt>
1.174 leot 9593: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill.
9594: What shall I do?</a>
1.1 dsieger 9595: </dt>
9596: </dl>
1.41 asau 9597: <table border="0" style="width: 100%;">
9598: <colgroup>
1.1 dsieger 9599: <col align="left" width="1%">
1.23 wiz 9600: <col>
1.41 asau 9601: </colgroup>
1.1 dsieger 9602: <tbody>
1.41 asau 9603: <tr class="question">
1.1 dsieger 9604: <td align="left" valign="top">
1.174 leot 9605: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1 dsieger 9606: </td>
9607: <td align="left" valign="top"><p>What is the difference between
9608: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9609: <code class="varname">MAKE_FLAGS</code>?</p></td>
9610: </tr>
9611: <tr class="answer">
9612: <td align="left" valign="top"></td>
9613: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.174 leot 9614: to the pkgsrc-internal invocations of <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1 dsieger 9615: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9616: the <code class="varname">MAKE_PROGRAM</code> when building the
9617: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9618: </tr>
1.41 asau 9619: <tr class="question">
1.1 dsieger 9620: <td align="left" valign="top">
1.174 leot 9621: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1 dsieger 9622: </td>
9623: <td align="left" valign="top"><p>What is the difference between
9624: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9625: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9626: </tr>
9627: <tr class="answer">
9628: <td align="left" valign="top"></td>
9629: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.174 leot 9630: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1 dsieger 9631: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9632: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9633: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9634: Make program that is used for building the
9635: package.</p></td>
9636: </tr>
1.41 asau 9637: <tr class="question">
1.1 dsieger 9638: <td align="left" valign="top">
1.174 leot 9639: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1 dsieger 9640: </td>
9641: <td align="left" valign="top"><p>What is the difference between
9642: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9643: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9644: </tr>
9645: <tr class="answer">
9646: <td align="left" valign="top"></td>
9647: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9648: compiler, which can be configured by the pkgsrc user.
9649: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9650: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9651: path to a compiler, but the type of compiler that should be
9652: used. See <code class="filename">mk/compiler.mk</code> for more
9653: information about the latter variable.</p></td>
9654: </tr>
1.41 asau 9655: <tr class="question">
1.1 dsieger 9656: <td align="left" valign="top">
1.174 leot 9657: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.1 dsieger 9658: </td>
9659: <td align="left" valign="top"><p>What is the difference between
9660: <code class="varname">BUILDLINK_LDFLAGS</code>,
9661: <code class="varname">BUILDLINK_LDADD</code> and
9662: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9663: </tr>
9664: <tr class="answer">
9665: <td align="left" valign="top"></td>
9666: <td align="left" valign="top"><p>[FIXME]</p></td>
9667: </tr>
1.41 asau 9668: <tr class="question">
1.1 dsieger 9669: <td align="left" valign="top">
1.174 leot 9670: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.1 dsieger 9671: </td>
1.10 hubertf 9672: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9673: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9674: say it's empty?</p></td>
9675: </tr>
9676: <tr class="answer">
9677: <td align="left" valign="top"></td>
9678: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9679: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9680: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9681: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9682: command.</p></td>
9683: </tr>
1.41 asau 9684: <tr class="question">
1.1 dsieger 9685: <td align="left" valign="top">
1.174 leot 9686: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.1 dsieger 9687: </td>
9688: <td align="left" valign="top"><p>What does
1.108 rillig 9689: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9690: don't understand the <code class="code">:=</code> inside
1.1 dsieger 9691: it.</p></td>
9692: </tr>
9693: <tr class="answer">
9694: <td align="left" valign="top"></td>
1.108 rillig 9695: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
9696: assignment operator, although it looks like it.
1.1 dsieger 9697: Instead, it is a degenerate form of
1.108 rillig 9698: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.174 leot 9699: which is documented in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108 rillig 9700: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 9701: case of <code class="varname">MASTER_SITE_*</code>,
9702: <em class="replaceable"><code>old_string</code></em> is the empty string and
9703: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 9704: <code class="code">package/</code>. That's where the
9705: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 9706: together.</p></td>
9707: </tr>
1.41 asau 9708: <tr class="question">
1.1 dsieger 9709: <td align="left" valign="top">
1.174 leot 9710: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.1 dsieger 9711: </td>
9712: <td align="left" valign="top"><p>Which mailing lists are there for package
9713: developers?</p></td>
9714: </tr>
9715: <tr class="answer">
9716: <td align="left" valign="top"></td>
1.41 asau 9717: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174 leot 9718: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 9719: <dd><p>This is a list for technical discussions related
9720: to pkgsrc development, e.g. soliciting feedback for changes to
9721: pkgsrc infrastructure, proposed new features, questions related
9722: to porting pkgsrc to a new platform, advice for maintaining a
9723: package, patches that affect many packages, help requests moved
9724: from pkgsrc-users when an infrastructure bug is found,
9725: etc.</p></dd>
1.174 leot 9726: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 9727: <dd><p>All bug reports in category "pkg" sent with
1.174 leot 9728: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 9729: directly; use one of the other mailing
9730: lists.</p></dd>
9731: </dl></div></td>
9732: </tr>
1.41 asau 9733: <tr class="question">
1.1 dsieger 9734: <td align="left" valign="top">
1.174 leot 9735: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.1 dsieger 9736: </td>
9737: <td align="left" valign="top"><p>Where is the pkgsrc
9738: documentation?</p></td>
9739: </tr>
9740: <tr class="answer">
9741: <td align="left" valign="top"></td>
9742: <td align="left" valign="top">
9743: <p>There are many places where you can find
9744: documentation about pkgsrc:</p>
1.41 asau 9745: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9746: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9747: of chapters that explain large parts of pkgsrc, but some
9748: chapters tend to be outdated. Which ones they are is hard to
9749: say.</p></li>
1.174 leot 9750: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>), you can find discussions
1.1 dsieger 9751: about certain features, announcements of new parts of the pkgsrc
9752: infrastructure and sometimes even announcements that a certain
9753: feature has been marked as obsolete. The benefit here is that
9754: each message has a date appended to it.</p></li>
1.23 wiz 9755: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9756: <code class="filename">mk/</code> directory start with a comment that
9757: describes the purpose of the file and how it can be used by the
9758: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9759: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9760: help</strong></span>.</p></li>
1.23 wiz 9761: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9762: information, but they tend to be highly abbreviated, especially
9763: for actions that occur often. Some contain a detailed
9764: description of what has changed, but they are geared towards the
9765: other pkgsrc developers, not towards an average pkgsrc user.
9766: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9767: don't know what has been before, these messages may not be worth
9768: too much to you.</p></li>
1.23 wiz 9769: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9770: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9771: mind of the developer who wrote the code. To get this
1.10 hubertf 9772: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9773: to see who has written it and ask on the
9774: <code class="literal">tech-pkg</code> mailing list, so that others can
9775: find your questions later (see above). To be sure that the
9776: developer in charge reads the mail, you may CC him or
9777: her.</p></li>
9778: </ul></div>
9779: </td>
9780: </tr>
1.41 asau 9781: <tr class="question">
1.1 dsieger 9782: <td align="left" valign="top">
1.174 leot 9783: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
1.1 dsieger 9784: </td>
1.174 leot 9785: <td align="left" valign="top"><p>I have a little time to kill.
9786: What shall I do?</p></td>
1.1 dsieger 9787: </tr>
9788: <tr class="answer">
9789: <td align="left" valign="top"></td>
9790: <td align="left" valign="top">
9791: <p>This is not really an FAQ yet, but here's the answer
9792: anyway.</p>
1.41 asau 9793: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9794: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.137 leot 9795: <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.1 dsieger 9796: will tell you about newer versions of installed packages that are
9797: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9798: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9799: — it contains a list of suggested new packages and a list of
1.1 dsieger 9800: cleanups and enhancements for pkgsrc that would be nice to
9801: have.</p></li>
1.23 wiz 9802: <li class="listitem"><p>Review packages for which review was requested on
1.174 leot 9803: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1 dsieger 9804: mailing list.</p></li>
9805: </ul></div>
9806: </td>
9807: </tr>
9808: </tbody>
9809: </table>
9810: </div>
9811: </div>
1.41 asau 9812: <div class="chapter">
1.1 dsieger 9813: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9814: <a name="gnome"></a>Chapter 25. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9815: <div class="toc">
9816: <p><b>Table of Contents</b></p>
1.100 leot 9817: <dl class="toc">
1.154 rillig 9818: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
9819: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
9820: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
9821: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1 dsieger 9822: </dl>
9823: </div>
1.174 leot 9824: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9825: site</a>:</p>
9826: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9827: environment, an intuitive and attractive desktop for users, and the
9828: GNOME development platform, an extensive framework for building
9829: applications that integrate into the rest of the desktop.</p></blockquote></div>
9830: <p>pkgsrc provides a seamless way to automatically build and install
9831: a complete GNOME environment <span class="emphasis"><em>under many different
9832: platforms</em></span>. We can say with confidence that pkgsrc is one of
9833: the most advanced build and packaging systems for GNOME due to its
9834: included technologies buildlink3, the wrappers and tools framework and
9835: automatic configuration file management. Lots of efforts are put into
9836: achieving a completely clean deinstallation of installed software
9837: components.</p>
1.174 leot 9838: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9839: the above also means that great efforts are put into making GNOME work
1.174 leot 9840: under this operating system. Recently, <a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9841: pkgsrc as its preferred packaging system, contributing lots of
9842: portability fixes to make GNOME build and install under it.</p>
9843: <p>This chapter is aimed at pkgsrc developers and other people
9844: interested in helping our GNOME porting and packaging efforts. It
9845: provides instructions on how to manage the existing packages and some
9846: important information regarding their internals.</p>
1.41 asau 9847: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9848: <h3 class="title">We need your help!</h3>
9849: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9850: and GNOME and are willing to learn new exciting stuff, please jump
1.174 leot 9851: straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9852: work</a> list! There is still a long way to go to get a
9853: fully-functional GNOME desktop under NetBSD and we need your help to
9854: achieve it!</p>
9855: </div>
1.41 asau 9856: <div class="sect1">
1.1 dsieger 9857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9858: <a name="meta-packages"></a>25.1. Meta packages</h2></div></div></div>
1.1 dsieger 9859: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9860: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137 leot 9861: <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.1 dsieger 9862: the core GNOME desktop environment. It only includes the necessary
9863: bits to get it to boot correctly, although it may lack important
9864: functionality for daily operation. The idea behind this package is
9865: to let end users build their own configurations on top of this one,
9866: first installing this meta package to achieve a functional setup and
9867: then adding individual applications.</p></li>
1.137 leot 9868: <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.1 dsieger 9869: complete installation of the GNOME platform and desktop as defined
9870: by the GNOME project; this is based on the components distributed in
9871: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9872: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9873: official FTP server. Developer-only tools found in those
9874: directories are not installed unless required by some other
9875: component to work properly. Similarly, packages from the bindings
9876: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9877: in unless required as a dependency for an end-user component. This
1.137 leot 9878: 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>
9879: <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.1 dsieger 9880: Installs all the tools required to build a GNOME component when
9881: fetched from the CVS repository. These are required to let the
1.10 hubertf 9882: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9883: </ul></div>
9884: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9885: sorted in a way that eases updates: a package may depend on other
9886: packages listed before it but not on any listed after it. It is very
9887: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9888: change it to alphabetical sorting!</em></span></p>
9889: </div>
1.41 asau 9890: <div class="sect1">
1.1 dsieger 9891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9892: <a name="new-package"></a>25.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9893: <p>Almost all GNOME applications are written in C and use a common
9894: set of tools as their build system. Things get different with the new
9895: bindings to other languages (such as Python), but the following will
9896: give you a general idea on the minimum required tools:</p>
1.41 asau 9897: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9898: <li class="listitem">
1.1 dsieger 9899: <p>Almost all GNOME applications use the GNU Autotools as their
9900: build system. As a general rule you will need to tell this to your
9901: package:</p>
9902: <pre class="programlisting">
9903: GNU_CONFIGURE=yes
9904: USE_LIBTOOL=yes
9905: USE_TOOLS+=gmake
9906: </pre>
9907: </li>
1.23 wiz 9908: <li class="listitem">
1.1 dsieger 9909: <p>If the package uses pkg-config to detect dependencies, add this
9910: tool to the list of required utilities:</p>
1.111 sevan 9911: <pre class="programlisting">
9912: USE_TOOLS+=pkg-config
9913: </pre>
1.137 leot 9914: <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.1 dsieger 9915: the end of the build process to ensure that you did not miss to
9916: specify any dependency in your package and that the version
9917: requirements are all correct.</p>
9918: </li>
1.23 wiz 9919: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9920: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9921: to handle dependencies and to force the package to use the latest
9922: available version.</p></li>
1.23 wiz 9923: <li class="listitem">
1.1 dsieger 9924: <p>If the package uses gtk-doc (a documentation generation
9925: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9926: tool is rather big and the distfile should come with pregenerated
9927: documentation anyway; if it does not, it is a bug that you ought to
9928: report. For such packages you should disable gtk-doc (unless it is
9929: the default):</p>
1.111 sevan 9930: <pre class="programlisting">
9931: CONFIGURE_ARGS+=--disable-gtk-doc
9932: </pre>
1.1 dsieger 9933: <p>The default location of installed HTML files
9934: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9935: and should not be changed unless the package insists on installing
9936: them somewhere else. Otherwise programs as
1.10 hubertf 9937: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9938: do that with an entry similar to:</p>
1.111 sevan 9939: <pre class="programlisting">
9940: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
9941: </pre>
1.1 dsieger 9942: </li>
9943: </ul></div>
9944: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9945: files under the installation prefix to maintain databases. In this
9946: context, shared means that those exact same directories and files are
9947: used among several different packages, leading to conflicts in the
9948: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9949: handle the most common cases, so you have to forget about using
9950: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9951: omitting shared files from them. If you find yourself doing those,
9952: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9953: <p>The following table lists the common situations that result in
9954: using shared directories or files. For each of them, the appropriate
9955: solution is given. After applying the solution be sure to
9956: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9957: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9958: <div class="table">
1.154 rillig 9959: <a name="plist-handling"></a><p class="title"><b>Table 25.1. PLIST handling for GNOME packages</b></p>
1.106 tnn 9960: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1 dsieger 9961: <colgroup>
9962: <col>
9963: <col>
9964: </colgroup>
9965: <thead><tr>
9966: <th>If the package...</th>
9967: <th>Then...</th>
9968: </tr></thead>
9969: <tbody>
9970: <tr>
9971: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.154 rillig 9972: <td>See <a class="xref" href="#scrollkeeper-data-files" title="21.6.10. Packages installing scrollkeeper/rarian data files">Section 21.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
1.1 dsieger 9973: </tr>
9974: <tr>
9975: <td>Installs icons under the
9976: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9977: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.154 rillig 9978: <td>See <a class="xref" href="#hicolor-theme" title="21.6.19. Packages installing hicolor theme icons">Section 21.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.1 dsieger 9979: </tr>
9980: <tr>
9981: <td>Installs files under
9982: <code class="filename">share/mime/packages</code>.</td>
1.154 rillig 9983: <td>See <a class="xref" href="#mime-database" title="21.6.14. Packages installing extensions to the MIME database">Section 21.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.1 dsieger 9984: </tr>
9985: <tr>
9986: <td>Installs <code class="filename">.desktop</code> files under
9987: <code class="filename">share/applications</code> and these include MIME
9988: information.</td>
1.154 rillig 9989: <td>See <a class="xref" href="#desktop-files" title="21.6.20. Packages installing desktop files">Section 21.6.20, “Packages installing desktop files”</a>.</td>
1.1 dsieger 9990: </tr>
9991: </tbody>
9992: </table></div>
9993: </div>
9994: <br class="table-break">
9995: </div>
1.41 asau 9996: <div class="sect1">
1.1 dsieger 9997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9998: <a name="full-update"></a>25.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9999: <p>When seeing GNOME as a whole, there are two kinds of
10000: updates:</p>
1.41 asau 10001: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10002: <dt><span class="term">Major update</span></dt>
10003: <dd>
10004: <p>Given that there is still a very long way for GNOME 3 (if it
10005: ever appears), we consider a major update one that goes from a
10006: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10007: where <code class="literal">Y</code> is even and greater than
10008: <code class="literal">X</code>. These are hard to achieve because they
10009: introduce lots of changes in the components' code and almost all
10010: GNOME distfiles are updated to newer versions. Some of them can
10011: even break API and ABI compatibility with the previous major
10012: version series. As a result, the update needs to be done all at
10013: once to minimize breakage.</p>
10014: <p>A major update typically consists of around 80 package
10015: updates and the addition of some new ones.</p>
10016: </dd>
10017: <dt><span class="term">Minor update</span></dt>
10018: <dd>
10019: <p>We consider a minor update one that goes from a
10020: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10021: one where <code class="literal">Y</code> is greater than
10022: <code class="literal">X</code>. These are easy to achieve because they do
10023: not update all GNOME components, can be done in an incremental way
10024: and do not break API nor ABI compatibility.</p>
10025: <p>A minor update typically consists of around 50 package
10026: updates, although the numbers here may vary a lot.</p>
10027: </dd>
10028: </dl></div>
10029: <p>In order to update the GNOME components in pkgsrc to a new stable
10030: release (either major or minor), the following steps should be
10031: followed:</p>
1.23 wiz 10032: <div class="orderedlist"><ol class="orderedlist" type="1">
10033: <li class="listitem">
1.1 dsieger 10034: <p>Get a list of all the tarballs that form the new release by
10035: using the following commands. These will leave the full list of the
1.18 snj 10036: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 10037: file:</p>
10038: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10039: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10040: awk '{ print $9 }' >list.txt</code></strong>
10041: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10042: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10043: awk '{ print $9 }' >>list.txt</code></strong></pre>
10044: </li>
1.23 wiz 10045: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 10046: bump their version to the release you are updating them to. The
10047: three meta packages should be always consistent with versioning.
10048: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10049: in them.</p></li>
1.23 wiz 10050: <li class="listitem">
1.1 dsieger 10051: <p>For each meta package, update all its
10052: <code class="varname">DEPENDS</code> lines to match the latest versions as
10053: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10054: newer version (even if found in the FTP) because the meta packages
10055: are supposed to list the exact versions that form a specific GNOME
10056: release. Exceptions are permitted here if a newer version solves a
10057: serious issue in the overall desktop experience; these typically
10058: come in the form of a revision bump in pkgsrc, not in newer versions
10059: from the developers.</p>
10060: <p>Packages not listed in the <code class="filename">list.txt</code> file
10061: should be updated to the latest version available (if found in
10062: pkgsrc). This is the case, for example, of the dependencies on the
1.137 leot 10063: 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.1 dsieger 10064: </li>
1.23 wiz 10065: <li class="listitem">
1.1 dsieger 10066: <p>Generate a patch from the modified meta packages and extract the
10067: list of "new" lines. This will provide you an outline on what
10068: packages need to be updated in pkgsrc and in what order:</p>
10069: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
10070: </li>
1.23 wiz 10071: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 10072: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 10073: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 10074: of <code class="filename">todo.txt</code> and update the packages listed in
10075: it in order. For major desktop updates none of these should be
10076: committed until the entire set is completed because there are chances
10077: of breaking not-yet-updated packages.</p></li>
1.23 wiz 10078: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 10079: the tree one by one with appropriate log messages. At the end,
10080: commit the three meta package updates and all the corresponding
10081: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10082: <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/doc/TODO?rev=HEAD&content-type=text/x-cvsweb-markup" target="_top"><code class="filename">pkgsrc/doc/TODO</code></a> files.</p></li>
10083: </ol></div>
10084: </div>
1.41 asau 10085: <div class="sect1">
1.1 dsieger 10086: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10087: <a name="patching"></a>25.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 10088: <p>GNOME is a very big component in pkgsrc which approaches 100
10089: packages. Please, it is very important that you always, always,
10090: <span class="strong"><strong>always</strong></span> feed back any portability
1.154 rillig 10091: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="13.3.5. Feedback to the author">Section 13.3.5, “Feedback to the author”</a>). This is the only way to get
1.1 dsieger 10092: their attention on portability issues and to ensure that future versions
10093: can be built out-of-the box on NetBSD. The less custom patches in
10094: pkgsrc, the easier further updates are. Those developers in charge of
10095: issuing major GNOME updates will be grateful if you do that.</p>
1.174 leot 10096: <p>The most common places to report bugs are the <a class="ulink" href="https://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="https://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.1 dsieger 10097: Bugzilla</a>. Not all components use these to track bugs, but most
10098: of them do. Do not be short on your reports: always provide detailed
10099: explanations of the current failure, how it can be improved to achieve
10100: maximum portability and, if at all possible, provide a patch against CVS
10101: head. The more verbose you are, the higher chances of your patch being
10102: accepted.</p>
10103: <p>Also, please avoid using preprocessor magic to fix portability
10104: issues. While the FreeBSD GNOME people are doing a great job in porting
10105: GNOME to their operating system, the official GNOME sources are now
10106: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10107: and similar macros. This hurts portability. Please see our patching
1.154 rillig 10108: guidelines (<a class="xref" href="#components.patches.guidelines" title="13.3.4. Patching guidelines">Section 13.3.4, “Patching guidelines”</a>) for more
1.1 dsieger 10109: details.</p>
10110: </div>
10111: </div>
10112: </div>
1.41 asau 10113: <div class="part">
1.1 dsieger 10114: <div class="titlepage"><div><div><h1 class="title">
10115: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10116: <div class="partintro">
1.1 dsieger 10117: <div></div>
10118: <p>This part of the guide deals with everything
10119: from the infrastructure that is behind the interfaces described
10120: in the developer's guide. A casual package maintainer should not
10121: need anything from this part.</p>
10122: <div class="toc">
10123: <p><b>Table of Contents</b></p>
1.100 leot 10124: <dl class="toc">
1.154 rillig 10125: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10126: <dd><dl>
1.154 rillig 10127: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
10128: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
10129: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 10130: <dd><dl>
1.154 rillig 10131: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
10132: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 10133: </dl></dd>
1.154 rillig 10134: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
10135: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10136: <dd><dl>
1.154 rillig 10137: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
10138: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10139: </dl></dd>
1.154 rillig 10140: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10141: <dd><dl>
1.154 rillig 10142: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10143: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10144: </dl></dd>
10145: </dl></dd>
1.154 rillig 10146: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1 dsieger 10147: <dd><dl>
1.154 rillig 10148: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
10149: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10150: <dd><dl>
1.154 rillig 10151: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
10152: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 10153: </dl></dd>
10154: </dl></dd>
1.154 rillig 10155: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
10156: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 10157: </dl>
10158: </div>
10159: </div>
1.41 asau 10160: <div class="chapter">
1.1 dsieger 10161: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10162: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10163: <div class="toc">
10164: <p><b>Table of Contents</b></p>
1.100 leot 10165: <dl class="toc">
1.154 rillig 10166: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
10167: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
10168: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1 dsieger 10169: <dd><dl>
1.154 rillig 10170: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
10171: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1 dsieger 10172: </dl></dd>
1.154 rillig 10173: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
10174: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10175: <dd><dl>
1.154 rillig 10176: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
10177: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10178: </dl></dd>
1.154 rillig 10179: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10180: <dd><dl>
1.154 rillig 10181: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10182: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10183: </dl></dd>
10184: </dl>
10185: </div>
10186: <p>The pkgsrc infrastructure consists of many small Makefile
10187: fragments. Each such fragment needs a properly specified
10188: interface. This chapter explains how such an interface looks
10189: like.</p>
1.41 asau 10190: <div class="sect1">
1.1 dsieger 10191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10192: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10193: <p>Whenever a variable is defined in the pkgsrc
10194: infrastructure, the location and the way of definition provide
10195: much information about the intended use of that variable.
10196: Additionally, more documentation may be found in a header
10197: comment or in this pkgsrc guide.</p>
10198: <p>A special file is
10199: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10200: variables that are intended to be user-defined. They are either
10201: defined using the <code class="literal">?=</code> operator or they are
10202: left undefined because defining them to anything would
1.23 wiz 10203: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10204: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10205: file.</p>
10206: <p>Outside this file, the following conventions apply:
10207: Variables that are defined using the <code class="literal">?=</code>
10208: operator may be overridden by a package.</p>
10209: <p>Variables that are defined using the <code class="literal">=</code>
10210: operator may be used read-only at run-time.</p>
10211: <p>Variables whose name starts with an underscore must not be
10212: accessed outside the pkgsrc infrastructure at all. They may
10213: change without further notice.</p>
1.41 asau 10214: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10215: <h3 class="title">Note</h3>
10216: <p>These conventions are currently not applied
10217: consistently to the complete pkgsrc
10218: infrastructure.</p>
10219: </div>
10220: </div>
1.41 asau 10221: <div class="sect1">
1.1 dsieger 10222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10223: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10224: <p>All variables that contain lists of things should default
10225: to being empty. Two examples that do not follow this rule are
10226: <code class="varname">USE_LANGUAGES</code> and
10227: <code class="varname">DISTFILES</code>. These variables cannot simply be
10228: modified using the <code class="literal">+=</code> operator in package
10229: <code class="filename">Makefile</code>s (or other files included by
10230: them), since there is no guarantee whether the variable is
10231: already set or not, and what its value is. In the case of
1.23 wiz 10232: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10233: the default value and just define it as in the following
10234: example.</p>
10235: <pre class="programlisting">
10236: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10237: </pre>
10238: <p>Because of the selection of this default value, the same
10239: value appears in many package Makefiles. Similarly for
10240: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10241: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10242: doesn't stand out. Nevertheless it is mentioned in many
10243: files.</p>
10244: </div>
1.41 asau 10245: <div class="sect1">
1.1 dsieger 10246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10247: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.41 asau 10248: <div class="sect2">
1.1 dsieger 10249: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10250: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.1 dsieger 10251: <p>Variable evaluation takes place either at load time or at
10252: runtime, depending on the context in which they occur. The
10253: contexts where variables are evaluated at load time are:</p>
1.41 asau 10254: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10255: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10256: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10257: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10258: <code class="literal">.for</code>,</p></li>
1.23 wiz 10259: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10260: </ul></div>
10261: <p>A special exception are references to the iteration
10262: variables of <code class="literal">.for</code> loops, which are expanded
10263: inline, no matter in which context they appear.</p>
10264: <p>As the values of variables may change during load time,
10265: care must be taken not to evaluate them by accident. Typical
10266: examples for variables that should not be evaluated at load time
10267: are <code class="varname">DEPENDS</code> and
10268: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10269: clear, here is an example:</p>
10270: <pre class="programlisting">
10271: CONFIGURE_ARGS= # none
10272: CFLAGS= -O
10273: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10274:
10275: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10276:
10277: CFLAGS+= -Wall
1.111 sevan 10278: </pre>
1.1 dsieger 10279: <p>This code shows how the use of the <code class="literal">:=</code>
10280: operator can quickly lead to unexpected results. The first
10281: paragraph is fairly common code. The second paragraph evaluates
10282: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10283: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10284: <code class="literal">-Wall</code> is appended to the
10285: <code class="varname">CFLAGS</code>, but this addition will not appear in
10286: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10287: paragraphs from above typically occur in completely unrelated
10288: files.</p>
10289: </div>
1.41 asau 10290: <div class="sect2">
1.1 dsieger 10291: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10292: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10293: <p>After all the files have been loaded, the values of the
10294: variables cannot be changed anymore. Variables that are used in
10295: the shell commands are expanded at this point.</p>
10296: </div>
10297: </div>
1.41 asau 10298: <div class="sect1">
1.1 dsieger 10299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10300: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10301: <p>There are many ways in which the definition and use of a
1.108 rillig 10302: variable can be restricted in order to detect bugs and violations
10303: of the (mostly unwritten) policies. A package can be checked with
10304: <code class="literal">pkglint -Wall</code> to see whether it meets these
10305: rules.</p>
1.1 dsieger 10306: </div>
1.41 asau 10307: <div class="sect1">
1.1 dsieger 10308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10309: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10310: <p>Most of the <code class="filename">.mk</code> files fall into one
10311: of the following classes. Cases where a file falls into more
10312: than one class should be avoided as it often leads to subtle
10313: bugs.</p>
1.41 asau 10314: <div class="sect2">
1.1 dsieger 10315: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10316: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10317: <p>In a traditional imperative programming language some of
10318: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10319: procedures. They take some input parameters and—after
10320: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10321: variables in <code class="filename">Makefile</code>s have global scope
10322: care must be taken not to use parameter names that have already
10323: another meaning. For example, <code class="varname">PKGNAME</code> is a
10324: bad choice for a parameter name.</p>
10325: <p>Procedures are completely evaluated at preprocessing time.
10326: That is, when calling a procedure all input parameters must be
10327: completely resolvable. For example,
10328: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10329: parameter since it is very likely that further text will be
10330: added after calling the procedure, which would effectively apply
10331: the procedure to only a part of the variable. Also, references
1.108 rillig 10332: to other variables will be modified after calling the
1.1 dsieger 10333: procedure.</p>
10334: <p>A procedure can declare its output parameters either as
10335: suitable for use in preprocessing directives or as only
10336: available at runtime. The latter alternative is for variables
10337: that contain references to other runtime variables.</p>
10338: <p>Procedures shall be written such that it is possible to
10339: call the procedure more than once. That is, the file must not
10340: contain multiple-inclusion guards.</p>
10341: <p>Examples for procedures are
10342: <code class="filename">mk/bsd.options.mk</code> and
10343: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10344: that the parameters are evaluated at load time, they should be
10345: assigned using the <code class="literal">:=</code> operator, which should
10346: be used only for this purpose.</p>
10347: </div>
1.41 asau 10348: <div class="sect2">
1.1 dsieger 10349: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10350: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10351: <p>Action files take some input parameters and may define
10352: runtime variables. They shall not define loadtime variables.
10353: There are action files that are included implicitly by the
10354: pkgsrc infrastructure, while other must be included
10355: explicitly.</p>
10356: <p>An example for action files is
10357: <code class="filename">mk/subst.mk</code>.</p>
10358: </div>
10359: </div>
1.41 asau 10360: <div class="sect1">
1.1 dsieger 10361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10362: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10363: <p>Package <code class="filename">Makefile</code>s usually consist of
10364: a set of variable definitions, and include the file
10365: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10366: Before that, they may also include various other
10367: <code class="filename">*.mk</code> files if they need to query the
10368: availability of certain features like the type of compiler or
10369: the X11 implementation. Due to the heavy use of preprocessor
10370: directives like <code class="literal">.if</code> and
10371: <code class="literal">.for</code>, the order in which the files are loaded
10372: matters.</p>
10373: <p>This section describes at which point the various files
10374: are loaded and gives reasons for that order.</p>
1.41 asau 10375: <div class="sect2">
1.1 dsieger 10376: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10377: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10378: </h3></div></div></div>
10379: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10380: is to define some essential variables like
10381: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10382: <code class="varname">MACHINE_ARCH</code>.</p>
10383: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10384: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4 rillig 10385: After that, those variables
1.1 dsieger 10386: that have not been overridden by the user are loaded from
10387: <code class="filename">mk/defaults/mk.conf</code>.</p>
10388: <p>After the user settings, the system settings and platform
10389: settings are loaded, which may override the user
10390: settings.</p>
10391: <p>Then, the tool definitions are loaded. The tool wrappers
10392: are not yet in effect. This only happens when building a
10393: package, so the proper variables must be used instead of the
10394: direct tool names.</p>
10395: <p>As the last steps, some essential variables from the
10396: wrapper and the package system flavor are loaded, as well as the
10397: variables that have been cached in earlier phases of a package
10398: build.</p>
10399: </div>
1.41 asau 10400: <div class="sect2">
1.1 dsieger 10401: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10402: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10403: </h3></div></div></div>
10404: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10405: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10406: loaded, which fill default values for those variables that have
10407: not been defined by the package. These variables may later
10408: be used even in unrelated files.</p>
10409: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10410: provides the target <code class="literal">error-check</code> that is added
10411: as a special dependency to all other targets that use
10412: <code class="varname">DELAYED_ERROR_MSG</code> or
10413: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10414: <p>Then, the package-specific hacks from
10415: <code class="filename">hacks.mk</code> are included.</p>
10416: <p>Then, various other files follow. Most of them don't have
10417: any dependencies on what they need to have included before or
10418: after them, though some do.</p>
10419: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10420: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10421: restricts the use of these variables to all the files that have
10422: been included before. Appearances in later files will be
10423: silently ignored.</p>
10424: <p>Then, the files for the main targets are included, in the
10425: order of later execution, though the actual order should not
10426: matter.</p>
10427: <p>At last, some more files are included that don't set any
10428: interesting variables but rather just define make targets to be
10429: executed.</p>
10430: </div>
10431: </div>
10432: </div>
1.41 asau 10433: <div class="chapter">
1.1 dsieger 10434: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10435: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.1 dsieger 10436: <div class="toc">
10437: <p><b>Table of Contents</b></p>
1.100 leot 10438: <dl class="toc">
1.154 rillig 10439: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
10440: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10441: <dd><dl>
1.154 rillig 10442: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
10443: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1 dsieger 10444: </dl></dd>
10445: </dl>
10446: </div>
10447: <p>The pkgsrc infrastructure consists of a large codebase,
10448: and there are many corners where every little bit of a file is
10449: well thought out, making pkgsrc likely to fail as soon as
10450: anything is changed near those parts. To prevent most changes
10451: from breaking anything, a suite of regression tests should go
10452: along with every important part of the pkgsrc infrastructure.
10453: This chapter describes how regression tests work in pkgsrc and
10454: how you can add new tests.</p>
1.41 asau 10455: <div class="sect1">
1.1 dsieger 10456: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10457: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.137 leot 10458: <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.10 hubertf 10459: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10460: can simply run that command, which will run all tests in the
1.168 rillig 10461: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10462: </div>
1.41 asau 10463: <div class="sect1">
1.1 dsieger 10464: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10465: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10466: <p>Every directory in the <code class="filename">regress/</code>
10467: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10468: is considered a regression test. This file is a shell program
1.10 hubertf 10469: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10470: The following functions can be overridden to suit your
10471: needs.</p>
1.41 asau 10472: <div class="sect2">
1.1 dsieger 10473: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10474: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10475: <p>These functions do not take any parameters. Although they
10476: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.174 leot 10477: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10478: question</a> for details.</p>
1.41 asau 10479: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10480: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10481: <dd><p>This function prepares the environment for the
10482: test. By default it does nothing.</p></dd>
1.108 rillig 10483: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10484: <dd>
10485: <p>This function runs the actual test. By default,
1.1 dsieger 10486: it calls <code class="varname">TEST_MAKE</code> with the arguments
10487: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10488: error messages into the file
1.108 rillig 10489: <code class="varname">TEST_OUTFILE</code>.</p>
10490: <p>When defining this function, make sure that all output that
10491: needs to be checked is written to the correct output file.
10492: Example:</p>
10493: <pre class="programlisting">
10494: do_test() {
1.112 rillig 10495: echo "Example output"
1.108 rillig 10496: } 1>$TEST_OUTFILE 2>&1
10497: </pre>
10498: </dd>
10499: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10500: <dd>
10501: <p>This function is run after the test and is
1.1 dsieger 10502: typically used to compare the actual output from the one that is
10503: expected. It can make use of the various helper functions from
1.108 rillig 10504: the next section. Example:</p>
10505: <pre class="programlisting">
10506: check_result() {
1.112 rillig 10507: exit_status 0
10508: output_require "Example"
10509: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10510: output_prohibit "no such file or directory"
1.168 rillig 10511: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 10512: }
10513: </pre>
10514: </dd>
10515: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10516: <dd><p>This function cleans everything up after the
10517: test has been run. By default it does nothing.</p></dd>
10518: </dl></div>
10519: </div>
1.41 asau 10520: <div class="sect2">
1.1 dsieger 10521: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 10522: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.41 asau 10523: <div class="variablelist"><dl class="variablelist">
1.168 rillig 10524: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10525: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 10526: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10527: <dd><p>This function compares the exitcode of the
1.108 rillig 10528: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10529: If they differ, the test will fail.</p></dd>
1.108 rillig 10530: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10531: <dd>
10532: <p>This function checks for each of its parameters
10533: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10534: extended regular expression. If it does not, the test will
1.108 rillig 10535: fail. Example:</p>
10536: <pre class="programlisting">
10537: output_require "looks fine"
10538: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10539: </pre>
10540: </dd>
1.177 leot 10541: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1 dsieger 10542: <dd><p>This function checks for each of its parameters
1.10 hubertf 10543: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10544: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10545: If any of the regular expressions matches, the test will
10546: fail.</p></dd>
10547: </dl></div>
10548: </div>
10549: </div>
10550: </div>
1.41 asau 10551: <div class="chapter">
1.1 dsieger 10552: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10553: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10554: <div class="toc">
10555: <p><b>Table of Contents</b></p>
1.154 rillig 10556: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.1 dsieger 10557: </div>
10558: <p>The pkgsrc system has already been ported to many
10559: operating systems, hardware architectures and compilers. This
10560: chapter explains the necessary steps to make pkgsrc even more
10561: portable.</p>
1.41 asau 10562: <div class="sect1">
1.1 dsieger 10563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10564: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10565: <p>To port pkgsrc to a new operating system (called
10566: <code class="literal">MyOS</code> in this example), you need to touch the
10567: following files:</p>
1.41 asau 10568: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10569: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
10570: <dd><p>This file contains some basic definitions, for
10571: example the name of the C
10572: compiler.</p></dd>
10573: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10574: <dd><p>Insert code that defines the variables
10575: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10576: <code class="varname">LOWER_OS_VERSION</code>,
10577: <code class="varname">LOWER_VENDOR</code>,
10578: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10579: <code class="varname">APPEND_ELF</code>, and the other variables that
10580: appear in this file.</p></dd>
10581: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10582: <dd><p>This file contains the platform-specific
10583: definitions that are used by pkgsrc. Start by copying one of the
10584: other files and edit it to your
10585: needs.</p></dd>
10586: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10587: <dd><p>This file defines the paths to all the tools
10588: that are needed by one or the other package in pkgsrc, as well
10589: as by pkgsrc itself. Find out where these tools are on your
10590: platform and add them.</p></dd>
10591: </dl></div>
10592: <p>Now, you should be able to build some basic packages, like
1.137 leot 10593: <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.1 dsieger 10594: </div>
10595: </div>
10596: </div>
1.41 asau 10597: <div class="appendix">
10598: <div class="titlepage"><div><div><h1 class="title">
10599: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10600: <div class="toc">
10601: <p><b>Table of Contents</b></p>
1.100 leot 10602: <dl class="toc">
1.1 dsieger 10603: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10604: <dd><dl>
10605: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10606: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10607: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 10608: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 10609: </dl></dd>
10610: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10611: </dl>
10612: </div>
10613: <p>We checked to find a piece of software that wasn't in the packages
10614: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10615: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10616: present in the tree is beyond us, but it's useful for the purposes of
10617: this exercise.</p>
1.41 asau 10618: <div class="sect1">
1.1 dsieger 10619: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10620: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10621: <div class="sect2">
1.1 dsieger 10622: <div class="titlepage"><div><div><h3 class="title">
10623: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10624: <pre class="programlisting">
10625: # $NetBSD$
10626: #
10627:
10628: DISTNAME= bison-1.25
10629: CATEGORIES= devel
1.171 rillig 10630: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 10631:
1.29 dholland 10632: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 10633: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 10634: COMMENT= GNU yacc clone
10635:
10636: GNU_CONFIGURE= yes
1.46 wiz 10637: INFO_FILES= yes
1.1 dsieger 10638:
10639: .include "../../mk/bsd.pkg.mk"
10640: </pre>
10641: </div>
1.41 asau 10642: <div class="sect2">
1.1 dsieger 10643: <div class="titlepage"><div><div><h3 class="title">
10644: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10645: <pre class="programlisting">
10646: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.174 leot 10647: improvements. Why you would want this when Berkeley <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 10648: of the NetBSD source tree is beyond me.
10649: </pre>
10650: </div>
1.41 asau 10651: <div class="sect2">
1.1 dsieger 10652: <div class="titlepage"><div><div><h3 class="title">
10653: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10654: <pre class="programlisting">
10655: @comment $NetBSD$
10656: bin/bison
10657: man/man1/bison.1.gz
10658: share/bison.simple
10659: share/bison.hairy
10660: </pre>
10661: </div>
1.41 asau 10662: <div class="sect2">
1.1 dsieger 10663: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 10664: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 10665: <p>The NetBSD package system comes with
1.137 leot 10666: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 10667: which helps to check the contents of these
10668: files. After installation it is quite easy to use, just change to the
1.171 rillig 10669: directory of the package you wish to examine and run
1.10 hubertf 10670: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10671: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 10672: ERROR: Makefile: Each package must define its LICENSE.
10673: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10674: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10675: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10676: 1 error, 2 warnings and 1 note found.
10677: (Run "pkglint -e" to show explanations.)
10678: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 10679: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 10680: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 10681: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 10682: -Wall</strong></span> for a very thorough check.</p>
10683: </div>
10684: </div>
1.41 asau 10685: <div class="sect1">
1.1 dsieger 10686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10687: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10688: <p>Create the directory where the package lives,
10689: plus any auxiliary directories:</p>
10690: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10691: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10692: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10693: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10694: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.154 rillig 10695: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 13. Package components - files, directories and contents">Chapter 13, <i>Package components - files, directories and contents</i></a>)
1.1 dsieger 10696: then continue with fetching the distfile:</p>
10697: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10698: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10699: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10700: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10701: ftp: Error retrieving file: 500 Internal error
10702:
10703: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10704: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10705: ftp: Error retrieving file: 500 Internal error
10706:
10707: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10708: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10709: Successfully retrieved file.</pre>
10710: <p>Generate the checksum of the distfile into
10711: <code class="filename">distinfo</code>:</p>
10712: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10713: <p>Now compile:</p>
10714: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10715: >> Checksum OK for bison-1.25.tar.gz.
10716: ===> Extracting for bison-1.25
10717: ===> Patching for bison-1.25
10718: ===> Ignoring empty patch directory
10719: ===> Configuring for bison-1.25
10720: creating cache ./config.cache
10721: checking for gcc... cc
10722: checking whether we are using GNU C... yes
10723: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10724: checking how to run the C preprocessor... cc -E
10725: checking for minix/config.h... no
10726: checking for POSIXized ISC... no
10727: checking whether cross-compiling... no
10728: checking for ANSI C header files... yes
10729: checking for string.h... yes
10730: checking for stdlib.h... yes
10731: checking for memory.h... yes
10732: checking for working const... yes
10733: checking for working alloca.h... no
10734: checking for alloca... yes
10735: checking for strerror... yes
10736: updating cache ./config.cache
10737: creating ./config.status
10738: creating Makefile
10739: ===> Building for bison-1.25
10740: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
10741: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
10742: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
10743: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
10744: 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
10745: 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
10746: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
10747: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
10748: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
10749: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lex.c
10750: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g main.c
10751: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g nullable.c
10752: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g output.c
10753: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
10754: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reader.c
10755: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reduce.c
10756: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g symtab.c
10757: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g warshall.c
10758: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g version.c
10759: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt.c
10760: 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
10761: 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
10762: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10763: rm -f bison.s1
10764: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10765: <p>Everything seems OK, so install the files:</p>
10766: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10767: >> Checksum OK for bison-1.25.tar.gz.
10768: ===> Installing for bison-1.25
10769: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10770: rm -f /usr/pkg/bin/bison
10771: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10772: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10773: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10774: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10775: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10776: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10777: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10778: ===> Registering installation for bison-1.25</pre>
10779: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10780: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10781: binary package, do this now:</p>
10782: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10783: >> Checksum OK for bison-1.25.tar.gz.
10784: ===> Building package for bison-1.25
10785: Creating package bison-1.25.tgz
10786: Registering depends:.
10787: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10788: <p>Now that you don't need the source and object files
10789: any more, clean up:</p>
10790: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10791: ===> Cleaning for bison-1.25</pre>
10792: </div>
10793: </div>
1.41 asau 10794: <div class="appendix">
10795: <div class="titlepage"><div><div><h1 class="title">
10796: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10797: <div class="toc">
10798: <p><b>Table of Contents</b></p>
1.100 leot 10799: <dl class="toc">
1.1 dsieger 10800: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10801: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10802: </dl>
10803: </div>
1.41 asau 10804: <div class="sect1">
1.1 dsieger 10805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10806: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10807: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10808: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10809: => figlet221.tar.gz doesn't seem to exist on this system.
10810: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10811: => [172219 bytes]
10812: Connected to ftp.plig.net.
10813: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10814: 331 Guest login ok, send your complete e-mail address as password.
10815: 230-You are user #5 of 500 simultaneous users allowed.
10816: 230-
10817: 230- ___ _ _ _
10818: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10819: 230- | _| _| . |_| . | | | . |_| . | _| . |
10820: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10821: 230- |_| |_| |___| |___|
10822: 230-
10823: 230-** Welcome to ftp.plig.org **
10824: 230-
10825: 230-Please note that all transfers from this FTP site are logged. If you
10826: 230-do not like this, please disconnect now.
10827: 230-
1.18 snj 10828: 230-This archive is available via
1.1 dsieger 10829: 230-
10830: 230-HTTP: http://ftp.plig.org/
10831: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10832: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10833: 230-
10834: 230-Please email comments, bug reports and requests for packages to be
10835: 230-mirrored to ftp-admin@plig.org.
10836: 230-
10837: 230-
10838: 230 Logged in anonymously.
10839: Remote system type is UNIX.
10840: Using binary mode to transfer files.
10841: 200 Type okay.
10842: 250 "/pub" is new cwd.
10843: 250-"/pub/figlet" is new cwd.
10844: 250-
10845: 250-Welcome to the figlet archive at ftp.figlet.org
10846: 250-
10847: 250- ftp://ftp.figlet.org/pub/figlet/
10848: 250-
10849: 250-The official FIGlet web page is:
10850: 250- http://www.figlet.org/
10851: 250-
10852: 250-If you have questions, please mailto:info@figlet.org. If you want to
10853: 250-contribute a font or something else, you can email us.
10854: 250
10855: 250 "/pub/figlet/program" is new cwd.
10856: 250 "/pub/figlet/program/unix" is new cwd.
10857: local: figlet221.tar.gz remote: figlet221.tar.gz
10858: 502 Unimplemented command.
10859: 227 Entering Passive Mode (195,40,6,41,246,104)
10860: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10861: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10862: 226 Transfer completed.
10863: 172219 bytes received in 00:02 (75.99 KB/s)
10864: 221 Goodbye.
10865: => Checksum OK for figlet221.tar.gz.
10866: ===> Extracting for figlet-2.2.1nb2
10867: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10868: ===> Patching for figlet-2.2.1nb2
10869: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10870: ===> Overriding tools for figlet-2.2.1nb2
10871: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10872: ===> Configuring for figlet-2.2.1nb2
10873: ===> Building for figlet-2.2.1nb2
10874: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10875: chmod a+x figlet
10876: gcc -O2 -o chkfont chkfont.c
10877: => Unwrapping files-to-be-installed.
10878: <code class="prompt">#</code>
10879: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10880: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10881: ===> Installing for figlet-2.2.1nb2
10882: install -d -o root -g wheel -m 755 /usr/pkg/bin
10883: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10884: mkdir -p /usr/pkg/share/figlet
10885: cp figlet /usr/pkg/bin
10886: cp chkfont /usr/pkg/bin
10887: chmod 555 figlist showfigfonts
10888: cp figlist /usr/pkg/bin
10889: cp showfigfonts /usr/pkg/bin
10890: cp fonts/*.flf /usr/pkg/share/figlet
10891: cp fonts/*.flc /usr/pkg/share/figlet
10892: cp figlet.6 /usr/pkg/man/man6
10893: ===> Registering installation for figlet-2.2.1nb2
10894: <code class="prompt">#</code></pre>
10895: </div>
1.41 asau 10896: <div class="sect1">
1.1 dsieger 10897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10898: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10899: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10900: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10901: ===> Packaging figlet-2.2.1nb2
10902: ===> Building binary package for figlet-2.2.1nb2
10903: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10904: Using SrcDir value of /usr/pkg
10905: Registering depends:.
10906: <code class="prompt">#</code></pre>
10907: </div>
10908: </div>
1.41 asau 10909: <div class="appendix">
10910: <div class="titlepage"><div><div><h1 class="title">
10911: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10912: <div class="toc">
10913: <p><b>Table of Contents</b></p>
1.100 leot 10914: <dl class="toc">
1.23 wiz 10915: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10916: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10917: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10918: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10919: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148 leot 10920: <code class="filename">stable</code>,
1.23 wiz 10921: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10922: source packages</a></span></dt>
10923: </dl>
10924: </div>
10925: <p>As in other big projects, the directory layout of pkgsrc
10926: is quite complex for newbies. This chapter explains where you
10927: find things on the FTP server. The base directory on
1.10 hubertf 10928: <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.1 dsieger 10929: On other servers it may be different, but inside this directory,
10930: everything should look the same, no matter on which server you
10931: are. This directory contains some subdirectories, which are
10932: explained below.</p>
1.41 asau 10933: <div class="sect1">
1.1 dsieger 10934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10935: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 10936: <p>The directory <code class="filename">distfiles</code> contains lots
10937: of archive files from all pkgsrc packages, which are mirrored
10938: here. The subdirectories are called after their package names
10939: and are used when the distributed files have names that don't
10940: explicitly contain a version number or are otherwise too generic
10941: (for example <code class="filename">release.tar.gz</code>).</p>
10942: </div>
1.41 asau 10943: <div class="sect1">
1.1 dsieger 10944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10945: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 10946: <p>This directory contains things that individual pkgsrc
10947: developers find worth publishing.</p>
10948: </div>
1.41 asau 10949: <div class="sect1">
1.1 dsieger 10950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10951: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 10952: <p>This directory contains binary packages for the various
10953: platforms that are supported by pkgsrc.
10954: Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.41 asau 10955: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10956: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10957: operating system for which the packages have been built. The
1.10 hubertf 10958: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10959: command, so it may differ from the one you are used to
10960: hear.</p></li>
1.23 wiz 10961: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 10962: architecture of the platform for which the packages have been
1.10 hubertf 10963: built. It also includes the <code class="varname">ABI</code> (Application
10964: Binary Interface) for platforms that have several of
10965: them.</p></li>
1.23 wiz 10966: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 10967: the operating system. For version numbers that change often (for
10968: example NetBSD-current), the often-changing part should be
10969: replaced with an <code class="literal">x</code>, for example
10970: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 10971: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 10972: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 10973: for a stable branch, or <code class="literal">head</code> for packages
10974: built from the HEAD branch. The latter should only be used when
10975: the packages are updated on a regular basis. Otherwise the date
10976: from checking out pkgsrc should be appended, for example
10977: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10978: </ul></div>
10979: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10980: can quickly click through the directories on the
10981: server and find the best binary packages for their machines. Since they
10982: usually know the operating system and the hardware architecture, OPSYS
10983: and ARCH are placed first. After these choices, they can select the
10984: best combination of OSVERSION and TAG together, since it is usually the
10985: case that packages stay compatible between different version of the
10986: operating system.</p>
10987: <p>In each of these directories, there is a
10988: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10989: <code class="filename">All</code> which contains all binary packages.
10990: Besides that, there are various category directories that
10991: contain symbolic links to the real binary packages.</p>
10992: </div>
1.41 asau 10993: <div class="sect1">
1.1 dsieger 10994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 10995: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 10996: <p>Here are the reports from bulk builds, for those who want
10997: to fix packages that didn't build on some of the platforms. The
1.23 wiz 10998: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 10999: </div>
1.41 asau 11000: <div class="sect1">
1.8 rillig 11001: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11002: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.148 leot 11003: <code class="filename">stable</code>,
1.22 jakllsch 11004: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11005: source packages</h2></div></div></div>
1.23 wiz 11006: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 11007: that is the files that define how to create binary packages from
11008: source archives.</p>
1.149 leot 11009: <p>Each of the <code class="filename">current</code>,
11010: <code class="filename">stable</code> and
11011: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11012: directories share the same structure. They each contain a
11013: <code class="filename">pkgsrc</code> directory and
11014: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 11015: <p>The directory <code class="filename">pkgsrc</code> contains a
11016: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 11017: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11018: as the directory, ready to be downloaded as a whole.</p>
11019: <p>The <code class="filename">current</code> directory contains files
11020: related to the HEAD branch of the CVS repository.
11021: In this directory there is an additional file called
11022: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11023: all pkgsrc <code class="filename">README</code>s with information about
11024: categories and packages.
11025: </p>
11026: <p>The <code class="filename">stable</code> directory is a symlink to
11027: the latest
11028: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11029: </p>
11030: <p>The
11031: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11032: directories contain files related to the
11033: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11034: stable branch of the CVS repository. In these directories there is
11035: an additional file called
11036: <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.1 dsieger 11037: which contains the state of pkgsrc when it was branched.</p>
11038: </div>
11039: </div>
1.41 asau 11040: <div class="appendix">
11041: <div class="titlepage"><div><div><h1 class="title">
1.154 rillig 11042: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
11043: <p>
11044: The following list contains all help topics that are available
11045: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11046: </p>
1.156 leot 11047: <table border="0" summary="Simple list" class="simplelist">
11048: <tr>
11049: <td>#!</td>
11050: <td>-lintl</td>
11051: </tr>
11052: <tr>
11053: <td>64bit</td>
11054: <td>ABI</td>
11055: </tr>
11056: <tr>
11057: <td>ACCEPTABLE_LICENSES</td>
11058: <td>ACROREAD_FONTPATH</td>
11059: </tr>
11060: <tr>
11061: <td>ADDITIONAL</td>
11062: <td>AFAIK</td>
11063: </tr>
11064: <tr>
11065: <td>AIX</td>
11066: <td>ALLOW_VULNERABLE_PACKAGES</td>
11067: </tr>
11068: <tr>
11069: <td>ALL_ENV</td>
1.177 leot 11070: <td>ALSA_PC</td>
11071: </tr>
11072: <tr>
1.175 gutterid 11073: <td>ALTERNATIVES_SRC</td>
1.177 leot 11074: <td>AMANDA_TMP</td>
1.161 leot 11075: </tr>
11076: <tr>
1.175 gutterid 11077: <td>AMANDA_USER</td>
1.177 leot 11078: <td>AMANDA_VAR</td>
1.159 rillig 11079: </tr>
11080: <tr>
1.175 gutterid 11081: <td>APACHE_GROUP</td>
1.177 leot 11082: <td>APACHE_MODULE_NAME</td>
1.156 leot 11083: </tr>
11084: <tr>
1.175 gutterid 11085: <td>APACHE_MODULE_SRC</td>
1.177 leot 11086: <td>APACHE_MODULE_SRCDIR</td>
1.156 leot 11087: </tr>
11088: <tr>
1.175 gutterid 11089: <td>APACHE_PKG_PREFIX</td>
1.177 leot 11090: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.156 leot 11091: </tr>
11092: <tr>
1.175 gutterid 11093: <td>APACHE_SUEXEC_DOCROOT</td>
1.177 leot 11094: <td>APACHE_USER</td>
1.156 leot 11095: </tr>
11096: <tr>
1.175 gutterid 11097: <td>APPEND_ABI</td>
1.177 leot 11098: <td>APPEND_ELF</td>
1.156 leot 11099: </tr>
11100: <tr>
1.175 gutterid 11101: <td>ARLA_CACHE</td>
1.177 leot 11102: <td>AUDIT_PACKAGES_FLAGS</td>
1.156 leot 11103: </tr>
11104: <tr>
1.175 gutterid 11105: <td>AUTOCONF_REQD</td>
1.177 leot 11106: <td>AUTOMAKE_OVERRIDE</td>
1.156 leot 11107: </tr>
11108: <tr>
1.175 gutterid 11109: <td>AUTOMAKE_REQD</td>
1.177 leot 11110: <td>AUTO_MKDIRS</td>
1.156 leot 11111: </tr>
11112: <tr>
1.175 gutterid 11113: <td>BDB185_DEFAULT</td>
1.177 leot 11114: <td>BDBBASE</td>
1.156 leot 11115: </tr>
11116: <tr>
1.175 gutterid 11117: <td>BDB_ACCEPTED</td>
1.177 leot 11118: <td>BDB_DEFAULT</td>
1.156 leot 11119: </tr>
11120: <tr>
1.175 gutterid 11121: <td>BDB_LIBS</td>
1.177 leot 11122: <td>BDB_TYPE</td>
1.156 leot 11123: </tr>
11124: <tr>
1.175 gutterid 11125: <td>BIND_DIR</td>
1.177 leot 11126: <td>BIND_GROUP</td>
1.156 leot 11127: </tr>
11128: <tr>
1.175 gutterid 11129: <td>BIND_USER</td>
1.177 leot 11130: <td>BINPKG_SITES</td>
1.156 leot 11131: </tr>
11132: <tr>
1.175 gutterid 11133: <td>BIN_INSTALL_FLAGS</td>
1.177 leot 11134: <td>BISON_PKGDATADIR</td>
11135: </tr>
11136: <tr>
11137: <td>BLAS_ACCEPTED</td>
11138: <td>BLAS_LIBS</td>
1.156 leot 11139: </tr>
11140: <tr>
1.177 leot 11141: <td>BLAS_TYPE</td>
1.156 leot 11142: <td>BOOTSTRAP_DEPENDS</td>
11143: </tr>
11144: <tr>
11145: <td>BOOTSTRAP_SETUPTOOLS</td>
11146: <td>BROKEN</td>
11147: </tr>
11148: <tr>
11149: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
11150: <td>BROKEN_ON_PLATFORM</td>
11151: </tr>
11152: <tr>
11153: <td>BSDSRCDIR</td>
11154: <td>BSDXSRCDIR</td>
11155: </tr>
11156: <tr>
11157: <td>BSD_MAKE_ENV</td>
11158: <td>BUILDLINK_AUTO_DIRS</td>
11159: </tr>
11160: <tr>
11161: <td>BUILDLINK_AUTO_VARS</td>
11162: <td>BUILDLINK_CFLAGS</td>
11163: </tr>
11164: <tr>
11165: <td>BUILDLINK_CONTENTS_FILTER</td>
11166: <td>BUILDLINK_CPPFLAGS</td>
11167: </tr>
11168: <tr>
11169: <td>BUILDLINK_DEPMETHOD</td>
11170: <td>BUILDLINK_FILES</td>
11171: </tr>
11172: <tr>
11173: <td>BUILDLINK_FILES_CMD</td>
11174: <td>BUILDLINK_FNAME_TRANSFORM</td>
11175: </tr>
11176: <tr>
11177: <td>BUILDLINK_LDFLAGS</td>
11178: <td>BUILDLINK_LIBS</td>
11179: </tr>
11180: <tr>
11181: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
11182: <td>BUILDLINK_PKGNAME</td>
11183: </tr>
11184: <tr>
11185: <td>BUILDLINK_PREFIX</td>
11186: <td>BUILDLINK_RPATHDIRS</td>
11187: </tr>
11188: <tr>
11189: <td>BUILDLINK_TREE</td>
11190: <td>BUILD_DEFS</td>
11191: </tr>
11192: <tr>
11193: <td>BUILD_DEFS_EFFECTS</td>
11194: <td>BUILD_DEPENDS</td>
11195: </tr>
11196: <tr>
11197: <td>BUILD_DIRS</td>
11198: <td>BUILD_ENV_SHELL</td>
11199: </tr>
11200: <tr>
11201: <td>BUILD_MAKE_CMD</td>
11202: <td>BUILD_MAKE_FLAGS</td>
11203: </tr>
11204: <tr>
11205: <td>BUILD_TARGET</td>
11206: <td>BUILTIN_FIND_FILES</td>
11207: </tr>
11208: <tr>
11209: <td>BUILTIN_FIND_FILES_VAR</td>
11210: <td>BUILTIN_FIND_GREP</td>
11211: </tr>
11212: <tr>
11213: <td>BUILTIN_FIND_HEADERS</td>
11214: <td>BUILTIN_FIND_HEADERS_VAR</td>
11215: </tr>
11216: <tr>
11217: <td>BUILTIN_PKG</td>
11218: <td>BUILTIN_TEST_CURSES_DEFINES</td>
11219: </tr>
11220: <tr>
11221: <td>BUILTIN_TEST_CURSES_FUNCS</td>
11222: <td>BUILTIN_VERSION_SCRIPT</td>
11223: </tr>
11224: <tr>
11225: <td>BUILTIN_X11_TYPE</td>
11226: <td>BUILTIN_X11_VERSION</td>
11227: </tr>
11228: <tr>
11229: <td>CACTI_GROUP</td>
11230: <td>CACTI_USER</td>
11231: </tr>
11232: <tr>
11233: <td>CANNA_GROUP</td>
11234: <td>CANNA_USER</td>
11235: </tr>
11236: <tr>
11237: <td>CAT</td>
11238: <td>CCACHE_BASE</td>
11239: </tr>
11240: <tr>
11241: <td>CCACHE_DIR</td>
11242: <td>CCACHE_LOGFILE</td>
11243: </tr>
11244: <tr>
11245: <td>CC_VERSION</td>
11246: <td>CC_VERSION_STRING</td>
11247: </tr>
11248: <tr>
11249: <td>CDRECORD_CONF</td>
11250: <td>CDROM_PKG_URL_DIR</td>
11251: </tr>
11252: <tr>
11253: <td>CDROM_PKG_URL_HOST</td>
1.177 leot 11254: <td>CHECKOUT_DATE</td>
11255: </tr>
11256: <tr>
1.180 ! rillig 11257: <td>CHECK_COMPILER</td>
1.175 gutterid 11258: <td>CHECK_FAKEHOME</td>
1.161 leot 11259: </tr>
11260: <tr>
1.180 ! rillig 11261: <td>CHECK_FILES</td>
1.175 gutterid 11262: <td>CHECK_FILES_SKIP</td>
1.159 rillig 11263: </tr>
11264: <tr>
1.180 ! rillig 11265: <td>CHECK_FILES_STRICT</td>
1.175 gutterid 11266: <td>CHECK_HEADERS</td>
1.156 leot 11267: </tr>
11268: <tr>
1.180 ! rillig 11269: <td>CHECK_HEADERS_SKIP</td>
1.175 gutterid 11270: <td>CHECK_INTERPRETER</td>
1.156 leot 11271: </tr>
11272: <tr>
1.180 ! rillig 11273: <td>CHECK_INTERPRETER_SKIP</td>
1.175 gutterid 11274: <td>CHECK_PERMS</td>
1.156 leot 11275: </tr>
11276: <tr>
1.180 ! rillig 11277: <td>CHECK_PERMS_AUTOFIX</td>
1.175 gutterid 11278: <td>CHECK_PERMS_SKIP</td>
1.156 leot 11279: </tr>
11280: <tr>
1.180 ! rillig 11281: <td>CHECK_PORTABILITY</td>
1.177 leot 11282: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.156 leot 11283: </tr>
11284: <tr>
1.180 ! rillig 11285: <td>CHECK_PORTABILITY_SKIP</td>
1.161 leot 11286: <td>CHECK_RELRO</td>
1.156 leot 11287: </tr>
11288: <tr>
1.180 ! rillig 11289: <td>CHECK_RELRO_SKIP</td>
1.161 leot 11290: <td>CHECK_RELRO_SUPPORTED</td>
1.156 leot 11291: </tr>
11292: <tr>
1.180 ! rillig 11293: <td>CHECK_SHLIBS</td>
1.161 leot 11294: <td>CHECK_SHLIBS_BLACKLIST</td>
1.156 leot 11295: </tr>
11296: <tr>
1.180 ! rillig 11297: <td>CHECK_SHLIBS_SKIP</td>
1.161 leot 11298: <td>CHECK_SHLIBS_SUPPORTED</td>
1.156 leot 11299: </tr>
11300: <tr>
1.180 ! rillig 11301: <td>CHECK_SSP</td>
1.161 leot 11302: <td>CHECK_SSP_SKIP</td>
1.156 leot 11303: </tr>
11304: <tr>
1.180 ! rillig 11305: <td>CHECK_SSP_SUPPORTED</td>
1.161 leot 11306: <td>CHECK_STRIPPED</td>
1.156 leot 11307: </tr>
11308: <tr>
1.180 ! rillig 11309: <td>CHECK_STRIPPED_SKIP</td>
1.161 leot 11310: <td>CHECK_WRKREF</td>
1.156 leot 11311: </tr>
11312: <tr>
1.180 ! rillig 11313: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.161 leot 11314: <td>CHECK_WRKREF_SKIP</td>
1.156 leot 11315: </tr>
11316: <tr>
1.180 ! rillig 11317: <td>CLAMAV_DBDIR</td>
1.161 leot 11318: <td>CLAMAV_GROUP</td>
1.156 leot 11319: </tr>
11320: <tr>
1.180 ! rillig 11321: <td>CLAMAV_USER</td>
1.161 leot 11322: <td>CLANGBASE</td>
1.156 leot 11323: </tr>
11324: <tr>
1.180 ! rillig 11325: <td>CLEANDEPENDS</td>
1.161 leot 11326: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156 leot 11327: </tr>
11328: <tr>
1.180 ! rillig 11329: <td>CMAKE_INSTALL_PREFIX</td>
1.161 leot 11330: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.156 leot 11331: </tr>
11332: <tr>
1.180 ! rillig 11333: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.161 leot 11334: <td>CMAKE_PREFIX_PATH</td>
1.156 leot 11335: </tr>
11336: <tr>
1.180 ! rillig 11337: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.177 leot 11338: <td>COMMON_LISP_DOCFILES</td>
11339: </tr>
11340: <tr>
1.180 ! rillig 11341: <td>COMMON_LISP_EXAMPLES</td>
1.177 leot 11342: <td>COMMON_LISP_EXTRAFILES</td>
11343: </tr>
11344: <tr>
1.180 ! rillig 11345: <td>COMMON_LISP_PACKAGES</td>
1.177 leot 11346: <td>COMMON_LISP_SYSTEM</td>
11347: </tr>
11348: <tr>
1.180 ! rillig 11349: <td>COMPILER_RPATH_FLAG</td>
1.156 leot 11350: <td>COMPILER_USE_SYMLINKS</td>
11351: </tr>
11352: <tr>
1.180 ! rillig 11353: <td>CONFIGURE_ARGS</td>
1.156 leot 11354: <td>CONFIGURE_DIRS</td>
11355: </tr>
11356: <tr>
1.180 ! rillig 11357: <td>CONFIGURE_ENV</td>
1.172 rillig 11358: <td>CONFIGURE_ENV_SHELL</td>
1.156 leot 11359: </tr>
11360: <tr>
1.180 ! rillig 11361: <td>CONFIGURE_HAS_INFODIR</td>
1.156 leot 11362: <td>CONFIGURE_HAS_MANDIR</td>
11363: </tr>
11364: <tr>
1.180 ! rillig 11365: <td>CONFIGURE_SCRIPT</td>
1.156 leot 11366: <td>CONFIG_SHELL</td>
11367: </tr>
11368: <tr>
1.180 ! rillig 11369: <td>CONFIG_SHELL_FLAGS</td>
1.156 leot 11370: <td>CONF_FILES</td>
11371: </tr>
11372: <tr>
1.180 ! rillig 11373: <td>CONF_FILES_MODE</td>
1.156 leot 11374: <td>CONF_FILES_PERMS</td>
11375: </tr>
11376: <tr>
1.180 ! rillig 11377: <td>CONSERVER_DEFAULTHOST</td>
1.156 leot 11378: <td>CONSERVER_DEFAULTPORT</td>
11379: </tr>
11380: <tr>
1.180 ! rillig 11381: <td>CP</td>
1.156 leot 11382: <td>CPP</td>
11383: </tr>
11384: <tr>
1.180 ! rillig 11385: <td>CPP_PRECOMP_FLAGS</td>
1.156 leot 11386: <td>CREATE_WRKDIR_SYMLINK</td>
11387: </tr>
11388: <tr>
1.180 ! rillig 11389: <td>CROSSBASE</td>
1.156 leot 11390: <td>CTFCONVERT</td>
11391: </tr>
11392: <tr>
1.180 ! rillig 11393: <td>CTF_FILES_SKIP</td>
1.156 leot 11394: <td>CTF_SUPPORTED</td>
11395: </tr>
11396: <tr>
1.180 ! rillig 11397: <td>CTYPE</td>
1.156 leot 11398: <td>CUPS_GROUP</td>
11399: </tr>
11400: <tr>
1.180 ! rillig 11401: <td>CUPS_SYSTEM_GROUPS</td>
1.156 leot 11402: <td>CUPS_USER</td>
11403: </tr>
11404: <tr>
1.180 ! rillig 11405: <td>CURSES_DEFAULT</td>
1.156 leot 11406: <td>CURSES_TYPE</td>
1.177 leot 11407: </tr>
11408: <tr>
1.180 ! rillig 11409: <td>CVS_EXTRACTDIR</td>
1.177 leot 11410: <td>CVS_MODULE</td>
11411: </tr>
11412: <tr>
1.180 ! rillig 11413: <td>CVS_PROJECT</td>
1.177 leot 11414: <td>CVS_REPOSITORIES</td>
11415: </tr>
11416: <tr>
1.180 ! rillig 11417: <td>CVS_ROOT</td>
1.177 leot 11418: <td>CVS_ROOT_GNU</td>
11419: </tr>
11420: <tr>
1.180 ! rillig 11421: <td>CVS_ROOT_NONGNU</td>
1.177 leot 11422: <td>CVS_ROOT_SOURCEFORGE</td>
1.161 leot 11423: </tr>
11424: <tr>
1.180 ! rillig 11425: <td>CVS_TAG</td>
1.160 brook 11426: <td>CXX</td>
1.159 rillig 11427: </tr>
11428: <tr>
1.180 ! rillig 11429: <td>CYRUS_GROUP</td>
1.160 brook 11430: <td>CYRUS_IDLE</td>
1.156 leot 11431: </tr>
11432: <tr>
1.180 ! rillig 11433: <td>CYRUS_USER</td>
1.160 brook 11434: <td>DAEMONTOOLS_GROUP</td>
1.156 leot 11435: </tr>
11436: <tr>
1.180 ! rillig 11437: <td>DAEMONTOOLS_LOG_USER</td>
1.160 brook 11438: <td>DBUS_GROUP</td>
1.156 leot 11439: </tr>
11440: <tr>
1.180 ! rillig 11441: <td>DBUS_USER</td>
1.160 brook 11442: <td>DEFANG_GROUP</td>
1.156 leot 11443: </tr>
11444: <tr>
1.180 ! rillig 11445: <td>DEFANG_USER</td>
1.160 brook 11446: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.156 leot 11447: </tr>
11448: <tr>
1.180 ! rillig 11449: <td>DEFAULT_DISTFILES</td>
1.160 brook 11450: <td>DEFAULT_IRC_SERVER</td>
1.156 leot 11451: </tr>
11452: <tr>
1.180 ! rillig 11453: <td>DEFAULT_SERIAL_DEVICE</td>
1.160 brook 11454: <td>DEF_UMASK</td>
1.156 leot 11455: </tr>
11456: <tr>
1.180 ! rillig 11457: <td>DEINSTALLDEPENDS</td>
1.160 brook 11458: <td>DEINSTALL_SRC</td>
1.156 leot 11459: </tr>
11460: <tr>
1.180 ! rillig 11461: <td>DEINSTALL_TEMPLATES</td>
1.160 brook 11462: <td>DELAYED_ERROR_MSG</td>
1.156 leot 11463: </tr>
11464: <tr>
1.180 ! rillig 11465: <td>DELAYED_WARNING_MSG</td>
1.160 brook 11466: <td>DEPENDS</td>
1.156 leot 11467: </tr>
11468: <tr>
1.180 ! rillig 11469: <td>DEPENDS_TARGET</td>
1.160 brook 11470: <td>DEPENDS_TYPE</td>
1.156 leot 11471: </tr>
11472: <tr>
1.180 ! rillig 11473: <td>DESTDIR</td>
1.160 brook 11474: <td>DESTDIR_VARNAME</td>
1.156 leot 11475: </tr>
11476: <tr>
1.180 ! rillig 11477: <td>DIALER_GROUP</td>
1.160 brook 11478: <td>DIGEST_REQD</td>
1.156 leot 11479: </tr>
11480: <tr>
1.180 ! rillig 11481: <td>DISTDIR</td>
1.160 brook 11482: <td>DISTFILES</td>
1.156 leot 11483: </tr>
11484: <tr>
1.180 ! rillig 11485: <td>DISTINFO_FILE</td>
1.160 brook 11486: <td>DISTNAME</td>
1.156 leot 11487: </tr>
11488: <tr>
1.180 ! rillig 11489: <td>DIST_PATH</td>
1.160 brook 11490: <td>DIST_SUBDIR</td>
1.156 leot 11491: </tr>
11492: <tr>
1.180 ! rillig 11493: <td>DJBDNS_AXFR_USER</td>
1.160 brook 11494: <td>DJBDNS_CACHE_USER</td>
1.156 leot 11495: </tr>
11496: <tr>
1.180 ! rillig 11497: <td>DJBDNS_DJBDNS_GROUP</td>
1.160 brook 11498: <td>DJBDNS_LOG_USER</td>
1.156 leot 11499: </tr>
11500: <tr>
1.180 ! rillig 11501: <td>DJBDNS_RBL_USER</td>
1.160 brook 11502: <td>DJBDNS_TINY_USER</td>
1.156 leot 11503: </tr>
11504: <tr>
1.180 ! rillig 11505: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.160 brook 11506: <td>DL_AUTO_VARS</td>
1.156 leot 11507: </tr>
11508: <tr>
1.180 ! rillig 11509: <td>DL_CFLAGS</td>
1.160 brook 11510: <td>DL_LDFLAGS</td>
1.156 leot 11511: </tr>
11512: <tr>
1.180 ! rillig 11513: <td>DL_LIBS</td>
1.160 brook 11514: <td>DNS</td>
1.156 leot 11515: </tr>
11516: <tr>
1.180 ! rillig 11517: <td>DOWNLOADED_DISTFILE</td>
1.160 brook 11518: <td>DT_LAYOUT</td>
1.156 leot 11519: </tr>
11520: <tr>
1.180 ! rillig 11521: <td>DYNAMIC_SITES_CMD</td>
1.160 brook 11522: <td>DYNAMIC_SITES_SCRIPT</td>
1.156 leot 11523: </tr>
11524: <tr>
1.180 ! rillig 11525: <td>ECHO</td>
1.160 brook 11526: <td>ECHO_N</td>
1.156 leot 11527: </tr>
11528: <tr>
1.180 ! rillig 11529: <td>ELK_GUI</td>
1.160 brook 11530: <td>EMACS_TYPE</td>
1.156 leot 11531: </tr>
11532: <tr>
1.180 ! rillig 11533: <td>EMULDIR</td>
1.160 brook 11534: <td>EMULSUBDIR</td>
1.156 leot 11535: </tr>
11536: <tr>
1.180 ! rillig 11537: <td>EMULSUBDIRSLASH</td>
1.160 brook 11538: <td>EMUL_ARCH</td>
1.156 leot 11539: </tr>
11540: <tr>
1.180 ! rillig 11541: <td>EMUL_DISTRO</td>
1.160 brook 11542: <td>EMUL_EXEC_FMT</td>
1.156 leot 11543: </tr>
11544: <tr>
1.180 ! rillig 11545: <td>EMUL_IS_NATIVE</td>
1.160 brook 11546: <td>EMUL_MODULES</td>
1.156 leot 11547: </tr>
11548: <tr>
1.180 ! rillig 11549: <td>EMUL_OPSYS</td>
1.160 brook 11550: <td>EMUL_PKG_FMT</td>
1.156 leot 11551: </tr>
11552: <tr>
1.180 ! rillig 11553: <td>EMUL_PLATFORM</td>
1.160 brook 11554: <td>EMUL_PLATFORMS</td>
1.156 leot 11555: </tr>
11556: <tr>
1.180 ! rillig 11557: <td>EMUL_PREFER</td>
1.160 brook 11558: <td>EMUL_REQD</td>
1.156 leot 11559: </tr>
11560: <tr>
1.180 ! rillig 11561: <td>EMUL_TYPE</td>
1.160 brook 11562: <td>ERROR_MSG</td>
1.156 leot 11563: </tr>
11564: <tr>
1.180 ! rillig 11565: <td>EXIM_GROUP</td>
1.160 brook 11566: <td>EXIM_USER</td>
1.156 leot 11567: </tr>
11568: <tr>
1.180 ! rillig 11569: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.160 brook 11570: <td>EXTRACTOR</td>
1.156 leot 11571: </tr>
11572: <tr>
1.180 ! rillig 11573: <td>EXTRACT_CMD</td>
1.160 brook 11574: <td>EXTRACT_CMD_DEFAULT</td>
1.156 leot 11575: </tr>
11576: <tr>
1.180 ! rillig 11577: <td>EXTRACT_DIR</td>
1.160 brook 11578: <td>EXTRACT_ELEMENTS</td>
1.156 leot 11579: </tr>
11580: <tr>
1.180 ! rillig 11581: <td>EXTRACT_ENV</td>
1.160 brook 11582: <td>EXTRACT_ONLY</td>
1.156 leot 11583: </tr>
11584: <tr>
1.180 ! rillig 11585: <td>EXTRACT_OPTS</td>
1.160 brook 11586: <td>EXTRACT_SUFX</td>
1.156 leot 11587: </tr>
11588: <tr>
1.180 ! rillig 11589: <td>EXTRACT_USING</td>
1.177 leot 11590: <td>FAIL</td>
11591: </tr>
11592: <tr>
1.180 ! rillig 11593: <td>FAILOVER_FETCH</td>
1.175 gutterid 11594: <td>FAIL_MSG</td>
1.156 leot 11595: </tr>
11596: <tr>
1.180 ! rillig 11597: <td>FAKE_NCURSES</td>
1.175 gutterid 11598: <td>FAM</td>
1.156 leot 11599: </tr>
11600: <tr>
1.180 ! rillig 11601: <td>FAM_ACCEPTED</td>
1.175 gutterid 11602: <td>FAM_DEFAULT</td>
1.156 leot 11603: </tr>
11604: <tr>
1.180 ! rillig 11605: <td>FAM_SERVER</td>
1.175 gutterid 11606: <td>FCPATH</td>
1.156 leot 11607: </tr>
11608: <tr>
1.180 ! rillig 11609: <td>FEATURE_CPPFLAGS</td>
1.175 gutterid 11610: <td>FEATURE_LDFLAGS</td>
1.156 leot 11611: </tr>
11612: <tr>
1.180 ! rillig 11613: <td>FEATURE_LIBS</td>
1.175 gutterid 11614: <td>FETCH_AFTER_ARGS</td>
1.156 leot 11615: </tr>
11616: <tr>
1.180 ! rillig 11617: <td>FETCH_BEFORE_ARGS</td>
1.175 gutterid 11618: <td>FETCH_CMD</td>
1.156 leot 11619: </tr>
11620: <tr>
1.180 ! rillig 11621: <td>FETCH_OUTPUT_ARGS</td>
1.175 gutterid 11622: <td>FETCH_PROXY</td>
1.156 leot 11623: </tr>
11624: <tr>
1.180 ! rillig 11625: <td>FETCH_RESUME_ARGS</td>
1.175 gutterid 11626: <td>FETCH_USING</td>
1.156 leot 11627: </tr>
11628: <tr>
1.180 ! rillig 11629: <td>FILES_SUBST</td>
1.175 gutterid 11630: <td>FILES_SUBST_SED</td>
1.156 leot 11631: </tr>
11632: <tr>
1.180 ! rillig 11633: <td>FIX_SYSTEM_HEADERS</td>
1.175 gutterid 11634: <td>FLUXBOX_USE_GNOME</td>
1.156 leot 11635: </tr>
11636: <tr>
1.180 ! rillig 11637: <td>FLUXBOX_USE_KDE</td>
1.175 gutterid 11638: <td>FLUXBOX_USE_XFT</td>
1.156 leot 11639: </tr>
11640: <tr>
1.180 ! rillig 11641: <td>FLUXBOX_USE_XINERAMA</td>
1.177 leot 11642: <td>FONTDIR</td>
1.156 leot 11643: </tr>
11644: <tr>
1.180 ! rillig 11645: <td>FONTS_DIRS</td>
1.172 rillig 11646: <td>FONTS_VERBOSE</td>
1.161 leot 11647: </tr>
11648: <tr>
1.180 ! rillig 11649: <td>FOO_HACKS_MK</td>
1.177 leot 11650: <td>FOSSIL_EXTRACTDIR</td>
11651: </tr>
11652: <tr>
1.180 ! rillig 11653: <td>FOSSIL_REPO</td>
1.177 leot 11654: <td>FOSSIL_REPOSITORIES</td>
11655: </tr>
11656: <tr>
1.180 ! rillig 11657: <td>FOSSIL_VERSION</td>
1.172 rillig 11658: <td>FOX_USE_XUNICODE</td>
1.156 leot 11659: </tr>
11660: <tr>
1.180 ! rillig 11661: <td>FREEWNN_GROUP</td>
1.172 rillig 11662: <td>FREEWNN_USER</td>
1.156 leot 11663: </tr>
11664: <tr>
1.180 ! rillig 11665: <td>FTP_PKG_URL_DIR</td>
1.172 rillig 11666: <td>FTP_PKG_URL_HOST</td>
1.156 leot 11667: </tr>
11668: <tr>
1.180 ! rillig 11669: <td>GAMEDATAMODE</td>
1.172 rillig 11670: <td>GAMEDATA_PERMS</td>
1.156 leot 11671: </tr>
11672: <tr>
1.180 ! rillig 11673: <td>GAMEDIRMODE</td>
1.172 rillig 11674: <td>GAMEDIR_PERMS</td>
1.156 leot 11675: </tr>
11676: <tr>
1.180 ! rillig 11677: <td>GAMEGRP</td>
1.172 rillig 11678: <td>GAMEMODE</td>
1.156 leot 11679: </tr>
11680: <tr>
1.180 ! rillig 11681: <td>GAMEOWN</td>
1.172 rillig 11682: <td>GAMES_GROUP</td>
1.156 leot 11683: </tr>
11684: <tr>
1.180 ! rillig 11685: <td>GAMES_USER</td>
1.172 rillig 11686: <td>GCC</td>
1.156 leot 11687: </tr>
11688: <tr>
1.180 ! rillig 11689: <td>GCCBASE</td>
1.172 rillig 11690: <td>GCC_REQD</td>
1.156 leot 11691: </tr>
11692: <tr>
1.180 ! rillig 11693: <td>GCC_VERSION_SUFFIX</td>
1.172 rillig 11694: <td>GEM_BUILD</td>
1.156 leot 11695: </tr>
11696: <tr>
1.180 ! rillig 11697: <td>GEM_CLEANBUILD</td>
1.172 rillig 11698: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.156 leot 11699: </tr>
11700: <tr>
1.180 ! rillig 11701: <td>GEM_DOCDIR</td>
1.172 rillig 11702: <td>GEM_EXTSDIR</td>
1.156 leot 11703: </tr>
11704: <tr>
1.180 ! rillig 11705: <td>GEM_HOME</td>
1.177 leot 11706: <td>GEM_KEEPBUILD</td>
11707: </tr>
11708: <tr>
1.180 ! rillig 11709: <td>GEM_LIBDIR</td>
1.156 leot 11710: <td>GEM_NAME</td>
11711: </tr>
11712: <tr>
1.180 ! rillig 11713: <td>GEM_PATH</td>
1.156 leot 11714: <td>GEM_SPECFILE</td>
11715: </tr>
11716: <tr>
1.180 ! rillig 11717: <td>GENERATE_PLIST</td>
1.156 leot 11718: <td>GHOSTSCRIPT_REQD</td>
11719: </tr>
11720: <tr>
1.180 ! rillig 11721: <td>GITHUB_PROJECT</td>
1.156 leot 11722: <td>GITHUB_RELEASE</td>
11723: </tr>
11724: <tr>
1.180 ! rillig 11725: <td>GITHUB_TAG</td>
1.156 leot 11726: <td>GITHUB_TYPE</td>
1.177 leot 11727: </tr>
11728: <tr>
1.180 ! rillig 11729: <td>GITLAB_PROJECT</td>
1.177 leot 11730: <td>GITLAB_TAG</td>
11731: </tr>
11732: <tr>
1.180 ! rillig 11733: <td>GITLAB_TYPE</td>
1.177 leot 11734: <td>GIT_BRANCH</td>
1.161 leot 11735: </tr>
11736: <tr>
1.180 ! rillig 11737: <td>GIT_ENV</td>
1.177 leot 11738: <td>GIT_EXTRACTDIR</td>
11739: </tr>
11740: <tr>
1.180 ! rillig 11741: <td>GIT_REPO</td>
1.177 leot 11742: <td>GIT_REPOSITORIES</td>
11743: </tr>
11744: <tr>
1.180 ! rillig 11745: <td>GIT_REVISION</td>
1.177 leot 11746: <td>GIT_TAG</td>
11747: </tr>
11748: <tr>
1.180 ! rillig 11749: <td>GNU</td>
1.175 gutterid 11750: <td>GNU_CONFIGURE</td>
1.159 rillig 11751: </tr>
11752: <tr>
1.180 ! rillig 11753: <td>GNU_CONFIGURE_INFODIR</td>
1.175 gutterid 11754: <td>GNU_CONFIGURE_MANDIR</td>
1.156 leot 11755: </tr>
11756: <tr>
1.180 ! rillig 11757: <td>GNU_CONFIGURE_QUIET</td>
1.178 rillig 11758: <td>GNU_CONFIGURE_STRICT</td>
1.156 leot 11759: </tr>
11760: <tr>
1.180 ! rillig 11761: <td>GODEP_REDIRECTS</td>
1.178 rillig 11762: <td>GO_BUILD_PATTERN</td>
1.156 leot 11763: </tr>
11764: <tr>
1.180 ! rillig 11765: <td>GO_DEPS</td>
1.178 rillig 11766: <td>GO_DIST_BASE</td>
1.156 leot 11767: </tr>
11768: <tr>
1.180 ! rillig 11769: <td>GO_MODULE_FILES</td>
1.178 rillig 11770: <td>GO_SRCPATH</td>
1.156 leot 11771: </tr>
11772: <tr>
1.180 ! rillig 11773: <td>GO_VERSION_DEFAULT</td>
1.178 rillig 11774: <td>GROUP_SPECIFIC_PKGS</td>
1.156 leot 11775: </tr>
11776: <tr>
1.180 ! rillig 11777: <td>GRUB_NETWORK_CARDS</td>
1.178 rillig 11778: <td>GRUB_PRESET_COMMAND</td>
1.156 leot 11779: </tr>
11780: <tr>
1.180 ! rillig 11781: <td>GRUB_SCAN_ARGS</td>
1.178 rillig 11782: <td>GZIP</td>
1.156 leot 11783: </tr>
11784: <tr>
1.180 ! rillig 11785: <td>HASKELL_COMPILER</td>
1.178 rillig 11786: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.156 leot 11787: </tr>
11788: <tr>
1.180 ! rillig 11789: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.178 rillig 11790: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.156 leot 11791: </tr>
11792: <tr>
1.180 ! rillig 11793: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.178 rillig 11794: <td>HAS_CONFIGURE</td>
1.177 leot 11795: </tr>
11796: <tr>
1.180 ! rillig 11797: <td>HEADER_TEMPLATES</td>
1.178 rillig 11798: <td>HG_REPO</td>
1.161 leot 11799: </tr>
11800: <tr>
1.180 ! rillig 11801: <td>HG_REPOSITORIES</td>
1.178 rillig 11802: <td>HG_TAG</td>
1.156 leot 11803: </tr>
11804: <tr>
1.180 ! rillig 11805: <td>HOST_PKGTOOLS_ARGS</td>
1.178 rillig 11806: <td>HOST_SPECIFIC_PKGS</td>
1.156 leot 11807: </tr>
11808: <tr>
1.180 ! rillig 11809: <td>HOWL_GROUP</td>
1.178 rillig 11810: <td>HOWL_USER</td>
1.156 leot 11811: </tr>
11812: <tr>
1.180 ! rillig 11813: <td>ICCBASE</td>
1.178 rillig 11814: <td>ICECAST_CHROOTDIR</td>
1.156 leot 11815: </tr>
11816: <tr>
1.180 ! rillig 11817: <td>ICON_THEMES</td>
1.178 rillig 11818: <td>IDOBASE</td>
1.156 leot 11819: </tr>
11820: <tr>
1.180 ! rillig 11821: <td>IGNORE_CCACHE</td>
1.178 rillig 11822: <td>IGNORE_INFO_DIRS</td>
1.156 leot 11823: </tr>
11824: <tr>
1.180 ! rillig 11825: <td>IGNORE_INTERACTIVE_FETCH</td>
1.178 rillig 11826: <td>IMAKE</td>
1.156 leot 11827: </tr>
11828: <tr>
1.180 ! rillig 11829: <td>IMAKEOPTS</td>
1.178 rillig 11830: <td>IMAKE_MAKE</td>
1.156 leot 11831: </tr>
11832: <tr>
1.180 ! rillig 11833: <td>IMAKE_MANINSTALL</td>
1.178 rillig 11834: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.156 leot 11835: </tr>
11836: <tr>
1.180 ! rillig 11837: <td>IMDICTDIR</td>
1.178 rillig 11838: <td>INCOMPAT_CURSES</td>
1.156 leot 11839: </tr>
11840: <tr>
1.180 ! rillig 11841: <td>INFO_DIR</td>
1.178 rillig 11842: <td>INFO_FILES</td>
1.156 leot 11843: </tr>
11844: <tr>
1.180 ! rillig 11845: <td>INFO_FILES_VERBOSE</td>
1.178 rillig 11846: <td>INFO_MSG</td>
1.156 leot 11847: </tr>
11848: <tr>
1.180 ! rillig 11849: <td>INIT_SYSTEM</td>
1.178 rillig 11850: <td>INN_DATA_DIR</td>
1.156 leot 11851: </tr>
11852: <tr>
1.180 ! rillig 11853: <td>INN_GROUP</td>
1.178 rillig 11854: <td>INN_USER</td>
1.172 rillig 11855: </tr>
11856: <tr>
1.180 ! rillig 11857: <td>INSTALLATION_DIRS</td>
1.178 rillig 11858: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.156 leot 11859: </tr>
11860: <tr>
1.180 ! rillig 11861: <td>INSTALL_ENV</td>
1.178 rillig 11862: <td>INSTALL_SH_OVERRIDE</td>
1.156 leot 11863: </tr>
11864: <tr>
1.180 ! rillig 11865: <td>INSTALL_SRC</td>
1.178 rillig 11866: <td>INSTALL_TEMPLATES</td>
1.156 leot 11867: </tr>
11868: <tr>
1.180 ! rillig 11869: <td>INSTALL_UNSTRIPPED</td>
1.178 rillig 11870: <td>IRCD_HYBRID_IRC_GROUP</td>
1.156 leot 11871: </tr>
11872: <tr>
1.180 ! rillig 11873: <td>IRCD_HYBRID_IRC_USER</td>
1.178 rillig 11874: <td>IRCD_HYBRID_MAXCONN</td>
1.156 leot 11875: </tr>
11876: <tr>
1.180 ! rillig 11877: <td>IRCD_HYBRID_NICLEN</td>
1.178 rillig 11878: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.156 leot 11879: </tr>
11880: <tr>
1.180 ! rillig 11881: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.178 rillig 11882: <td>IRCD_HYBRID_TOPICLEN</td>
1.156 leot 11883: </tr>
11884: <tr>
1.180 ! rillig 11885: <td>IRIX</td>
1.178 rillig 11886: <td>IRRD_USE_PGP</td>
1.156 leot 11887: </tr>
11888: <tr>
1.180 ! rillig 11889: <td>JABBERD_GROUP</td>
1.178 rillig 11890: <td>JABBERD_LOGDIR</td>
1.156 leot 11891: </tr>
11892: <tr>
1.180 ! rillig 11893: <td>JABBERD_PIDDIR</td>
1.178 rillig 11894: <td>JABBERD_SPOOLDIR</td>
1.156 leot 11895: </tr>
11896: <tr>
1.180 ! rillig 11897: <td>JABBERD_USER</td>
1.178 rillig 11898: <td>JAKARTA_HOME</td>
1.177 leot 11899: </tr>
11900: <tr>
1.180 ! rillig 11901: <td>JAVA_APP_PATH</td>
1.178 rillig 11902: <td>JAVA_APP_TARGETS</td>
1.161 leot 11903: </tr>
11904: <tr>
1.180 ! rillig 11905: <td>JAVA_BINPREFIX</td>
1.178 rillig 11906: <td>JAVA_CLASSPATH</td>
1.156 leot 11907: </tr>
11908: <tr>
1.180 ! rillig 11909: <td>JAVA_HOME</td>
1.178 rillig 11910: <td>JAVA_LD_LIBRARY_PATH</td>
1.156 leot 11911: </tr>
11912: <tr>
1.180 ! rillig 11913: <td>JAVA_NAME</td>
1.178 rillig 11914: <td>JAVA_UNLIMIT</td>
1.156 leot 11915: </tr>
11916: <tr>
1.180 ! rillig 11917: <td>JAVA_WRAPPERS</td>
1.178 rillig 11918: <td>JPEG_ACCEPTED</td>
1.156 leot 11919: </tr>
11920: <tr>
1.180 ! rillig 11921: <td>JPEG_DEFAULT</td>
1.178 rillig 11922: <td>KERBEROS</td>
1.156 leot 11923: </tr>
11924: <tr>
1.180 ! rillig 11925: <td>KERMIT_SUID_UUCP</td>
1.178 rillig 11926: <td>KJS_USE_PCRE</td>
1.156 leot 11927: </tr>
11928: <tr>
1.180 ! rillig 11929: <td>KNEWS_DOMAIN_FILE</td>
1.178 rillig 11930: <td>KNEWS_DOMAIN_NAME</td>
1.156 leot 11931: </tr>
11932: <tr>
1.180 ! rillig 11933: <td>KRB5_ACCEPTED</td>
1.178 rillig 11934: <td>KRB5_DEFAULT</td>
1.177 leot 11935: </tr>
11936: <tr>
1.180 ! rillig 11937: <td>LANGUAGES</td>
1.178 rillig 11938: <td>LAPACK_LIBS</td>
1.156 leot 11939: </tr>
11940: <tr>
1.180 ! rillig 11941: <td>LATEX2HTML_ICONPATH</td>
1.178 rillig 11942: <td>LDCONFIG_ADD_CMD</td>
1.156 leot 11943: </tr>
11944: <tr>
1.180 ! rillig 11945: <td>LDCONFIG_REMOVE_CMD</td>
1.178 rillig 11946: <td>LEAFNODE_DATA_DIR</td>
1.156 leot 11947: </tr>
11948: <tr>
1.180 ! rillig 11949: <td>LEAFNODE_GROUP</td>
1.178 rillig 11950: <td>LEAFNODE_USER</td>
1.156 leot 11951: </tr>
11952: <tr>
1.180 ! rillig 11953: <td>LIBDVDCSS_HOMEPAGE</td>
1.178 rillig 11954: <td>LIBDVDCSS_MASTER_SITES</td>
1.157 leot 11955: </tr>
11956: <tr>
1.180 ! rillig 11957: <td>LIBRSVG_TYPE</td>
1.178 rillig 11958: <td>LIBTOOL</td>
1.156 leot 11959: </tr>
11960: <tr>
1.180 ! rillig 11961: <td>LIBTOOLIZE_PLIST</td>
1.178 rillig 11962: <td>LIBTOOL_M4_OVERRIDE</td>
1.156 leot 11963: </tr>
11964: <tr>
1.180 ! rillig 11965: <td>LIBUSB_TYPE</td>
1.178 rillig 11966: <td>LICENSE</td>
1.177 leot 11967: </tr>
11968: <tr>
1.180 ! rillig 11969: <td>LINKER_RPATH_FLAG</td>
1.178 rillig 11970: <td>LINK_RPATH_FLAG</td>
1.156 leot 11971: </tr>
11972: <tr>
1.180 ! rillig 11973: <td>LINUX_BASE_NODEPS</td>
1.178 rillig 11974: <td>LINUX_BASE_PREFERRED</td>
1.161 leot 11975: </tr>
11976: <tr>
1.180 ! rillig 11977: <td>LINUX_BASE_REQUIRED</td>
1.178 rillig 11978: <td>LINUX_LOCALES</td>
1.156 leot 11979: </tr>
11980: <tr>
1.180 ! rillig 11981: <td>LOCALBASE</td>
1.178 rillig 11982: <td>LOCALBASE_LOCKTYPE</td>
1.156 leot 11983: </tr>
11984: <tr>
1.180 ! rillig 11985: <td>LOCALPATCHES</td>
1.178 rillig 11986: <td>LOVE_DATA</td>
1.156 leot 11987: </tr>
11988: <tr>
1.180 ! rillig 11989: <td>LOVE_GAME</td>
1.178 rillig 11990: <td>LOVE_VERSION</td>
1.156 leot 11991: </tr>
11992: <tr>
1.180 ! rillig 11993: <td>LP64PLATFORMS</td>
1.178 rillig 11994: <td>MACHINE_PLATFORM</td>
1.156 leot 11995: </tr>
11996: <tr>
1.180 ! rillig 11997: <td>MAILAGENT_DOMAIN</td>
1.178 rillig 11998: <td>MAILAGENT_EMAIL</td>
1.156 leot 11999: </tr>
12000: <tr>
1.180 ! rillig 12001: <td>MAILAGENT_FQDN</td>
1.178 rillig 12002: <td>MAILAGENT_ORGANIZATION</td>
1.159 rillig 12003: </tr>
12004: <tr>
1.180 ! rillig 12005: <td>MAJORDOMO_HOMEDIR</td>
1.178 rillig 12006: <td>MAJOR_OS_VERSION</td>
1.156 leot 12007: </tr>
12008: <tr>
1.180 ! rillig 12009: <td>MAKEINFO_ARGS</td>
1.178 rillig 12010: <td>MAKE_DIRS</td>
1.156 leot 12011: </tr>
12012: <tr>
1.180 ! rillig 12013: <td>MAKE_DIRS_PERMS</td>
1.178 rillig 12014: <td>MAKE_ENV</td>
1.156 leot 12015: </tr>
12016: <tr>
1.180 ! rillig 12017: <td>MAKE_FILE</td>
1.178 rillig 12018: <td>MAKE_FLAGS</td>
1.156 leot 12019: </tr>
12020: <tr>
1.180 ! rillig 12021: <td>MAKE_JOBS</td>
1.178 rillig 12022: <td>MAKE_JOBS_SAFE</td>
1.156 leot 12023: </tr>
12024: <tr>
1.180 ! rillig 12025: <td>MAKE_PROGRAM</td>
1.178 rillig 12026: <td>MANINSTALL</td>
1.156 leot 12027: </tr>
12028: <tr>
1.180 ! rillig 12029: <td>MANZ</td>
1.178 rillig 12030: <td>MASTER_SITES</td>
1.156 leot 12031: </tr>
12032: <tr>
1.180 ! rillig 12033: <td>MASTER_SITE_BACKUP</td>
1.178 rillig 12034: <td>MASTER_SITE_LOCAL</td>
1.156 leot 12035: </tr>
12036: <tr>
1.180 ! rillig 12037: <td>MASTER_SITE_MOZILLA</td>
1.178 rillig 12038: <td>MASTER_SITE_OVERRIDE</td>
1.156 leot 12039: </tr>
12040: <tr>
1.180 ! rillig 12041: <td>MASTER_SITE_PERL_CPAN</td>
1.178 rillig 12042: <td>MASTER_SORT</td>
1.156 leot 12043: </tr>
12044: <tr>
1.180 ! rillig 12045: <td>MASTER_SORT_RANDOM</td>
1.178 rillig 12046: <td>MASTER_SORT_REGEX</td>
1.156 leot 12047: </tr>
12048: <tr>
1.180 ! rillig 12049: <td>MECAB_CHARSET</td>
1.178 rillig 12050: <td>MEDIATOMB_GROUP</td>
1.156 leot 12051: </tr>
12052: <tr>
1.180 ! rillig 12053: <td>MEDIATOMB_USER</td>
1.178 rillig 12054: <td>MIPSPROBASE</td>
1.156 leot 12055: </tr>
12056: <tr>
1.180 ! rillig 12057: <td>MIREDO_GROUP</td>
1.178 rillig 12058: <td>MIREDO_USER</td>
1.156 leot 12059: </tr>
12060: <tr>
1.180 ! rillig 12061: <td>MISSING_FEATURES</td>
1.178 rillig 12062: <td>MKDIR</td>
1.156 leot 12063: </tr>
12064: <tr>
1.180 ! rillig 12065: <td>MLDONKEY_GROUP</td>
1.178 rillig 12066: <td>MLDONKEY_HOME</td>
1.156 leot 12067: </tr>
12068: <tr>
1.180 ! rillig 12069: <td>MLDONKEY_USER</td>
1.178 rillig 12070: <td>MONOTONE_GROUP</td>
1.156 leot 12071: </tr>
12072: <tr>
1.180 ! rillig 12073: <td>MONOTONE_USER</td>
1.178 rillig 12074: <td>MOTIFBASE</td>
1.156 leot 12075: </tr>
12076: <tr>
1.180 ! rillig 12077: <td>MOTIF_TYPE</td>
1.178 rillig 12078: <td>MOTIF_TYPE_DEFAULT</td>
1.156 leot 12079: </tr>
12080: <tr>
1.180 ! rillig 12081: <td>MPI_TYPE</td>
1.178 rillig 12082: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156 leot 12083: </tr>
12084: <tr>
1.180 ! rillig 12085: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.178 rillig 12086: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.156 leot 12087: </tr>
12088: <tr>
1.180 ! rillig 12089: <td>MUST</td>
1.178 rillig 12090: <td>MV</td>
1.156 leot 12091: </tr>
12092: <tr>
1.180 ! rillig 12093: <td>MYSQL_CHARSET</td>
1.178 rillig 12094: <td>MYSQL_DATADIR</td>
1.156 leot 12095: </tr>
12096: <tr>
1.180 ! rillig 12097: <td>MYSQL_EXTRA_CHARSET</td>
1.178 rillig 12098: <td>MYSQL_GROUP</td>
1.156 leot 12099: </tr>
12100: <tr>
1.180 ! rillig 12101: <td>MYSQL_PKGSRCDIR</td>
1.178 rillig 12102: <td>MYSQL_USER</td>
1.156 leot 12103: </tr>
12104: <tr>
1.180 ! rillig 12105: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.178 rillig 12106: <td>MYSQL_VERSION_DEFAULT</td>
1.156 leot 12107: </tr>
12108: <tr>
1.180 ! rillig 12109: <td>NAGIOSCMD_GROUP</td>
1.178 rillig 12110: <td>NAGIOSDIR</td>
1.156 leot 12111: </tr>
12112: <tr>
1.180 ! rillig 12113: <td>NAGIOS_GROUP</td>
1.178 rillig 12114: <td>NAGIOS_USER</td>
1.156 leot 12115: </tr>
12116: <tr>
1.180 ! rillig 12117: <td>NATIVE_APPEND_ABI</td>
1.178 rillig 12118: <td>NATIVE_APPEND_ELF</td>
1.156 leot 12119: </tr>
12120: <tr>
1.180 ! rillig 12121: <td>NATIVE_EXEC_FMT</td>
1.178 rillig 12122: <td>NATIVE_MACHINE_PLATFORM</td>
1.156 leot 12123: </tr>
12124: <tr>
1.180 ! rillig 12125: <td>NATIVE_OBJECT_FMT</td>
1.178 rillig 12126: <td>NBPAX_PROGRAM_PREFIX</td>
12127: </tr>
12128: <tr>
1.180 ! rillig 12129: <td>NETBSD_LOGIN_NAME</td>
1.172 rillig 12130: <td>NMH_EDITOR</td>
1.156 leot 12131: </tr>
12132: <tr>
1.180 ! rillig 12133: <td>NMH_MTA</td>
1.172 rillig 12134: <td>NMH_PAGER</td>
1.156 leot 12135: </tr>
12136: <tr>
1.180 ! rillig 12137: <td>NOLOGIN</td>
1.177 leot 12138: <td>NOTE</td>
1.156 leot 12139: </tr>
12140: <tr>
1.180 ! rillig 12141: <td>NOT_FOR_PLATFORM</td>
1.177 leot 12142: <td>NOT_PAX_ASLR_SAFE</td>
1.156 leot 12143: </tr>
12144: <tr>
1.180 ! rillig 12145: <td>NOT_PAX_MPROTECT_SAFE</td>
1.177 leot 12146: <td>NO_BUILD</td>
1.156 leot 12147: </tr>
12148: <tr>
1.180 ! rillig 12149: <td>NO_CHECKSUM</td>
1.177 leot 12150: <td>NO_CONFIGURE</td>
1.156 leot 12151: </tr>
12152: <tr>
1.180 ! rillig 12153: <td>NO_SKIP</td>
1.177 leot 12154: <td>NS_PREFERRED</td>
1.156 leot 12155: </tr>
12156: <tr>
1.180 ! rillig 12157: <td>NULLMAILER_GROUP</td>
1.177 leot 12158: <td>NULLMAILER_USER</td>
1.156 leot 12159: </tr>
12160: <tr>
1.180 ! rillig 12161: <td>OASIS</td>
1.177 leot 12162: <td>OASIS_BUILD_ARGS</td>
1.156 leot 12163: </tr>
12164: <tr>
1.180 ! rillig 12165: <td>OBJHOSTNAME</td>
1.177 leot 12166: <td>OBJMACHINE</td>
1.156 leot 12167: </tr>
12168: <tr>
1.180 ! rillig 12169: <td>OCAML_FINDLIB_DIRS</td>
1.177 leot 12170: <td>OCAML_FINDLIB_REGISTER</td>
1.156 leot 12171: </tr>
12172: <tr>
1.180 ! rillig 12173: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.177 leot 12174: <td>OCAML_SITELIBDIR</td>
1.156 leot 12175: </tr>
12176: <tr>
1.180 ! rillig 12177: <td>OCAML_TOPKG_DOCDIR</td>
1.177 leot 12178: <td>OCAML_USE_DUNE</td>
1.156 leot 12179: </tr>
12180: <tr>
1.180 ! rillig 12181: <td>OCAML_USE_FINDLIB</td>
1.177 leot 12182: <td>OCAML_USE_JBUILDER</td>
1.156 leot 12183: </tr>
12184: <tr>
1.180 ! rillig 12185: <td>OCAML_USE_OASIS</td>
1.177 leot 12186: <td>OCAML_USE_OASIS_DYNRUN</td>
1.156 leot 12187: </tr>
12188: <tr>
1.180 ! rillig 12189: <td>OCAML_USE_OPAM</td>
1.177 leot 12190: <td>OCAML_USE_OPT_COMPILER</td>
1.156 leot 12191: </tr>
12192: <tr>
1.180 ! rillig 12193: <td>OCAML_USE_TOPKG</td>
1.177 leot 12194: <td>OMF</td>
1.156 leot 12195: </tr>
12196: <tr>
1.180 ! rillig 12197: <td>ONLY_FOR_COMPILER</td>
1.177 leot 12198: <td>ONLY_FOR_PLATFORM</td>
1.156 leot 12199: </tr>
12200: <tr>
1.180 ! rillig 12201: <td>OPENSSH_CHROOT</td>
1.177 leot 12202: <td>OPENSSH_GROUP</td>
1.156 leot 12203: </tr>
12204: <tr>
1.180 ! rillig 12205: <td>OPENSSH_USER</td>
1.177 leot 12206: <td>OPSYS</td>
1.156 leot 12207: </tr>
12208: <tr>
1.180 ! rillig 12209: <td>OPSYS_EMULDIR</td>
1.177 leot 12210: <td>OSS_TYPE</td>
1.156 leot 12211: </tr>
12212: <tr>
1.180 ! rillig 12213: <td>OSX</td>
1.177 leot 12214: <td>OSX_TOLERATE_SDK_SKEW</td>
12215: </tr>
12216: <tr>
1.180 ! rillig 12217: <td>OS_HAVE_ALSA</td>
1.177 leot 12218: <td>OS_HAVE_RCD</td>
1.156 leot 12219: </tr>
12220: <tr>
1.180 ! rillig 12221: <td>OS_VARIANT</td>
1.177 leot 12222: <td>OS_VERSION</td>
1.159 rillig 12223: </tr>
12224: <tr>
1.180 ! rillig 12225: <td>OTF_FONTS_DIR</td>
1.177 leot 12226: <td>OVERRIDE_DIRDEPTH</td>
1.156 leot 12227: </tr>
12228: <tr>
1.180 ! rillig 12229: <td>OVERRIDE_GEMSPEC</td>
1.177 leot 12230: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.156 leot 12231: </tr>
12232: <tr>
1.180 ! rillig 12233: <td>OVERRIDE_ROCKSPEC</td>
1.175 gutterid 12234: <td>OWN_DIRS</td>
1.161 leot 12235: </tr>
12236: <tr>
1.180 ! rillig 12237: <td>OWN_DIRS_PERMS</td>
1.175 gutterid 12238: <td>P4GROUP</td>
1.156 leot 12239: </tr>
12240: <tr>
1.180 ! rillig 12241: <td>P4PORT</td>
1.175 gutterid 12242: <td>P4ROOT</td>
1.156 leot 12243: </tr>
12244: <tr>
1.180 ! rillig 12245: <td>P4USER</td>
1.175 gutterid 12246: <td>PACKAGES</td>
1.156 leot 12247: </tr>
12248: <tr>
1.180 ! rillig 12249: <td>PALMOS_DEFAULT_SDK</td>
1.175 gutterid 12250: <td>PAMBASE</td>
1.156 leot 12251: </tr>
12252: <tr>
1.180 ! rillig 12253: <td>PAM_DEFAULT</td>
1.175 gutterid 12254: <td>PAPERSIZE</td>
1.156 leot 12255: </tr>
12256: <tr>
1.180 ! rillig 12257: <td>PASSIVE_FETCH</td>
1.175 gutterid 12258: <td>PATCHDIR</td>
1.156 leot 12259: </tr>
12260: <tr>
1.180 ! rillig 12261: <td>PATCHFILES</td>
1.175 gutterid 12262: <td>PATCH_ARGS</td>
1.156 leot 12263: </tr>
12264: <tr>
1.180 ! rillig 12265: <td>PATCH_DEBUG</td>
1.175 gutterid 12266: <td>PATCH_DIST_ARGS</td>
1.169 rillig 12267: </tr>
12268: <tr>
1.180 ! rillig 12269: <td>PATCH_DIST_CAT</td>
1.175 gutterid 12270: <td>PATCH_DIST_STRIP</td>
1.156 leot 12271: </tr>
12272: <tr>
1.180 ! rillig 12273: <td>PATCH_FUZZ_FACTOR</td>
1.175 gutterid 12274: <td>PATCH_STRIP</td>
1.156 leot 12275: </tr>
12276: <tr>
1.180 ! rillig 12277: <td>PATH</td>
1.169 rillig 12278: <td>PCCBASE</td>
1.156 leot 12279: </tr>
12280: <tr>
1.180 ! rillig 12281: <td>PEAR</td>
1.177 leot 12282: <td>PEAR_CHANNEL</td>
12283: </tr>
12284: <tr>
1.180 ! rillig 12285: <td>PEAR_CHANNEL_ALIAS</td>
1.177 leot 12286: <td>PEAR_CHANNEL_VERSION</td>
12287: </tr>
12288: <tr>
1.180 ! rillig 12289: <td>PEAR_CMD</td>
1.175 gutterid 12290: <td>PEAR_LIB</td>
1.161 leot 12291: </tr>
12292: <tr>
1.180 ! rillig 12293: <td>PEAR_PACKAGE_XML</td>
1.175 gutterid 12294: <td>PERL5</td>
1.161 leot 12295: </tr>
12296: <tr>
1.180 ! rillig 12297: <td>PERL5_CONFIGURE</td>
1.175 gutterid 12298: <td>PERL5_CONFIGURE_DIRS</td>
1.156 leot 12299: </tr>
12300: <tr>
1.180 ! rillig 12301: <td>PERL5_LDFLAGS</td>
1.175 gutterid 12302: <td>PERL5_LICENSE</td>
1.156 leot 12303: </tr>
12304: <tr>
1.180 ! rillig 12305: <td>PERL5_MODULE_TYPE</td>
1.175 gutterid 12306: <td>PERL5_PACKLIST</td>
1.156 leot 12307: </tr>
12308: <tr>
1.180 ! rillig 12309: <td>PERL5_PACKLIST_DIR</td>
1.175 gutterid 12310: <td>PERL5_PERLBASE</td>
1.156 leot 12311: </tr>
12312: <tr>
1.180 ! rillig 12313: <td>PERL5_SITEBASE</td>
1.175 gutterid 12314: <td>PERL5_USE_PACKLIST</td>
1.156 leot 12315: </tr>
12316: <tr>
1.180 ! rillig 12317: <td>PERL5_VENDORBASE</td>
1.175 gutterid 12318: <td>PFCTL</td>
1.156 leot 12319: </tr>
12320: <tr>
1.180 ! rillig 12321: <td>PFVAR_H</td>
1.175 gutterid 12322: <td>PF_VERSION</td>
1.156 leot 12323: </tr>
12324: <tr>
1.180 ! rillig 12325: <td>PGGROUP</td>
1.175 gutterid 12326: <td>PGHOME</td>
1.156 leot 12327: </tr>
12328: <tr>
1.180 ! rillig 12329: <td>PGPKGSRCDIR</td>
1.175 gutterid 12330: <td>PGSQL_TYPE</td>
1.156 leot 12331: </tr>
12332: <tr>
1.180 ! rillig 12333: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.175 gutterid 12334: <td>PGSQL_VERSION_DEFAULT</td>
1.156 leot 12335: </tr>
12336: <tr>
1.180 ! rillig 12337: <td>PGUSER</td>
1.175 gutterid 12338: <td>PG_LIB_EXT</td>
1.156 leot 12339: </tr>
12340: <tr>
1.180 ! rillig 12341: <td>PHP</td>
1.175 gutterid 12342: <td>PHPCOMMON_MK</td>
1.156 leot 12343: </tr>
12344: <tr>
1.180 ! rillig 12345: <td>PHPPKGSRCDIR</td>
1.175 gutterid 12346: <td>PHP_BASE_VERS</td>
1.156 leot 12347: </tr>
12348: <tr>
1.180 ! rillig 12349: <td>PHP_CHECK_INSTALLED</td>
1.175 gutterid 12350: <td>PHP_EXTENSION_DIR</td>
1.156 leot 12351: </tr>
12352: <tr>
1.180 ! rillig 12353: <td>PHP_INITIAL_TEENY</td>
1.175 gutterid 12354: <td>PHP_PKG_PREFIX</td>
1.156 leot 12355: </tr>
12356: <tr>
1.180 ! rillig 12357: <td>PHP_VERSION</td>
1.175 gutterid 12358: <td>PHP_VERSIONS_ACCEPTED</td>
1.156 leot 12359: </tr>
12360: <tr>
1.180 ! rillig 12361: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.175 gutterid 12362: <td>PHP_VERSION_DEFAULT</td>
1.156 leot 12363: </tr>
12364: <tr>
1.180 ! rillig 12365: <td>PHP_VERSION_REQD</td>
1.175 gutterid 12366: <td>PILRC_USE_GTK</td>
1.156 leot 12367: </tr>
12368: <tr>
1.180 ! rillig 12369: <td>PKGCONFIG_BASE</td>
1.175 gutterid 12370: <td>PKGCONFIG_FILE</td>
1.156 leot 12371: </tr>
12372: <tr>
1.180 ! rillig 12373: <td>PKGCONFIG_OVERRIDE</td>
1.175 gutterid 12374: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.156 leot 12375: </tr>
12376: <tr>
1.180 ! rillig 12377: <td>PKGDIR</td>
1.175 gutterid 12378: <td>PKGGNUDIR</td>
1.156 leot 12379: </tr>
12380: <tr>
1.180 ! rillig 12381: <td>PKGINFODIR</td>
1.175 gutterid 12382: <td>PKGLOCALEDIR</td>
1.156 leot 12383: </tr>
12384: <tr>
1.180 ! rillig 12385: <td>PKGMANDIR</td>
1.175 gutterid 12386: <td>PKGNAME</td>
1.156 leot 12387: </tr>
12388: <tr>
1.180 ! rillig 12389: <td>PKGNAME_REQD</td>
1.175 gutterid 12390: <td>PKGPATH</td>
1.156 leot 12391: </tr>
12392: <tr>
1.180 ! rillig 12393: <td>PKGREVISION</td>
1.177 leot 12394: <td>PKGSRC_BLAS_TYPES</td>
12395: </tr>
12396: <tr>
1.180 ! rillig 12397: <td>PKGSRC_CHANGES</td>
1.177 leot 12398: <td>PKGSRC_COMPILER</td>
1.156 leot 12399: </tr>
12400: <tr>
1.180 ! rillig 12401: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.177 leot 12402: <td>PKGSRC_LOCKTYPE</td>
1.159 rillig 12403: </tr>
12404: <tr>
1.180 ! rillig 12405: <td>PKGSRC_MAKE_ENV</td>
1.177 leot 12406: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.156 leot 12407: </tr>
12408: <tr>
1.180 ! rillig 12409: <td>PKGSRC_MKPIE</td>
1.177 leot 12410: <td>PKGSRC_MKREPRO</td>
1.156 leot 12411: </tr>
12412: <tr>
1.180 ! rillig 12413: <td>PKGSRC_RUN_TEST</td>
1.177 leot 12414: <td>PKGSRC_SETENV</td>
1.156 leot 12415: </tr>
12416: <tr>
1.180 ! rillig 12417: <td>PKGSRC_SLEEPSECS</td>
1.177 leot 12418: <td>PKGSRC_TODO</td>
1.156 leot 12419: </tr>
12420: <tr>
1.180 ! rillig 12421: <td>PKGSRC_USE_CTF</td>
1.177 leot 12422: <td>PKGSRC_USE_FORTIFY</td>
1.156 leot 12423: </tr>
12424: <tr>
1.180 ! rillig 12425: <td>PKGSRC_USE_RELRO</td>
1.177 leot 12426: <td>PKGSRC_USE_SSP</td>
1.156 leot 12427: </tr>
12428: <tr>
1.180 ! rillig 12429: <td>PKGSRC_USE_STACK_CHECK</td>
1.177 leot 12430: <td>PKGTASKS_DATAFILE</td>
1.156 leot 12431: </tr>
12432: <tr>
1.180 ! rillig 12433: <td>PKGTOOLS_ARGS</td>
1.177 leot 12434: <td>PKGTOOLS_ENV</td>
1.156 leot 12435: </tr>
12436: <tr>
1.180 ! rillig 12437: <td>PKG_ALTERNATIVES</td>
1.177 leot 12438: <td>PKG_APACHE</td>
1.156 leot 12439: </tr>
12440: <tr>
1.180 ! rillig 12441: <td>PKG_APACHE_ACCEPTED</td>
1.177 leot 12442: <td>PKG_APACHE_DEFAULT</td>
1.156 leot 12443: </tr>
12444: <tr>
1.180 ! rillig 12445: <td>PKG_BEST_EXISTS</td>
1.177 leot 12446: <td>PKG_BUILD_OPTIONS</td>
1.156 leot 12447: </tr>
12448: <tr>
1.180 ! rillig 12449: <td>PKG_COMPRESSION</td>
1.177 leot 12450: <td>PKG_CONFIG</td>
1.156 leot 12451: </tr>
12452: <tr>
1.180 ! rillig 12453: <td>PKG_CONFIG_PERMS</td>
1.177 leot 12454: <td>PKG_CREATE_USERGROUP</td>
1.156 leot 12455: </tr>
12456: <tr>
1.180 ! rillig 12457: <td>PKG_DB_TMPDIR</td>
1.177 leot 12458: <td>PKG_DEBUG_LEVEL</td>
1.156 leot 12459: </tr>
12460: <tr>
1.180 ! rillig 12461: <td>PKG_DEFAULT_OPTIONS</td>
1.177 leot 12462: <td>PKG_DESTDIR_SUPPORT</td>
1.156 leot 12463: </tr>
12464: <tr>
1.180 ! rillig 12465: <td>PKG_DEVELOPER</td>
1.177 leot 12466: <td>PKG_DISABLED_OPTIONS</td>
1.156 leot 12467: </tr>
12468: <tr>
1.180 ! rillig 12469: <td>PKG_FATAL_ERRORS</td>
1.177 leot 12470: <td>PKG_FC</td>
1.156 leot 12471: </tr>
12472: <tr>
1.180 ! rillig 12473: <td>PKG_FILELIST_CMD</td>
1.177 leot 12474: <td>PKG_GECOS</td>
1.156 leot 12475: </tr>
12476: <tr>
1.180 ! rillig 12477: <td>PKG_GID</td>
1.177 leot 12478: <td>PKG_GROUPS</td>
1.156 leot 12479: </tr>
12480: <tr>
1.180 ! rillig 12481: <td>PKG_GROUPS_VARS</td>
1.177 leot 12482: <td>PKG_HOME</td>
1.156 leot 12483: </tr>
12484: <tr>
1.180 ! rillig 12485: <td>PKG_INIT_SCRIPTS</td>
1.177 leot 12486: <td>PKG_JAVA_HOME</td>
1.156 leot 12487: </tr>
12488: <tr>
1.180 ! rillig 12489: <td>PKG_JVM</td>
1.177 leot 12490: <td>PKG_JVMS_ACCEPTED</td>
1.156 leot 12491: </tr>
12492: <tr>
1.180 ! rillig 12493: <td>PKG_JVM_DEFAULT</td>
1.177 leot 12494: <td>PKG_LEGACY_OPTIONS</td>
1.156 leot 12495: </tr>
12496: <tr>
1.180 ! rillig 12497: <td>PKG_LIBTOOL</td>
1.177 leot 12498: <td>PKG_OPTIONS</td>
1.156 leot 12499: </tr>
12500: <tr>
1.180 ! rillig 12501: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.177 leot 12502: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.156 leot 12503: </tr>
12504: <tr>
1.180 ! rillig 12505: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.177 leot 12506: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.156 leot 12507: </tr>
12508: <tr>
1.180 ! rillig 12509: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.177 leot 12510: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.156 leot 12511: </tr>
12512: <tr>
1.180 ! rillig 12513: <td>PKG_OPTIONS_VAR</td>
1.177 leot 12514: <td>PKG_PHP</td>
1.156 leot 12515: </tr>
12516: <tr>
1.180 ! rillig 12517: <td>PKG_PHP_MAJOR_VERS</td>
1.177 leot 12518: <td>PKG_PHP_VERSION</td>
1.156 leot 12519: </tr>
12520: <tr>
1.180 ! rillig 12521: <td>PKG_RCD_SCRIPTS</td>
1.177 leot 12522: <td>PKG_REFCOUNT_DBDIR</td>
1.156 leot 12523: </tr>
12524: <tr>
1.180 ! rillig 12525: <td>PKG_REGISTER_SHELLS</td>
1.177 leot 12526: <td>PKG_RESUME_TRANSFERS</td>
1.156 leot 12527: </tr>
12528: <tr>
1.180 ! rillig 12529: <td>PKG_SHELL</td>
1.177 leot 12530: <td>PKG_SUGGESTED_OPTIONS</td>
1.156 leot 12531: </tr>
12532: <tr>
1.180 ! rillig 12533: <td>PKG_SUPPORTED_OPTIONS</td>
1.177 leot 12534: <td>PKG_SYSCONFBASE</td>
1.156 leot 12535: </tr>
12536: <tr>
1.180 ! rillig 12537: <td>PKG_SYSCONFBASEDIR</td>
1.177 leot 12538: <td>PKG_SYSCONFDIR</td>
1.156 leot 12539: </tr>
12540: <tr>
1.180 ! rillig 12541: <td>PKG_SYSCONFDIR_PERMS</td>
1.177 leot 12542: <td>PKG_SYSCONFSUBDIR</td>
1.156 leot 12543: </tr>
12544: <tr>
1.180 ! rillig 12545: <td>PKG_SYSCONFVAR</td>
1.177 leot 12546: <td>PKG_TOOLS_BIN</td>
1.156 leot 12547: </tr>
12548: <tr>
1.180 ! rillig 12549: <td>PKG_UID</td>
1.177 leot 12550: <td>PKG_UPDATE_FONTS_DB</td>
1.156 leot 12551: </tr>
12552: <tr>
1.180 ! rillig 12553: <td>PKG_USERS</td>
1.177 leot 12554: <td>PKG_USERS_VARS</td>
1.156 leot 12555: </tr>
12556: <tr>
1.180 ! rillig 12557: <td>PKG_VERBOSE</td>
1.177 leot 12558: <td>PLIST</td>
1.156 leot 12559: </tr>
12560: <tr>
1.180 ! rillig 12561: <td>PLIST_AWK</td>
1.177 leot 12562: <td>PLIST_AWK_ENV</td>
1.156 leot 12563: </tr>
12564: <tr>
1.180 ! rillig 12565: <td>PLIST_SRC</td>
1.177 leot 12566: <td>PLIST_SUBST</td>
1.156 leot 12567: </tr>
12568: <tr>
1.180 ! rillig 12569: <td>PLIST_TYPE</td>
1.177 leot 12570: <td>PLIST_VARS</td>
1.156 leot 12571: </tr>
12572: <tr>
1.180 ! rillig 12573: <td>POPTOP_USE_MPPE</td>
1.177 leot 12574: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.156 leot 12575: </tr>
12576: <tr>
1.180 ! rillig 12577: <td>POST_FETCH_HOOK</td>
1.177 leot 12578: <td>PREFER</td>
1.156 leot 12579: </tr>
12580: <tr>
1.180 ! rillig 12581: <td>PREFER_NATIVE</td>
1.177 leot 12582: <td>PREFER_NATIVE_PTHREADS</td>
1.156 leot 12583: </tr>
12584: <tr>
1.180 ! rillig 12585: <td>PREFER_PKGSRC</td>
1.177 leot 12586: <td>PREFIX</td>
1.156 leot 12587: </tr>
12588: <tr>
1.180 ! rillig 12589: <td>PREPEND_PATH</td>
1.177 leot 12590: <td>PRE_ROOT_CMD</td>
1.156 leot 12591: </tr>
12592: <tr>
1.180 ! rillig 12593: <td>PRIVILEGED_STAGES</td>
1.177 leot 12594: <td>PS</td>
1.156 leot 12595: </tr>
12596: <tr>
1.180 ! rillig 12597: <td>PTHREAD_AUTO_VARS</td>
1.177 leot 12598: <td>PTHREAD_CFLAGS</td>
1.156 leot 12599: </tr>
12600: <tr>
1.180 ! rillig 12601: <td>PTHREAD_LDFLAGS</td>
1.177 leot 12602: <td>PTHREAD_LIBS</td>
1.156 leot 12603: </tr>
12604: <tr>
1.180 ! rillig 12605: <td>PTHREAD_OPTS</td>
1.177 leot 12606: <td>PTHREAD_TYPE</td>
1.156 leot 12607: </tr>
12608: <tr>
1.180 ! rillig 12609: <td>PVM_SSH</td>
1.177 leot 12610: <td>PYPKGPREFIX</td>
1.156 leot 12611: </tr>
12612: <tr>
1.180 ! rillig 12613: <td>PYTHON_FOR_BUILD_ONLY</td>
1.177 leot 12614: <td>PYTHON_SELF_CONFLICT</td>
1.156 leot 12615: </tr>
12616: <tr>
1.180 ! rillig 12617: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.177 leot 12618: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156 leot 12619: </tr>
12620: <tr>
1.180 ! rillig 12621: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.177 leot 12622: <td>PYTHON_VERSION_DEFAULT</td>
1.156 leot 12623: </tr>
12624: <tr>
1.180 ! rillig 12625: <td>PYTHON_VERSION_REQD</td>
1.177 leot 12626: <td>PYVERSSUFFIX</td>
1.156 leot 12627: </tr>
12628: <tr>
1.180 ! rillig 12629: <td>PY_NO_EGG</td>
1.177 leot 12630: <td>QMAILDIR</td>
1.156 leot 12631: </tr>
12632: <tr>
1.180 ! rillig 12633: <td>QMAIL_ALIAS_USER</td>
1.177 leot 12634: <td>QMAIL_DAEMON_USER</td>
1.156 leot 12635: </tr>
12636: <tr>
1.180 ! rillig 12637: <td>QMAIL_LOG_USER</td>
1.177 leot 12638: <td>QMAIL_NOFILES_GROUP</td>
1.156 leot 12639: </tr>
12640: <tr>
1.180 ! rillig 12641: <td>QMAIL_PASSWD_USER</td>
1.177 leot 12642: <td>QMAIL_QMAIL_GROUP</td>
1.156 leot 12643: </tr>
12644: <tr>
1.180 ! rillig 12645: <td>QMAIL_QUEUE_DIR</td>
1.177 leot 12646: <td>QMAIL_QUEUE_EXTRA</td>
1.156 leot 12647: </tr>
12648: <tr>
1.180 ! rillig 12649: <td>QMAIL_QUEUE_USER</td>
1.177 leot 12650: <td>QMAIL_REMOTE_USER</td>
1.156 leot 12651: </tr>
12652: <tr>
1.180 ! rillig 12653: <td>QMAIL_ROOT_USER</td>
1.177 leot 12654: <td>QMAIL_SEND_USER</td>
1.156 leot 12655: </tr>
12656: <tr>
1.180 ! rillig 12657: <td>QPOPPER_FAC</td>
1.177 leot 12658: <td>QPOPPER_SPOOL_DIR</td>
1.156 leot 12659: </tr>
12660: <tr>
1.180 ! rillig 12661: <td>QPOPPER_USER</td>
1.177 leot 12662: <td>RAKE_NAME</td>
1.156 leot 12663: </tr>
12664: <tr>
1.180 ! rillig 12665: <td>RASMOL_DEPTH</td>
1.177 leot 12666: <td>RCD_DIR</td>
1.156 leot 12667: </tr>
12668: <tr>
1.180 ! rillig 12669: <td>RCD_ORDER</td>
1.174 leot 12670: <td>RCD_SCRIPTS</td>
1.177 leot 12671: </tr>
12672: <tr>
1.180 ! rillig 12673: <td>RCD_SCRIPTS_DIR</td>
1.177 leot 12674: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.159 rillig 12675: </tr>
12676: <tr>
1.180 ! rillig 12677: <td>RCD_SCRIPTS_MODE</td>
1.177 leot 12678: <td>RCD_SCRIPTS_SHELL</td>
1.156 leot 12679: </tr>
12680: <tr>
1.180 ! rillig 12681: <td>RCD_SCRIPT_SRC</td>
1.177 leot 12682: <td>RCD_SUBR</td>
1.156 leot 12683: </tr>
12684: <tr>
1.180 ! rillig 12685: <td>RDOC</td>
1.175 gutterid 12686: <td>READLINE_DEFAULT</td>
1.161 leot 12687: </tr>
12688: <tr>
1.180 ! rillig 12689: <td>READLINE_TYPE</td>
1.175 gutterid 12690: <td>REAL_ROOT_GROUP</td>
1.156 leot 12691: </tr>
12692: <tr>
1.180 ! rillig 12693: <td>REAL_ROOT_USER</td>
1.175 gutterid 12694: <td>RECURSIVE_MAKE</td>
1.156 leot 12695: </tr>
12696: <tr>
1.180 ! rillig 12697: <td>RELAY_CTRL_DIR</td>
1.175 gutterid 12698: <td>REPLACE_AWK</td>
1.156 leot 12699: </tr>
12700: <tr>
1.180 ! rillig 12701: <td>REPLACE_BASH</td>
1.175 gutterid 12702: <td>REPLACE_CSH</td>
1.156 leot 12703: </tr>
12704: <tr>
1.180 ! rillig 12705: <td>REPLACE_KSH</td>
1.175 gutterid 12706: <td>REPLACE_PERL</td>
1.156 leot 12707: </tr>
12708: <tr>
1.180 ! rillig 12709: <td>REPLACE_PERL6</td>
1.175 gutterid 12710: <td>REPLACE_PHP</td>
1.156 leot 12711: </tr>
12712: <tr>
1.180 ! rillig 12713: <td>REPLACE_PYTHON</td>
1.175 gutterid 12714: <td>REPLACE_RUBY</td>
1.166 leot 12715: </tr>
12716: <tr>
1.180 ! rillig 12717: <td>REPLACE_RUBY_DIRS</td>
1.175 gutterid 12718: <td>REPLACE_RUBY_PAT</td>
1.156 leot 12719: </tr>
12720: <tr>
1.180 ! rillig 12721: <td>REPLACE_SH</td>
1.175 gutterid 12722: <td>REPLACE_TEXLUA</td>
1.156 leot 12723: </tr>
12724: <tr>
1.180 ! rillig 12725: <td>REQD_DIRS</td>
1.175 gutterid 12726: <td>REQD_DIRS_PERMS</td>
1.156 leot 12727: </tr>
12728: <tr>
1.180 ! rillig 12729: <td>REQD_FILES</td>
1.175 gutterid 12730: <td>REQD_FILES_MODE</td>
1.156 leot 12731: </tr>
12732: <tr>
1.180 ! rillig 12733: <td>REQD_FILES_PERMS</td>
1.175 gutterid 12734: <td>RESOLV_AUTO_VARS</td>
1.156 leot 12735: </tr>
12736: <tr>
1.180 ! rillig 12737: <td>RESOLV_LDFLAGS</td>
1.175 gutterid 12738: <td>RESOLV_LIBS</td>
1.156 leot 12739: </tr>
12740: <tr>
1.180 ! rillig 12741: <td>RM</td>
1.177 leot 12742: <td>ROCKSPEC_NAME</td>
12743: </tr>
12744: <tr>
1.180 ! rillig 12745: <td>ROCKSPEC_SPECFILE</td>
1.175 gutterid 12746: <td>ROOT_CMD</td>
1.156 leot 12747: </tr>
12748: <tr>
1.180 ! rillig 12749: <td>ROOT_GROUP</td>
1.175 gutterid 12750: <td>ROOT_USER</td>
1.156 leot 12751: </tr>
12752: <tr>
1.180 ! rillig 12753: <td>RPCGEN</td>
1.175 gutterid 12754: <td>RPM</td>
1.156 leot 12755: </tr>
12756: <tr>
1.180 ! rillig 12757: <td>RPM2PKG_PLIST</td>
1.175 gutterid 12758: <td>RPM2PKG_PREFIX</td>
1.156 leot 12759: </tr>
12760: <tr>
1.180 ! rillig 12761: <td>RPM2PKG_STAGE</td>
1.175 gutterid 12762: <td>RPM2PKG_STRIP</td>
1.156 leot 12763: </tr>
12764: <tr>
1.180 ! rillig 12765: <td>RPM2PKG_SUBPREFIX</td>
1.175 gutterid 12766: <td>RPMFILES</td>
1.156 leot 12767: </tr>
12768: <tr>
1.180 ! rillig 12769: <td>RPMIGNOREPATH</td>
1.175 gutterid 12770: <td>RPM_DB_PREFIX</td>
1.156 leot 12771: </tr>
12772: <tr>
1.180 ! rillig 12773: <td>RSSH_CVS_PATH</td>
1.175 gutterid 12774: <td>RSSH_RDIST_PATH</td>
1.156 leot 12775: </tr>
12776: <tr>
1.180 ! rillig 12777: <td>RSSH_RSYNC_PATH</td>
1.175 gutterid 12778: <td>RSSH_SCP_PATH</td>
1.156 leot 12779: </tr>
12780: <tr>
1.180 ! rillig 12781: <td>RSSH_SFTP_SERVER_PATH</td>
1.175 gutterid 12782: <td>RUBY</td>
1.156 leot 12783: </tr>
12784: <tr>
1.180 ! rillig 12785: <td>RUBYGEM</td>
1.175 gutterid 12786: <td>RUBYGEM_NAME</td>
1.156 leot 12787: </tr>
12788: <tr>
1.180 ! rillig 12789: <td>RUBYGEM_OPTIONS</td>
1.175 gutterid 12790: <td>RUBY_ABI_VERSION</td>
1.156 leot 12791: </tr>
12792: <tr>
1.180 ! rillig 12793: <td>RUBY_ARCH</td>
1.175 gutterid 12794: <td>RUBY_ARCHINC</td>
1.156 leot 12795: </tr>
12796: <tr>
1.180 ! rillig 12797: <td>RUBY_ARCHLIB</td>
1.175 gutterid 12798: <td>RUBY_BASE</td>
1.156 leot 12799: </tr>
12800: <tr>
1.180 ! rillig 12801: <td>RUBY_BASERIDIR</td>
1.175 gutterid 12802: <td>RUBY_BUILD_DOCUMENT</td>
1.156 leot 12803: </tr>
12804: <tr>
1.180 ! rillig 12805: <td>RUBY_DLEXT</td>
1.175 gutterid 12806: <td>RUBY_DOC</td>
1.156 leot 12807: </tr>
12808: <tr>
1.180 ! rillig 12809: <td>RUBY_DYNAMIC_DIRS</td>
1.175 gutterid 12810: <td>RUBY_EG</td>
1.156 leot 12811: </tr>
12812: <tr>
1.180 ! rillig 12813: <td>RUBY_ENCODING_ARG</td>
1.175 gutterid 12814: <td>RUBY_EXTCONF</td>
1.156 leot 12815: </tr>
12816: <tr>
1.180 ! rillig 12817: <td>RUBY_EXTCONF_CHECK</td>
1.175 gutterid 12818: <td>RUBY_EXTCONF_DEBUG</td>
1.156 leot 12819: </tr>
12820: <tr>
1.180 ! rillig 12821: <td>RUBY_EXTCONF_MAKEFILE</td>
1.175 gutterid 12822: <td>RUBY_GEM_BASE</td>
1.156 leot 12823: </tr>
12824: <tr>
1.180 ! rillig 12825: <td>RUBY_INC</td>
1.175 gutterid 12826: <td>RUBY_LIB</td>
1.156 leot 12827: </tr>
12828: <tr>
1.180 ! rillig 12829: <td>RUBY_LIB_BASE</td>
1.175 gutterid 12830: <td>RUBY_NAME</td>
1.156 leot 12831: </tr>
12832: <tr>
1.180 ! rillig 12833: <td>RUBY_NOVERSION</td>
1.175 gutterid 12834: <td>RUBY_PKGPREFIX</td>
1.156 leot 12835: </tr>
12836: <tr>
1.180 ! rillig 12837: <td>RUBY_RAILS</td>
1.175 gutterid 12838: <td>RUBY_RAILS51_VERSION</td>
1.156 leot 12839: </tr>
12840: <tr>
1.180 ! rillig 12841: <td>RUBY_RAILS52_VERSION</td>
1.175 gutterid 12842: <td>RUBY_RAILS60_VERSION</td>
1.156 leot 12843: </tr>
12844: <tr>
1.180 ! rillig 12845: <td>RUBY_RAILS_ACCEPTED</td>
1.175 gutterid 12846: <td>RUBY_RAILS_DEFAULT</td>
1.174 leot 12847: </tr>
12848: <tr>
1.180 ! rillig 12849: <td>RUBY_RAILS_REQD</td>
1.175 gutterid 12850: <td>RUBY_RAILS_STRICT_DEP</td>
1.156 leot 12851: </tr>
12852: <tr>
1.180 ! rillig 12853: <td>RUBY_RIDIR</td>
1.175 gutterid 12854: <td>RUBY_SETUP</td>
1.156 leot 12855: </tr>
12856: <tr>
1.180 ! rillig 12857: <td>RUBY_SHLIB</td>
1.175 gutterid 12858: <td>RUBY_SHLIBALIAS</td>
1.156 leot 12859: </tr>
12860: <tr>
1.180 ! rillig 12861: <td>RUBY_SHLIBVER</td>
1.175 gutterid 12862: <td>RUBY_SIMPLE_INSTALL</td>
1.156 leot 12863: </tr>
12864: <tr>
1.180 ! rillig 12865: <td>RUBY_SITEARCHLIB</td>
1.175 gutterid 12866: <td>RUBY_SITELIB</td>
1.156 leot 12867: </tr>
12868: <tr>
1.180 ! rillig 12869: <td>RUBY_SITELIB_BASE</td>
1.175 gutterid 12870: <td>RUBY_SITERIDIR</td>
1.156 leot 12871: </tr>
12872: <tr>
1.180 ! rillig 12873: <td>RUBY_SLEXT</td>
1.175 gutterid 12874: <td>RUBY_SRCDIR</td>
1.156 leot 12875: </tr>
12876: <tr>
1.180 ! rillig 12877: <td>RUBY_STATICLIB</td>
1.175 gutterid 12878: <td>RUBY_SUFFIX</td>
1.156 leot 12879: </tr>
12880: <tr>
1.180 ! rillig 12881: <td>RUBY_SYSRIDIR</td>
1.175 gutterid 12882: <td>RUBY_USE_PTHREAD</td>
1.156 leot 12883: </tr>
12884: <tr>
1.180 ! rillig 12885: <td>RUBY_VENDORARCHLIB</td>
1.175 gutterid 12886: <td>RUBY_VENDORLIB</td>
1.156 leot 12887: </tr>
12888: <tr>
1.180 ! rillig 12889: <td>RUBY_VENDORLIB_BASE</td>
1.175 gutterid 12890: <td>RUBY_VER</td>
1.156 leot 12891: </tr>
12892: <tr>
1.180 ! rillig 12893: <td>RUBY_VERSION</td>
1.175 gutterid 12894: <td>RUBY_VERSIONS_ACCEPTED</td>
1.156 leot 12895: </tr>
12896: <tr>
1.180 ! rillig 12897: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.175 gutterid 12898: <td>RUBY_VERSION_DEFAULT</td>
1.156 leot 12899: </tr>
12900: <tr>
1.180 ! rillig 12901: <td>RUBY_VERSION_REQD</td>
1.175 gutterid 12902: <td>RUBY_VER_DIR</td>
1.156 leot 12903: </tr>
12904: <tr>
1.180 ! rillig 12905: <td>RUN</td>
1.175 gutterid 12906: <td>RUN_LDCONFIG</td>
1.156 leot 12907: </tr>
12908: <tr>
1.180 ! rillig 12909: <td>SAWFISH_THEMES</td>
1.175 gutterid 12910: <td>SCO</td>
1.156 leot 12911: </tr>
12912: <tr>
1.180 ! rillig 12913: <td>SCREWS_GROUP</td>
1.175 gutterid 12914: <td>SCREWS_USER</td>
1.156 leot 12915: </tr>
12916: <tr>
1.180 ! rillig 12917: <td>SCRIPTS_ENV</td>
1.175 gutterid 12918: <td>SCROLLKEEPER_DATADIR</td>
1.156 leot 12919: </tr>
12920: <tr>
1.180 ! rillig 12921: <td>SCROLLKEEPER_REBUILDDB</td>
1.175 gutterid 12922: <td>SCROLLKEEPER_UPDATEDB</td>
1.156 leot 12923: </tr>
12924: <tr>
1.180 ! rillig 12925: <td>SDIST_PAWD</td>
1.175 gutterid 12926: <td>SERIAL_DEVICES</td>
1.156 leot 12927: </tr>
12928: <tr>
1.180 ! rillig 12929: <td>SETGIDGAME</td>
1.175 gutterid 12930: <td>SETGID_GAMES_PERMS</td>
1.156 leot 12931: </tr>
12932: <tr>
1.180 ! rillig 12933: <td>SETUID_ROOT_PERMS</td>
1.175 gutterid 12934: <td>SH</td>
1.156 leot 12935: </tr>
12936: <tr>
1.180 ! rillig 12937: <td>SHLIB</td>
1.177 leot 12938: <td>SHORTNAME</td>
12939: </tr>
12940: <tr>
1.180 ! rillig 12941: <td>SIGN_PACKAGES</td>
1.177 leot 12942: <td>SILC_CLIENT_WITH_PERL</td>
1.156 leot 12943: </tr>
12944: <tr>
1.180 ! rillig 12945: <td>SITE_SPECIFIC_PKGS</td>
1.177 leot 12946: <td>SKIP_DEPENDS</td>
1.156 leot 12947: </tr>
12948: <tr>
1.180 ! rillig 12949: <td>SMF_INSTANCES</td>
1.177 leot 12950: <td>SMF_MANIFEST</td>
1.159 rillig 12951: </tr>
12952: <tr>
1.180 ! rillig 12953: <td>SMF_METHODS</td>
1.177 leot 12954: <td>SMF_METHOD_SHELL</td>
1.156 leot 12955: </tr>
12956: <tr>
1.180 ! rillig 12957: <td>SMF_METHOD_SRC</td>
1.177 leot 12958: <td>SMF_NAME</td>
1.156 leot 12959: </tr>
12960: <tr>
1.180 ! rillig 12961: <td>SMF_PREFIX</td>
1.177 leot 12962: <td>SMF_SRCDIR</td>
1.156 leot 12963: </tr>
12964: <tr>
1.180 ! rillig 12965: <td>SNIPROXY_GROUP</td>
1.177 leot 12966: <td>SNIPROXY_USER</td>
1.156 leot 12967: </tr>
12968: <tr>
1.180 ! rillig 12969: <td>SOURCE_BUFFSIZE</td>
1.177 leot 12970: <td>SPECIAL_PERMS</td>
1.156 leot 12971: </tr>
12972: <tr>
1.180 ! rillig 12973: <td>SPECIFIC_PKGS</td>
1.177 leot 12974: <td>SSH_SUID</td>
1.156 leot 12975: </tr>
12976: <tr>
1.180 ! rillig 12977: <td>SSP_SUPPORTED</td>
1.177 leot 12978: <td>SSYNC_PAWD</td>
1.156 leot 12979: </tr>
12980: <tr>
1.180 ! rillig 12981: <td>STEP_MSG</td>
1.177 leot 12982: <td>STRIP</td>
1.156 leot 12983: </tr>
12984: <tr>
1.180 ! rillig 12985: <td>STRIP_DBG</td>
1.177 leot 12986: <td>STRIP_DEBUG</td>
1.156 leot 12987: </tr>
12988: <tr>
1.180 ! rillig 12989: <td>STRIP_DEBUG_SUPPORTED</td>
1.177 leot 12990: <td>STRIP_FILES_SKIP</td>
1.156 leot 12991: </tr>
12992: <tr>
1.180 ! rillig 12993: <td>SU</td>
1.177 leot 12994: <td>SUBDIR</td>
1.156 leot 12995: </tr>
12996: <tr>
1.180 ! rillig 12997: <td>SUBST</td>
1.177 leot 12998: <td>SUBST_CLASSES</td>
1.174 leot 12999: </tr>
13000: <tr>
1.180 ! rillig 13001: <td>SUBST_FILES</td>
1.177 leot 13002: <td>SUBST_FILTER_CMD</td>
1.156 leot 13003: </tr>
13004: <tr>
1.180 ! rillig 13005: <td>SUBST_MESSAGE</td>
1.177 leot 13006: <td>SUBST_NOOP_OK</td>
1.156 leot 13007: </tr>
13008: <tr>
1.180 ! rillig 13009: <td>SUBST_SED</td>
1.177 leot 13010: <td>SUBST_SHOW_DIFF</td>
1.156 leot 13011: </tr>
13012: <tr>
1.180 ! rillig 13013: <td>SUBST_SKIP_TEXT_CHECK</td>
1.177 leot 13014: <td>SUBST_STAGE</td>
1.156 leot 13015: </tr>
13016: <tr>
1.180 ! rillig 13017: <td>SUBST_VARS</td>
1.177 leot 13018: <td>SUNWSPROBASE</td>
1.156 leot 13019: </tr>
13020: <tr>
1.180 ! rillig 13021: <td>SUSE_PREFER</td>
1.177 leot 13022: <td>SU_CMD</td>
13023: </tr>
13024: <tr>
1.180 ! rillig 13025: <td>SVN_EXTRACTDIR</td>
1.177 leot 13026: <td>SVN_REPO</td>
13027: </tr>
13028: <tr>
1.180 ! rillig 13029: <td>SVN_REPOSITORIES</td>
1.177 leot 13030: <td>SVN_REVISION</td>
1.156 leot 13031: </tr>
13032: <tr>
1.180 ! rillig 13033: <td>TERMCAP_TYPE</td>
1.177 leot 13034: <td>TERMINFO_DEFAULT</td>
1.161 leot 13035: </tr>
13036: <tr>
1.180 ! rillig 13037: <td>TERMINFO_TYPE</td>
1.177 leot 13038: <td>TEST</td>
1.159 rillig 13039: </tr>
13040: <tr>
1.180 ! rillig 13041: <td>TEST_DEPENDS</td>
1.177 leot 13042: <td>TEST_DIRS</td>
1.156 leot 13043: </tr>
13044: <tr>
1.180 ! rillig 13045: <td>TEST_ENV</td>
1.177 leot 13046: <td>TEST_ENV_SHELL</td>
1.156 leot 13047: </tr>
13048: <tr>
1.180 ! rillig 13049: <td>TEST_MAKE_CMD</td>
1.177 leot 13050: <td>TEST_MAKE_FLAGS</td>
1.156 leot 13051: </tr>
13052: <tr>
1.180 ! rillig 13053: <td>TEST_TARGET</td>
1.177 leot 13054: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.156 leot 13055: </tr>
13056: <tr>
1.180 ! rillig 13057: <td>TEXLIVE_REV</td>
1.177 leot 13058: <td>TEXLIVE_UNVERSIONED</td>
1.156 leot 13059: </tr>
13060: <tr>
1.180 ! rillig 13061: <td>TEXMFSITE</td>
1.177 leot 13062: <td>TEX_FORMATS</td>
1.156 leot 13063: </tr>
13064: <tr>
1.180 ! rillig 13065: <td>TEX_HYPHEN_DAT</td>
1.177 leot 13066: <td>TEX_HYPHEN_DEF</td>
1.156 leot 13067: </tr>
13068: <tr>
1.180 ! rillig 13069: <td>TEX_TEXMF_DIRS</td>
1.177 leot 13070: <td>THTTPD_LOG_FACILITY</td>
1.156 leot 13071: </tr>
13072: <tr>
1.180 ! rillig 13073: <td>TO</td>
1.177 leot 13074: <td>TOOLS_ALIASES</td>
1.156 leot 13075: </tr>
13076: <tr>
1.180 ! rillig 13077: <td>TOOLS_ALWAYS_WRAP</td>
1.169 rillig 13078: <td>TOOLS_ARGS</td>
1.156 leot 13079: </tr>
13080: <tr>
1.180 ! rillig 13081: <td>TOOLS_BROKEN</td>
1.169 rillig 13082: <td>TOOLS_CMD</td>
1.156 leot 13083: </tr>
13084: <tr>
1.180 ! rillig 13085: <td>TOOLS_CREATE</td>
1.169 rillig 13086: <td>TOOLS_DIR</td>
1.156 leot 13087: </tr>
13088: <tr>
1.180 ! rillig 13089: <td>TOOLS_FAIL</td>
1.169 rillig 13090: <td>TOOLS_GNU_MISSING</td>
1.156 leot 13091: </tr>
13092: <tr>
1.180 ! rillig 13093: <td>TOOLS_LDCONFIG</td>
1.169 rillig 13094: <td>TOOLS_NOOP</td>
1.156 leot 13095: </tr>
13096: <tr>
1.180 ! rillig 13097: <td>TOOLS_PATH</td>
1.169 rillig 13098: <td>TOOLS_SCRIPT</td>
1.156 leot 13099: </tr>
13100: <tr>
1.180 ! rillig 13101: <td>TOOL_DEPENDS</td>
1.177 leot 13102: <td>TTF_FONTDIR</td>
1.161 leot 13103: </tr>
13104: <tr>
1.180 ! rillig 13105: <td>TTF_FONTS_DIR</td>
1.169 rillig 13106: <td>TYPE</td>
1.156 leot 13107: </tr>
13108: <tr>
1.180 ! rillig 13109: <td>UAC_REQD_EXECS</td>
1.169 rillig 13110: <td>UCSPI_SSL_GROUP</td>
1.156 leot 13111: </tr>
13112: <tr>
1.180 ! rillig 13113: <td>UCSPI_SSL_USER</td>
1.169 rillig 13114: <td>UNLIMIT_RESOURCES</td>
1.156 leot 13115: </tr>
13116: <tr>
1.180 ! rillig 13117: <td>UNPRIVILEGED</td>
1.169 rillig 13118: <td>UNPRIVILEGED_GROUP</td>
1.156 leot 13119: </tr>
13120: <tr>
1.180 ! rillig 13121: <td>UNPRIVILEGED_GROUPS</td>
1.169 rillig 13122: <td>UNPRIVILEGED_USER</td>
1.156 leot 13123: </tr>
13124: <tr>
1.180 ! rillig 13125: <td>UNWRAP_FILES</td>
1.169 rillig 13126: <td>UNWRAP_PATTERNS</td>
1.156 leot 13127: </tr>
13128: <tr>
1.180 ! rillig 13129: <td>UPDATE_GEMSPEC</td>
1.169 rillig 13130: <td>UPDATE_TARGET</td>
1.156 leot 13131: </tr>
13132: <tr>
1.180 ! rillig 13133: <td>URI</td>
1.175 gutterid 13134: <td>USERGROUP_PHASE</td>
1.156 leot 13135: </tr>
13136: <tr>
1.180 ! rillig 13137: <td>USERPPP_GROUP</td>
1.175 gutterid 13138: <td>USER_SPECIFIC_PKGS</td>
1.156 leot 13139: </tr>
13140: <tr>
1.180 ! rillig 13141: <td>USE_ABI_DEPENDS</td>
1.175 gutterid 13142: <td>USE_APR</td>
1.156 leot 13143: </tr>
13144: <tr>
1.180 ! rillig 13145: <td>USE_BSD_MAKEFILE</td>
1.175 gutterid 13146: <td>USE_BUILTIN</td>
1.156 leot 13147: </tr>
13148: <tr>
1.180 ! rillig 13149: <td>USE_CROSS_COMPILE</td>
1.175 gutterid 13150: <td>USE_CURSES</td>
1.156 leot 13151: </tr>
13152: <tr>
1.180 ! rillig 13153: <td>USE_CWRAPPERS</td>
1.175 gutterid 13154: <td>USE_DB185</td>
1.156 leot 13155: </tr>
13156: <tr>
1.180 ! rillig 13157: <td>USE_FEATURES</td>
1.175 gutterid 13158: <td>USE_GAMESGROUP</td>
1.156 leot 13159: </tr>
13160: <tr>
1.180 ! rillig 13161: <td>USE_GCC_RUNTIME</td>
1.175 gutterid 13162: <td>USE_IMAKE</td>
1.156 leot 13163: </tr>
13164: <tr>
1.180 ! rillig 13165: <td>USE_JAVA</td>
1.175 gutterid 13166: <td>USE_JAVA2</td>
1.156 leot 13167: </tr>
13168: <tr>
1.180 ! rillig 13169: <td>USE_LANGUAGES</td>
1.175 gutterid 13170: <td>USE_LIBTOOL</td>
1.156 leot 13171: </tr>
13172: <tr>
1.180 ! rillig 13173: <td>USE_NATIVE_GCC</td>
1.175 gutterid 13174: <td>USE_NETBSD_REPO</td>
1.156 leot 13175: </tr>
13176: <tr>
1.180 ! rillig 13177: <td>USE_PKGSRC_GCC</td>
1.175 gutterid 13178: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.156 leot 13179: </tr>
13180: <tr>
1.180 ! rillig 13181: <td>USE_PKGTASKS</td>
1.175 gutterid 13182: <td>USE_PKG_ADMIN_DIGEST</td>
1.156 leot 13183: </tr>
13184: <tr>
1.180 ! rillig 13185: <td>USE_RUBY_EXTCONF</td>
1.175 gutterid 13186: <td>USE_RUBY_INSTALL</td>
1.156 leot 13187: </tr>
13188: <tr>
1.180 ! rillig 13189: <td>USE_RUBY_SETUP</td>
1.175 gutterid 13190: <td>USE_RUBY_SETUP_PKG</td>
1.156 leot 13191: </tr>
13192: <tr>
1.180 ! rillig 13193: <td>USE_TOOLS</td>
1.175 gutterid 13194: <td>UUCP_GROUP</td>
1.156 leot 13195: </tr>
13196: <tr>
1.180 ! rillig 13197: <td>UUCP_USER</td>
1.175 gutterid 13198: <td>VARBASE</td>
1.156 leot 13199: </tr>
13200: <tr>
1.180 ! rillig 13201: <td>VARNAME</td>
1.175 gutterid 13202: <td>VIM_EXTRA_OPTS</td>
1.156 leot 13203: </tr>
13204: <tr>
1.180 ! rillig 13205: <td>WARNING_MSG</td>
1.175 gutterid 13206: <td>WCALC_CGIDIR</td>
1.156 leot 13207: </tr>
13208: <tr>
1.180 ! rillig 13209: <td>WCALC_CGIPATH</td>
1.175 gutterid 13210: <td>WCALC_HTMLDIR</td>
1.156 leot 13211: </tr>
13212: <tr>
1.180 ! rillig 13213: <td>WCALC_HTMLPATH</td>
1.175 gutterid 13214: <td>WDM_MANAGERS</td>
1.156 leot 13215: </tr>
13216: <tr>
1.180 ! rillig 13217: <td>WRAPPER_REORDER_CMDS</td>
1.175 gutterid 13218: <td>WRKDIR</td>
1.156 leot 13219: </tr>
13220: <tr>
1.180 ! rillig 13221: <td>WRKDIR_BASENAME</td>
1.175 gutterid 13222: <td>WRKDIR_LOCKTYPE</td>
1.156 leot 13223: </tr>
13224: <tr>
1.180 ! rillig 13225: <td>WRKLOG</td>
1.175 gutterid 13226: <td>WRKOBJDIR</td>
1.156 leot 13227: </tr>
13228: <tr>
1.180 ! rillig 13229: <td>WRKSRC</td>
1.175 gutterid 13230: <td>X10_PORT</td>
1.156 leot 13231: </tr>
13232: <tr>
1.180 ! rillig 13233: <td>X11</td>
1.175 gutterid 13234: <td>X11BASE</td>
1.156 leot 13235: </tr>
13236: <tr>
1.180 ! rillig 13237: <td>X11_PKGSRCDIR</td>
1.175 gutterid 13238: <td>X11_TYPE</td>
1.156 leot 13239: </tr>
13240: <tr>
1.180 ! rillig 13241: <td>X509_CERTIFICATE</td>
1.175 gutterid 13242: <td>X509_KEY</td>
1.156 leot 13243: </tr>
13244: <tr>
1.180 ! rillig 13245: <td>XAW_TYPE</td>
1.175 gutterid 13246: <td>XLOCK_DEFAULT_MODE</td>
1.156 leot 13247: </tr>
13248: <tr>
1.180 ! rillig 13249: <td>XMKMF_FLAGS</td>
1.172 rillig 13250: <td>XXX</td>
1.156 leot 13251: </tr>
13252: <tr>
1.180 ! rillig 13253: <td>XXXX</td>
1.172 rillig 13254: <td>YES</td>
1.159 rillig 13255: </tr>
13256: <tr>
1.180 ! rillig 13257: <td>ZSH_STATIC</td>
1.174 leot 13258: <td>__stdc__</td>
1.156 leot 13259: </tr>
13260: <tr>
1.180 ! rillig 13261: <td>_vargroups</td>
1.174 leot 13262: <td>accept</td>
13263: </tr>
13264: <tr>
1.180 ! rillig 13265: <td>acquire-localbase-lock</td>
1.174 leot 13266: <td>acquire-lock</td>
1.156 leot 13267: </tr>
13268: <tr>
1.180 ! rillig 13269: <td>add</td>
1.174 leot 13270: <td>administrator</td>
1.156 leot 13271: </tr>
13272: <tr>
1.180 ! rillig 13273: <td>alloca</td>
1.159 rillig 13274: <td>alternatives</td>
1.174 leot 13275: </tr>
13276: <tr>
1.180 ! rillig 13277: <td>aslr</td>
1.174 leot 13278: <td>asprintf</td>
1.156 leot 13279: </tr>
13280: <tr>
1.180 ! rillig 13281: <td>atlas</td>
1.174 leot 13282: <td>autoconf</td>
1.161 leot 13283: </tr>
13284: <tr>
1.180 ! rillig 13285: <td>automake</td>
1.174 leot 13286: <td>autoreconf</td>
1.156 leot 13287: </tr>
13288: <tr>
1.180 ! rillig 13289: <td>awk</td>
1.174 leot 13290: <td>bash</td>
1.156 leot 13291: </tr>
13292: <tr>
1.180 ! rillig 13293: <td>big-endian</td>
1.174 leot 13294: <td>bin-install</td>
1.156 leot 13295: </tr>
13296: <tr>
1.180 ! rillig 13297: <td>bind</td>
1.172 rillig 13298: <td>binpkg-list</td>
1.177 leot 13299: </tr>
13300: <tr>
1.180 ! rillig 13301: <td>blas</td>
1.172 rillig 13302: <td>bootstrap-depends</td>
1.159 rillig 13303: </tr>
13304: <tr>
1.180 ! rillig 13305: <td>broken</td>
1.172 rillig 13306: <td>broken_on_platform</td>
1.156 leot 13307: </tr>
13308: <tr>
1.180 ! rillig 13309: <td>bsd</td>
1.174 leot 13310: <td>bsd.prog.mk</td>
13311: </tr>
13312: <tr>
1.180 ! rillig 13313: <td>build</td>
1.172 rillig 13314: <td>build-env</td>
1.156 leot 13315: </tr>
13316: <tr>
1.180 ! rillig 13317: <td>buildlink-directories</td>
1.172 rillig 13318: <td>buildlink-oss-soundcard-h</td>
1.156 leot 13319: </tr>
13320: <tr>
1.180 ! rillig 13321: <td>c</td>
1.172 rillig 13322: <td>c++</td>
1.156 leot 13323: </tr>
13324: <tr>
1.180 ! rillig 13325: <td>ccache</td>
1.172 rillig 13326: <td>cce</td>
1.156 leot 13327: </tr>
13328: <tr>
1.180 ! rillig 13329: <td>cdefs</td>
1.174 leot 13330: <td>ceil</td>
13331: </tr>
13332: <tr>
1.180 ! rillig 13333: <td>changes</td>
1.174 leot 13334: <td>changes-entry</td>
1.156 leot 13335: </tr>
13336: <tr>
1.180 ! rillig 13337: <td>changes-entry-noupdate</td>
1.174 leot 13338: <td>check</td>
1.156 leot 13339: </tr>
13340: <tr>
1.180 ! rillig 13341: <td>check-clean</td>
1.174 leot 13342: <td>check-files</td>
1.156 leot 13343: </tr>
13344: <tr>
1.180 ! rillig 13345: <td>check-files-clean</td>
1.174 leot 13346: <td>check-vulnerable</td>
1.156 leot 13347: </tr>
13348: <tr>
1.180 ! rillig 13349: <td>checksum</td>
1.174 leot 13350: <td>checksum-phase</td>
1.156 leot 13351: </tr>
13352: <tr>
1.180 ! rillig 13353: <td>clean</td>
1.174 leot 13354: <td>clean-depends</td>
1.156 leot 13355: </tr>
13356: <tr>
1.180 ! rillig 13357: <td>cleandir</td>
1.174 leot 13358: <td>commit</td>
1.156 leot 13359: </tr>
13360: <tr>
1.180 ! rillig 13361: <td>commit-changes-entry</td>
1.174 leot 13362: <td>compact</td>
1.156 leot 13363: </tr>
13364: <tr>
1.180 ! rillig 13365: <td>compiler</td>
1.174 leot 13366: <td>conf</td>
1.156 leot 13367: </tr>
13368: <tr>
1.180 ! rillig 13369: <td>config.guess</td>
1.174 leot 13370: <td>config.sub</td>
1.156 leot 13371: </tr>
13372: <tr>
1.180 ! rillig 13373: <td>configuration</td>
1.174 leot 13374: <td>configure</td>
1.156 leot 13375: </tr>
13376: <tr>
1.180 ! rillig 13377: <td>configure-env</td>
1.174 leot 13378: <td>configure-help</td>
1.156 leot 13379: </tr>
13380: <tr>
1.180 ! rillig 13381: <td>configure_args</td>
1.174 leot 13382: <td>connect</td>
1.156 leot 13383: </tr>
13384: <tr>
1.180 ! rillig 13385: <td>cos</td>
1.166 leot 13386: <td>cputime</td>
1.174 leot 13387: </tr>
13388: <tr>
1.180 ! rillig 13389: <td>create-usergroup</td>
1.174 leot 13390: <td>csh</td>
1.156 leot 13391: </tr>
13392: <tr>
1.180 ! rillig 13393: <td>ctf</td>
1.177 leot 13394: <td>cvs</td>
1.161 leot 13395: </tr>
13396: <tr>
1.180 ! rillig 13397: <td>debug</td>
1.174 leot 13398: <td>declaration</td>
1.156 leot 13399: </tr>
13400: <tr>
1.180 ! rillig 13401: <td>declare</td>
1.174 leot 13402: <td>defined</td>
1.156 leot 13403: </tr>
13404: <tr>
1.180 ! rillig 13405: <td>depend</td>
1.174 leot 13406: <td>dependencies</td>
1.156 leot 13407: </tr>
13408: <tr>
1.180 ! rillig 13409: <td>depends</td>
1.174 leot 13410: <td>depends-checksum</td>
1.156 leot 13411: </tr>
13412: <tr>
1.180 ! rillig 13413: <td>depends-fetch</td>
1.174 leot 13414: <td>deps</td>
1.156 leot 13415: </tr>
13416: <tr>
1.180 ! rillig 13417: <td>describe</td>
1.174 leot 13418: <td>destdir</td>
1.156 leot 13419: </tr>
13420: <tr>
1.180 ! rillig 13421: <td>disable</td>
1.174 leot 13422: <td>distclean</td>
1.162 rillig 13423: </tr>
13424: <tr>
1.180 ! rillig 13425: <td>distinfo</td>
1.174 leot 13426: <td>dl</td>
1.156 leot 13427: </tr>
13428: <tr>
1.180 ! rillig 13429: <td>dlopen</td>
1.174 leot 13430: <td>do-build</td>
1.156 leot 13431: </tr>
13432: <tr>
1.180 ! rillig 13433: <td>do-buildlink</td>
1.174 leot 13434: <td>do-clean</td>
1.156 leot 13435: </tr>
13436: <tr>
1.180 ! rillig 13437: <td>do-configure</td>
1.174 leot 13438: <td>do-configure-post-hook</td>
1.170 rillig 13439: </tr>
13440: <tr>
1.180 ! rillig 13441: <td>do-extract</td>
1.174 leot 13442: <td>do-fetch</td>
1.177 leot 13443: </tr>
13444: <tr>
1.180 ! rillig 13445: <td>do-install</td>
1.174 leot 13446: <td>emul</td>
13447: </tr>
13448: <tr>
1.180 ! rillig 13449: <td>emul-distinfo</td>
1.174 leot 13450: <td>emul-fetch</td>
1.156 leot 13451: </tr>
13452: <tr>
1.180 ! rillig 13453: <td>emulation</td>
1.174 leot 13454: <td>emulator</td>
1.159 rillig 13455: </tr>
13456: <tr>
1.180 ! rillig 13457: <td>enable</td>
1.174 leot 13458: <td>endian</td>
1.156 leot 13459: </tr>
13460: <tr>
1.180 ! rillig 13461: <td>endif</td>
1.170 rillig 13462: <td>enomem</td>
1.156 leot 13463: </tr>
13464: <tr>
1.180 ! rillig 13465: <td>err</td>
1.170 rillig 13466: <td>errx</td>
1.156 leot 13467: </tr>
13468: <tr>
1.180 ! rillig 13469: <td>etc</td>
1.174 leot 13470: <td>exp</td>
13471: </tr>
13472: <tr>
1.180 ! rillig 13473: <td>extract-rpm</td>
1.174 leot 13474: <td>fabs</td>
1.156 leot 13475: </tr>
13476: <tr>
1.180 ! rillig 13477: <td>feature</td>
1.159 rillig 13478: <td>features</td>
1.156 leot 13479: </tr>
13480: <tr>
1.180 ! rillig 13481: <td>fetch</td>
1.159 rillig 13482: <td>fetch-list</td>
1.156 leot 13483: </tr>
13484: <tr>
1.180 ! rillig 13485: <td>follows</td>
1.159 rillig 13486: <td>forbids</td>
1.156 leot 13487: </tr>
13488: <tr>
1.180 ! rillig 13489: <td>form</td>
1.159 rillig 13490: <td>format</td>
1.156 leot 13491: </tr>
13492: <tr>
1.180 ! rillig 13493: <td>fortify</td>
1.159 rillig 13494: <td>fortify_source</td>
1.177 leot 13495: </tr>
13496: <tr>
1.180 ! rillig 13497: <td>fossil</td>
1.157 leot 13498: <td>friend</td>
1.156 leot 13499: </tr>
13500: <tr>
1.180 ! rillig 13501: <td>fts</td>
1.170 rillig 13502: <td>fts_close</td>
1.156 leot 13503: </tr>
13504: <tr>
1.180 ! rillig 13505: <td>fts_open</td>
1.170 rillig 13506: <td>fts_read</td>
1.156 leot 13507: </tr>
13508: <tr>
1.180 ! rillig 13509: <td>fts_set</td>
1.174 leot 13510: <td>gcc</td>
13511: </tr>
13512: <tr>
1.180 ! rillig 13513: <td>gethostbyaddr</td>
1.174 leot 13514: <td>gethostbyname</td>
1.156 leot 13515: </tr>
13516: <tr>
1.180 ! rillig 13517: <td>gethostbyname2</td>
1.170 rillig 13518: <td>getopt_long</td>
1.156 leot 13519: </tr>
13520: <tr>
1.180 ! rillig 13521: <td>getprogname</td>
1.174 leot 13522: <td>getservbyname</td>
13523: </tr>
13524: <tr>
1.180 ! rillig 13525: <td>getservbyport</td>
1.174 leot 13526: <td>getservent</td>
13527: </tr>
13528: <tr>
1.180 ! rillig 13529: <td>gettext</td>
1.177 leot 13530: <td>git</td>
1.156 leot 13531: </tr>
13532: <tr>
1.180 ! rillig 13533: <td>github</td>
1.177 leot 13534: <td>gitlab</td>
13535: </tr>
13536: <tr>
1.180 ! rillig 13537: <td>glob</td>
1.175 gutterid 13538: <td>gnu</td>
1.159 rillig 13539: </tr>
13540: <tr>
1.180 ! rillig 13541: <td>gnu_configure_strict</td>
1.175 gutterid 13542: <td>go</td>
1.156 leot 13543: </tr>
13544: <tr>
1.180 ! rillig 13545: <td>go-deps</td>
1.175 gutterid 13546: <td>golang</td>
1.156 leot 13547: </tr>
13548: <tr>
1.180 ! rillig 13549: <td>guess-license</td>
1.175 gutterid 13550: <td>hashbang</td>
1.156 leot 13551: </tr>
13552: <tr>
1.180 ! rillig 13553: <td>heimdal</td>
1.170 rillig 13554: <td>help</td>
1.156 leot 13555: </tr>
13556: <tr>
1.180 ! rillig 13557: <td>hg</td>
1.170 rillig 13558: <td>imake</td>
1.161 leot 13559: </tr>
13560: <tr>
1.180 ! rillig 13561: <td>increment</td>
1.174 leot 13562: <td>inet_aton</td>
1.156 leot 13563: </tr>
13564: <tr>
1.180 ! rillig 13565: <td>interp</td>
1.157 leot 13566: <td>interpreter</td>
1.156 leot 13567: </tr>
13568: <tr>
1.180 ! rillig 13569: <td>intl</td>
1.157 leot 13570: <td>iso</td>
1.156 leot 13571: </tr>
13572: <tr>
1.180 ! rillig 13573: <td>kerberos</td>
1.157 leot 13574: <td>krb</td>
1.156 leot 13575: </tr>
13576: <tr>
1.180 ! rillig 13577: <td>krb5</td>
1.157 leot 13578: <td>ksh</td>
1.177 leot 13579: </tr>
13580: <tr>
1.180 ! rillig 13581: <td>lapack</td>
1.175 gutterid 13582: <td>latex</td>
1.156 leot 13583: </tr>
13584: <tr>
1.180 ! rillig 13585: <td>libintl_bindtextdomain</td>
1.175 gutterid 13586: <td>libintl_gettext</td>
1.174 leot 13587: </tr>
13588: <tr>
1.180 ! rillig 13589: <td>libintl_textdomain</td>
1.175 gutterid 13590: <td>libnbcompat</td>
1.159 rillig 13591: </tr>
13592: <tr>
1.180 ! rillig 13593: <td>libs</td>
1.175 gutterid 13594: <td>libtool</td>
1.156 leot 13595: </tr>
13596: <tr>
1.180 ! rillig 13597: <td>licence</td>
1.175 gutterid 13598: <td>license</td>
1.156 leot 13599: </tr>
13600: <tr>
1.180 ! rillig 13601: <td>lintl</td>
1.175 gutterid 13602: <td>little-endian</td>
1.156 leot 13603: </tr>
13604: <tr>
1.180 ! rillig 13605: <td>lock</td>
1.175 gutterid 13606: <td>locking</td>
1.156 leot 13607: </tr>
13608: <tr>
1.180 ! rillig 13609: <td>lvalue</td>
1.175 gutterid 13610: <td>make</td>
1.156 leot 13611: </tr>
13612: <tr>
1.180 ! rillig 13613: <td>makesum</td>
1.174 leot 13614: <td>memory</td>
1.161 leot 13615: </tr>
13616: <tr>
1.180 ! rillig 13617: <td>mercurial</td>
1.174 leot 13618: <td>meta</td>
1.156 leot 13619: </tr>
13620: <tr>
1.180 ! rillig 13621: <td>meta-package</td>
1.174 leot 13622: <td>meta_package</td>
1.156 leot 13623: </tr>
13624: <tr>
1.180 ! rillig 13625: <td>mit-krb5</td>
1.174 leot 13626: <td>mk.conf</td>
1.177 leot 13627: </tr>
13628: <tr>
1.180 ! rillig 13629: <td>mkl</td>
1.175 gutterid 13630: <td>mount</td>
1.159 rillig 13631: </tr>
13632: <tr>
1.180 ! rillig 13633: <td>mprotect</td>
1.175 gutterid 13634: <td>mremap</td>
1.156 leot 13635: </tr>
13636: <tr>
1.180 ! rillig 13637: <td>nb</td>
1.175 gutterid 13638: <td>nbcompat</td>
1.156 leot 13639: </tr>
13640: <tr>
1.180 ! rillig 13641: <td>obstack</td>
1.175 gutterid 13642: <td>obstack_ptr_grow</td>
1.156 leot 13643: </tr>
13644: <tr>
1.180 ! rillig 13645: <td>occurs</td>
1.159 rillig 13646: <td>only</td>
1.161 leot 13647: </tr>
13648: <tr>
1.180 ! rillig 13649: <td>openblas</td>
1.158 brook 13650: <td>options</td>
1.156 leot 13651: </tr>
13652: <tr>
1.180 ! rillig 13653: <td>options.mk</td>
1.158 brook 13654: <td>order</td>
1.156 leot 13655: </tr>
13656: <tr>
1.180 ! rillig 13657: <td>override</td>
1.158 brook 13658: <td>override-intltool</td>
1.156 leot 13659: </tr>
13660: <tr>
1.180 ! rillig 13661: <td>override-message-intltool</td>
1.158 brook 13662: <td>package</td>
1.156 leot 13663: </tr>
13664: <tr>
1.180 ! rillig 13665: <td>parallel</td>
1.170 rillig 13666: <td>path</td>
1.156 leot 13667: </tr>
13668: <tr>
1.180 ! rillig 13669: <td>pax</td>
1.170 rillig 13670: <td>paxctl</td>
1.156 leot 13671: </tr>
13672: <tr>
1.180 ! rillig 13673: <td>pbulk-index</td>
1.170 rillig 13674: <td>pc</td>
1.156 leot 13675: </tr>
13676: <tr>
1.180 ! rillig 13677: <td>perl</td>
1.170 rillig 13678: <td>perl5</td>
1.156 leot 13679: </tr>
13680: <tr>
1.180 ! rillig 13681: <td>perms</td>
1.170 rillig 13682: <td>php</td>
1.156 leot 13683: </tr>
13684: <tr>
1.180 ! rillig 13685: <td>pkg-build-options</td>
1.170 rillig 13686: <td>pkg-config</td>
1.156 leot 13687: </tr>
13688: <tr>
1.180 ! rillig 13689: <td>pkg_build_options</td>
1.170 rillig 13690: <td>platform</td>
1.156 leot 13691: </tr>
13692: <tr>
1.180 ! rillig 13693: <td>plist</td>
1.170 rillig 13694: <td>post-extract</td>
1.156 leot 13695: </tr>
13696: <tr>
1.180 ! rillig 13697: <td>post-fetch</td>
1.170 rillig 13698: <td>post-wrapper</td>
1.156 leot 13699: </tr>
13700: <tr>
1.180 ! rillig 13701: <td>pre-build-checks-hook</td>
1.158 brook 13702: <td>pre-configure</td>
1.174 leot 13703: </tr>
13704: <tr>
1.180 ! rillig 13705: <td>pre-configure-checks-hook</td>
1.170 rillig 13706: <td>pre-extract</td>
1.156 leot 13707: </tr>
13708: <tr>
1.180 ! rillig 13709: <td>pre-fetch</td>
1.170 rillig 13710: <td>print-go-deps</td>
1.156 leot 13711: </tr>
13712: <tr>
1.180 ! rillig 13713: <td>print-plist</td>
1.170 rillig 13714: <td>print-summary-data</td>
1.156 leot 13715: </tr>
13716: <tr>
1.180 ! rillig 13717: <td>privileged-install-hook</td>
1.170 rillig 13718: <td>pypi</td>
1.156 leot 13719: </tr>
13720: <tr>
1.180 ! rillig 13721: <td>python</td>
1.170 rillig 13722: <td>readme-all</td>
1.156 leot 13723: </tr>
13724: <tr>
1.180 ! rillig 13725: <td>recv</td>
1.174 leot 13726: <td>recvfrom</td>
13727: </tr>
13728: <tr>
1.180 ! rillig 13729: <td>regcomp</td>
1.174 leot 13730: <td>release-localbase-lock</td>
13731: </tr>
13732: <tr>
1.180 ! rillig 13733: <td>release-lock</td>
1.170 rillig 13734: <td>relro</td>
1.156 leot 13735: </tr>
13736: <tr>
1.180 ! rillig 13737: <td>rename</td>
1.170 rillig 13738: <td>reorder</td>
1.156 leot 13739: </tr>
13740: <tr>
1.180 ! rillig 13741: <td>replace</td>
1.170 rillig 13742: <td>replace_interpreter</td>
1.156 leot 13743: </tr>
13744: <tr>
1.180 ! rillig 13745: <td>reproducible</td>
1.170 rillig 13746: <td>resolv</td>
1.156 leot 13747: </tr>
13748: <tr>
1.180 ! rillig 13749: <td>root</td>
1.170 rillig 13750: <td>ruby</td>
1.174 leot 13751: </tr>
13752: <tr>
1.180 ! rillig 13753: <td>send</td>
1.174 leot 13754: <td>sendfile</td>
1.156 leot 13755: </tr>
13756: <tr>
1.180 ! rillig 13757: <td>sendto</td>
1.158 brook 13758: <td>setenv</td>
1.156 leot 13759: </tr>
13760: <tr>
1.180 ! rillig 13761: <td>setgid</td>
1.158 brook 13762: <td>setprogname</td>
1.156 leot 13763: </tr>
13764: <tr>
1.180 ! rillig 13765: <td>setuid</td>
1.158 brook 13766: <td>sh</td>
1.156 leot 13767: </tr>
13768: <tr>
1.180 ! rillig 13769: <td>show</td>
1.158 brook 13770: <td>show-all</td>
1.156 leot 13771: </tr>
13772: <tr>
1.180 ! rillig 13773: <td>show-build-defs</td>
1.158 brook 13774: <td>show-depends</td>
1.156 leot 13775: </tr>
13776: <tr>
1.180 ! rillig 13777: <td>show-deps</td>
1.158 brook 13778: <td>show-distfiles</td>
1.156 leot 13779: </tr>
13780: <tr>
1.180 ! rillig 13781: <td>show-downlevel</td>
1.158 brook 13782: <td>show-subdir-var</td>
1.156 leot 13783: </tr>
13784: <tr>
1.180 ! rillig 13785: <td>show-tools</td>
1.158 brook 13786: <td>show-var</td>
1.156 leot 13787: </tr>
13788: <tr>
1.180 ! rillig 13789: <td>show-vars</td>
1.158 brook 13790: <td>snprintf</td>
1.174 leot 13791: </tr>
13792: <tr>
1.180 ! rillig 13793: <td>socket</td>
1.170 rillig 13794: <td>ssp</td>
1.156 leot 13795: </tr>
13796: <tr>
1.180 ! rillig 13797: <td>st_mode</td>
1.170 rillig 13798: <td>stage-install</td>
1.156 leot 13799: </tr>
13800: <tr>
1.180 ! rillig 13801: <td>strcasestr</td>
1.162 rillig 13802: <td>strict</td>
13803: </tr>
13804: <tr>
1.180 ! rillig 13805: <td>strip</td>
1.174 leot 13806: <td>strndup</td>
1.156 leot 13807: </tr>
13808: <tr>
1.180 ! rillig 13809: <td>strnlen</td>
1.174 leot 13810: <td>strsep</td>
13811: </tr>
13812: <tr>
1.180 ! rillig 13813: <td>subst</td>
1.174 leot 13814: <td>substitutions</td>
1.177 leot 13815: </tr>
13816: <tr>
1.180 ! rillig 13817: <td>subversion</td>
1.175 gutterid 13818: <td>sun</td>
1.156 leot 13819: </tr>
13820: <tr>
1.180 ! rillig 13821: <td>sunpro</td>
1.156 leot 13822: <td>sunwspro</td>
13823: </tr>
13824: <tr>
1.180 ! rillig 13825: <td>svn</td>
1.161 leot 13826: <td>symlink</td>
13827: </tr>
13828: <tr>
1.180 ! rillig 13829: <td>test</td>
1.174 leot 13830: <td>test-env</td>
1.156 leot 13831: </tr>
13832: <tr>
1.180 ! rillig 13833: <td>tex</td>
1.174 leot 13834: <td>texlive</td>
1.156 leot 13835: </tr>
13836: <tr>
1.180 ! rillig 13837: <td>tmp</td>
1.174 leot 13838: <td>tool</td>
1.156 leot 13839: </tr>
13840: <tr>
1.180 ! rillig 13841: <td>tools</td>
1.174 leot 13842: <td>tools-libtool-m4-override</td>
1.156 leot 13843: </tr>
13844: <tr>
1.180 ! rillig 13845: <td>type</td>
1.174 leot 13846: <td>ulimit</td>
1.156 leot 13847: </tr>
13848: <tr>
1.180 ! rillig 13849: <td>undefined</td>
1.174 leot 13850: <td>undo-replace</td>
1.156 leot 13851: </tr>
13852: <tr>
1.180 ! rillig 13853: <td>unlimit</td>
1.174 leot 13854: <td>unprivileged</td>
1.156 leot 13855: </tr>
13856: <tr>
1.180 ! rillig 13857: <td>unprivileged-install-hook</td>
1.174 leot 13858: <td>unstripped</td>
1.156 leot 13859: </tr>
13860: <tr>
1.180 ! rillig 13861: <td>update</td>
1.174 leot 13862: <td>upload</td>
1.156 leot 13863: </tr>
13864: <tr>
1.180 ! rillig 13865: <td>upload-distfiles</td>
1.157 leot 13866: <td>use_tools</td>
1.156 leot 13867: </tr>
13868: <tr>
1.180 ! rillig 13869: <td>user</td>
1.157 leot 13870: <td>utimes</td>
1.156 leot 13871: </tr>
13872: <tr>
1.180 ! rillig 13873: <td>vasprintf</td>
1.157 leot 13874: <td>verbose</td>
1.156 leot 13875: </tr>
13876: <tr>
1.180 ! rillig 13877: <td>vsnprintf</td>
1.157 leot 13878: <td>warn</td>
1.156 leot 13879: </tr>
13880: <tr>
1.180 ! rillig 13881: <td>warning</td>
1.157 leot 13882: <td>warnings</td>
1.156 leot 13883: </tr>
13884: <tr>
1.180 ! rillig 13885: <td>warnx</td>
1.174 leot 13886: <td>wattr_off</td>
1.156 leot 13887: </tr>
13888: <tr>
1.180 ! rillig 13889: <td>wattr_on</td>
1.174 leot 13890: <td>work</td>
1.156 leot 13891: </tr>
13892: <tr>
1.180 ! rillig 13893: <td>wrapper</td>
1.174 leot 13894: <td>wrkdir</td>
1.156 leot 13895: </tr>
13896: </table>
1.154 rillig 13897: </div>
13898: <div class="appendix">
13899: <div class="titlepage"><div><div><h1 class="title">
13900: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 13901: <div class="toc">
13902: <p><b>Table of Contents</b></p>
1.100 leot 13903: <dl class="toc">
1.154 rillig 13904: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
13905: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1 dsieger 13906: </dl>
13907: </div>
13908: <p>This section contains information on editing the pkgsrc
13909: guide itself.</p>
1.41 asau 13910: <div class="sect1">
1.1 dsieger 13911: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 13912: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.1 dsieger 13913: <p>The pkgsrc guide's source code is stored in
13914: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
13915: are created from it:</p>
1.41 asau 13916: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 13917: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
13918: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174 leot 13919: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/" target="_top">https://www.NetBSD.org/docs/pkgsrc/</a></p></li>
13920: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 13921: The PDF version of the pkgsrc guide.</p></li>
1.174 leot 13922: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 13923: PostScript version of the pkgsrc guide.</p></li>
13924: </ul></div>
13925: </div>
1.41 asau 13926: <div class="sect1">
1.1 dsieger 13927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 13928: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.1 dsieger 13929: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 13930: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 13931: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 13932: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 13933: documentation) installed. These are automatically installed when
1.137 leot 13934: 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.41 asau 13935: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 13936: right directory. All further steps will take place
13937: here.</p></li>
1.41 asau 13938: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 13939: <code class="filename">files/</code>.</p></li>
1.41 asau 13940: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 13941: guide for valid XML and to build the final output files. If you
13942: get any errors at this stage, you can just edit the files, as
13943: there are only symbolic links in the working directory, pointing
13944: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 13945: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 13946: commit)</strong></span></p></li>
1.41 asau 13947: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 13948: regenerate the output files with the proper RCS
13949: Ids.</p></li>
1.41 asau 13950: <li class="step">
1.10 hubertf 13951: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 13952: commit the files in both <code class="filename">pkgsrc/doc</code> and
13953: <code class="filename">htdocs</code>.</p>
1.41 asau 13954: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 13955: <h3 class="title">Note</h3>
13956: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 13957: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
13958: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 13959: directory.</p>
13960: </div>
13961: </li>
13962: </ol></div>
13963: </div>
13964: </div>
13965: </div></body>
13966: </html>
CVSweb <webmaster@jp.NetBSD.org>