Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.245
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.231 jnemeth 33: <div><p class="copyright">Copyright © 1994-2023 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.42 2023/01/02 05:45:23 jnemeth 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>
1.202 nia 88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 94: </dl></dd>
1.154 rillig 95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 96: <dd><dl>
1.154 rillig 97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
99: <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 100: </dl></dd>
101: </dl></dd>
1.154 rillig 102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 103: <dd><dl>
1.154 rillig 104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 106: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
107: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
108: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
109: <dd><dl>
110: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
111: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
112: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 113: </dl></dd>
1.241 rillig 114: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
115: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 116: </dl></dd>
1.154 rillig 117: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 118: <dd><dl>
1.154 rillig 119: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
120: <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 121: </dl></dd>
1.154 rillig 122: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 123: builds)</a></span></dt>
1.1 dsieger 124: <dd><dl>
1.154 rillig 125: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 126: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 127: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
128: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 129: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
130: <dd><dl>
1.179 rillig 131: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
132: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181 rillig 133: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
134: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
135: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
136: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
137: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
138: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
139: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
140: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 141: </dl></dd>
142: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
143: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 144: </dl></dd>
145: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
146: <dd><dl>
147: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
148: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
149: </dl></dd>
150: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
151: <dd><dl>
152: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
153: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
154: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
155: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
156: <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>
157: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
158: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
159: <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>
160: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
161: <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 162: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 163: <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>
1.221 nia 164: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 165: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
166: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
167: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
168: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
169: <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 170: </dl></dd>
171: </dl></dd>
172: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
173: <dd><dl>
1.154 rillig 174: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 175: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 176: <dd><dl>
1.184 rillig 177: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
178: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
179: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 180: <dd><dl>
1.184 rillig 181: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
182: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
183: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
184: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
185: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 186: </dl></dd>
1.184 rillig 187: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
188: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
189: <dd><dl>
190: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
191: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
192: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
193: </dl></dd>
194: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
195: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 196: </dl></dd>
1.184 rillig 197: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 198: <dd><dl>
1.184 rillig 199: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
200: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
201: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
202: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
203: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 204: <dd><dl>
1.184 rillig 205: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
206: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 207: </dl></dd>
1.184 rillig 208: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
209: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
210: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
211: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
212: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
213: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
214: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
215: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
216: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
217: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
218: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
219: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
220: </dl></dd>
221: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
222: <dd><dl>
223: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 224: <dd><dl>
1.219 nia 225: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
226: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
227: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 228: </dl></dd>
1.184 rillig 229: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
230: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 231: </dl></dd>
1.184 rillig 232: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 233: <dd><dl>
1.184 rillig 234: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
235: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
236: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
237: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 238: <dd><dl>
1.184 rillig 239: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
240: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
241: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
242: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 243: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 244: </dl></dd>
245: </dl></dd>
1.184 rillig 246: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 247: <dd><dl>
1.184 rillig 248: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
249: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
250: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
251: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 252: </dl></dd>
1.184 rillig 253: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 254: <dd><dl>
1.184 rillig 255: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
256: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
257: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
258: </dl></dd>
259: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
260: <dd><dl>
261: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
262: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 263: <dd><dl>
1.184 rillig 264: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
265: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 266: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
267: and
268: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
269: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 270: </dl></dd>
1.184 rillig 271: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.241 rillig 272: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.184 rillig 273: </dl></dd>
274: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 275: <dd><dl>
1.184 rillig 276: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
277: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
278: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
279: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
280: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
281: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
282: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
283: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
284: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 285: </dl></dd>
1.184 rillig 286: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
287: <dd><dl>
288: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
289: <dd><dl>
290: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
291: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 292: </dl></dd>
1.184 rillig 293: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 294: <dd><dl>
1.184 rillig 295: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
296: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 297: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
298: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
299: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 300: </dl></dd>
301: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
302: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
303: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
304: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
305: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
306: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
307: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154 rillig 308: </dl></dd>
309: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
310: <dd><dl>
311: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
312: <dd><dl>
313: <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>
314: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
315: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
316: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
317: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
318: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
319: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
320: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
321: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
322: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
323: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
324: </dl></dd>
325: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
326: <dd><dl>
327: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
328: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
329: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
330: </dl></dd>
331: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
332: <dd><dl>
333: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
334: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
335: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 336: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 337: </dl></dd>
338: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
339: <dd><dl>
340: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
341: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 342: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 343: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
344: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
345: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
346: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 347: </dl></dd>
348: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
349: <dd><dl>
350: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
351: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 352: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
353: <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>
354: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 355: </dl></dd>
356: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
357: <dd><dl>
358: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
359: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
360: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
361: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
362: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 363: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 364: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
365: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 366: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
367: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
368: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
369: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
370: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
371: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
372: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 373: emulation</a></span></dt>
1.203 nia 374: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
375: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 376: </dl></dd>
1.154 rillig 377: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 378: </dl></dd>
1.184 rillig 379: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
380: <dd><dl>
381: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
382: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
383: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
384: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
385: </dl></dd>
1.154 rillig 386: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 387: <dd><dl>
1.154 rillig 388: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
389: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
390: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
391: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
392: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
393: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
394: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
395: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
396: </dl></dd>
397: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 398: </dl></dd>
399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
400: <dd><dl>
1.184 rillig 401: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 402: <dd><dl>
1.184 rillig 403: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 406: <dd><dl>
1.184 rillig 407: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
408: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 409: </dl></dd>
1.184 rillig 410: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
411: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 412: <dd><dl>
1.184 rillig 413: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
414: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 415: </dl></dd>
1.184 rillig 416: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 417: <dd><dl>
1.184 rillig 418: <dt><span class="sect2"><a href="#infr.order.prefs">25.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">25.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.184 rillig 422: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 423: <dd><dl>
1.184 rillig 424: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
425: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 426: <dd><dl>
1.184 rillig 427: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
428: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 429: </dl></dd>
430: </dl></dd>
1.184 rillig 431: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
432: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.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>
1.207 leot 445: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.1 dsieger 446: <dd><dl>
1.207 leot 447: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
448: <dd><dl>
449: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
450: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
451: </dl></dd>
452: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
453: <dd><dl>
454: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
455: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
456: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
457: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
458: </dl></dd>
459: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
460: <dd><dl>
461: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
462: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
463: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
464: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
465: </dl></dd>
466: </dl></dd>
467: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
468: <dd><dl>
469: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
470: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.1 dsieger 471: </dl></dd>
1.207 leot 472: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.1 dsieger 473: <dd><dl>
1.207 leot 474: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
475: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
476: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
477: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
478: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.148 leot 479: <code class="filename">stable</code>,
1.23 wiz 480: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 481: source packages</a></span></dt>
482: </dl></dd>
1.207 leot 483: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
484: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 485: <dd><dl>
1.207 leot 486: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
487: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 488: </dl></dd>
489: </dl>
490: </div>
491: <div class="list-of-tables">
492: <p><b>List of Tables</b></p>
493: <dl>
494: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
495: </dt>
1.184 rillig 496: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 497: </dt>
1.184 rillig 498: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 499: </dt>
500: </dl>
501: </div>
1.41 asau 502: <div class="chapter">
503: <div class="titlepage"><div><div><h1 class="title">
504: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 505: <div class="toc">
506: <p><b>Table of Contents</b></p>
1.100 leot 507: <dl class="toc">
1.1 dsieger 508: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
509: <dd><dl>
510: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
511: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
512: </dl></dd>
513: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
514: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
515: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
516: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
517: </dl>
518: </div>
1.41 asau 519: <div class="sect1">
1.1 dsieger 520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
521: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
522: <p>There is a lot of software freely available for Unix-based
523: systems, which is usually available in form of the source code. Before
524: such software can be used, it needs to be configured to the local
525: system, compiled and installed, and this is exactly what The NetBSD
526: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
527: to handle binary packages, so that not every user has to build the
528: packages for himself, which is a time-costly task.</p>
529: <p>pkgsrc currently contains several thousand packages,
530: including:</p>
1.41 asau 531: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 532: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1 dsieger 533: web server</p></li>
1.207 leot 534: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 535: web browser</p></li>
1.207 leot 536: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 537: Desktop Environment</p></li>
1.207 leot 538: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1 dsieger 539: Desktop Environment</p></li>
540: </ul></div>
1.108 rillig 541: <p>… just to name a few.</p>
1.1 dsieger 542: <p>pkgsrc has built-in support for handling varying dependencies,
543: such as pthreads and X11, and extended features such as IPv6 support on
544: a range of platforms.</p>
1.41 asau 545: <div class="sect2">
1.1 dsieger 546: <div class="titlepage"><div><div><h3 class="title">
547: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
548: <p>
549: pkgsrc provides the following key features:
550: </p>
1.41 asau 551: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 552: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 553: and installation of binary packages. The source and latest
554: patches are retrieved from a master or mirror download site, checksum
555: verified, then built on your system. Support for binary-only
556: distributions is available for both native platforms and NetBSD
557: emulated platforms.</p></li>
1.23 wiz 558: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 559: including binaries, libraries, man pages and other
560: documentation.</p></li>
1.104 sevan 561: <li class="listitem"><p>Tracking of package dependencies automatically, including when
562: performing updates, to ensure required packages are installed. The
563: configuration files of various packages are handled automatically during
564: updates, so local changes are preserved.</p></li>
1.23 wiz 565: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 566: consists of highly portable code. This allows the greatest speed of
1.25 spz 567: development when porting to a new platform. This portability also
1.1 dsieger 568: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
569: platforms</em></span>.</p></li>
1.23 wiz 570: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 571: international encryption requirements and build-time options for a
572: large number of packages are all set in a simple, central
573: configuration file.</p></li>
1.23 wiz 574: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 575: freely available under a BSD license, so you may extend and adapt
576: pkgsrc to your needs. Support for local packages and patches is
577: available right out of the box, so you can configure it specifically
578: for your environment.</p></li>
579: </ul></div>
580: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 581: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 582: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 583: — That means, if a package contains bugs, it's better to find
1.1 dsieger 584: them and to complain about them rather than to just install the package
585: and hope that it works. There are numerous checks in pkgsrc that try to
1.207 leot 586: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1 dsieger 587: of shell scripts), and post-installation checks (installed files,
588: references to shared libraries, script interpreters).</p></li>
1.23 wiz 589: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 590: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 591: pkgsrc has been ported to many operating systems. Care is taken that
592: packages behave the same on all platforms.</p></li>
593: </ul></div>
594: </div>
1.41 asau 595: <div class="sect2">
1.1 dsieger 596: <div class="titlepage"><div><div><h3 class="title">
597: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
598: <p>pkgsrc consists of both a source distribution and a binary
599: distribution for these operating systems. After retrieving the required
600: source or binaries, you can be up and running with pkgsrc in just
601: minutes!</p>
602: <p>pkgsrc was derived from FreeBSD's ports system, and
603: initially developed for NetBSD only. Since then, pkgsrc has
604: grown a lot, and now supports the following platforms:</p>
605: <div class="table">
606: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 607: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 608: <colgroup>
609: <col>
610: <col>
1.92 sevan 611: <col>
1.1 dsieger 612: </colgroup>
613: <thead><tr>
614: <th>Platform</th>
615: <th>Date Support Added</th>
1.92 sevan 616: <th>Notes</th>
1.1 dsieger 617: </tr></thead>
618: <tbody>
619: <tr>
1.174 leot 620: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 621: <td align="center">Aug 1997</td>
1.92 sevan 622: <td class="auto-generated"> </td>
1.1 dsieger 623: </tr>
624: <tr>
1.10 hubertf 625: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 626: <td align="center">Mar 1999</td>
1.151 sevan 627: <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 628: </tr>
629: <tr>
1.174 leot 630: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 631: <td align="center">Jun 1999</td>
1.151 sevan 632: <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 633: </tr>
634: <tr>
635: <td>
1.118 sevan 636: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 637: </td>
638: <td align="center">Oct 2001</td>
1.191 bacon 639: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.1 dsieger 640: </tr>
641: <tr>
1.174 leot 642: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 643: <td align="center">Nov 2002</td>
1.151 sevan 644: <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 645: </tr>
646: <tr>
1.174 leot 647: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 648: <td align="center">Nov 2002</td>
1.151 sevan 649: <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 650: </tr>
651: <tr>
1.174 leot 652: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 653: <td align="center">Dec 2002</td>
1.92 sevan 654: <td>
1.151 sevan 655: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.92 sevan 656: </td>
1.1 dsieger 657: </tr>
658: <tr>
659: <td>BSD/OS</td>
660: <td align="center">Dec 2003</td>
1.92 sevan 661: <td class="auto-generated"> </td>
1.1 dsieger 662: </tr>
663: <tr>
1.174 leot 664: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 665: <td align="center">Dec 2003</td>
1.151 sevan 666: <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 667: </tr>
668: <tr>
669: <td>
1.174 leot 670: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 671: (Microsoft Windows Services for Unix)
672: </td>
673: <td align="center">Mar 2004</td>
1.151 sevan 674: <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 675: </tr>
676: <tr>
1.174 leot 677: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 678: <td align="center">Oct 2004</td>
1.92 sevan 679: <td class="auto-generated"> </td>
1.1 dsieger 680: </tr>
681: <tr>
1.10 hubertf 682: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 683: <td align="center">Nov 2004</td>
1.151 sevan 684: <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 685: </tr>
686: <tr>
1.174 leot 687: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 688: <td align="center">Apr 2007</td>
1.151 sevan 689: <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 690: </tr>
1.23 wiz 691: <tr>
1.174 leot 692: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23 wiz 693: <td align="center">Sep 2010</td>
1.151 sevan 694: <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 695: </tr>
1.45 obache 696: <tr>
1.174 leot 697: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 698: <td align="center">Jan 2011</td>
1.92 sevan 699: <td class="auto-generated"> </td>
1.45 obache 700: </tr>
701: <tr>
1.174 leot 702: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45 obache 703: <td align="center">Nov 2011</td>
1.151 sevan 704: <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 705: </tr>
706: <tr>
1.174 leot 707: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45 obache 708: <td align="center">Mar 2013</td>
1.151 sevan 709: <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 710: </tr>
1.58 ryoon 711: <tr>
1.174 leot 712: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58 ryoon 713: <td align="center">Jul 2013</td>
1.151 sevan 714: <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 715: </tr>
1.104 sevan 716: <tr>
1.174 leot 717: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104 sevan 718: <td align="center">Jun 2014</td>
1.229 gutterid 719: <td>Removed from pkgsrc Sep 2022</td>
1.104 sevan 720: </tr>
1.1 dsieger 721: </tbody>
722: </table></div>
723: </div>
724: <br class="table-break">
725: </div>
726: </div>
1.41 asau 727: <div class="sect1">
1.1 dsieger 728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
729: <a name="overview"></a>1.2. Overview</h2></div></div></div>
730: <p>This document is divided into three parts. The first,
1.10 hubertf 731: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 732: describes how one can use one of the packages in the Package
733: Collection, either by installing a precompiled binary package,
734: or by building one's own copy using the NetBSD package system.
1.10 hubertf 735: 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 736: package so it can be easily built by other NetBSD users without
737: knowing about the package's building details. The third part,
1.10 hubertf 738: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 739: is intended for those who want to understand how pkgsrc is
740: implemented.</p>
741: <p>This document is available in various formats:
1.10 hubertf 742: <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 743: </div>
1.41 asau 744: <div class="sect1">
1.1 dsieger 745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
746: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 747: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
748: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 749: terminology used within this document.</p>
1.41 asau 750: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 751: <dt><span class="term">Package</span></dt>
752: <dd><p>A set of files and building instructions
753: that describe what's necessary
754: to build a certain piece of software using
755: pkgsrc. Packages are traditionally stored under
1.123 wiz 756: <code class="filename">/usr/pkgsrc</code>,
757: but may be stored in any location,
758: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 759: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 760: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 761: is part of the NetBSD operating system and can be bootstrapped
762: to run on non-NetBSD operating systems as well. It handles
763: building (compiling), installing, and removing of
764: packages.</p></dd>
765: <dt><span class="term">Distfile</span></dt>
766: <dd><p>This term describes the file or files that are
767: provided by the author of the piece of software to
768: distribute his work. All the changes necessary to build on
769: NetBSD are reflected in the corresponding package. Usually
770: the distfile is in the form of a compressed tar-archive,
771: but other types are possible, too. Distfiles are usually
772: stored below
773: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
774: <dt><span class="term">Port</span></dt>
775: <dd><p>This is the term used by FreeBSD and OpenBSD people
776: for what we call a package.
1.23 wiz 777: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 778: architecture.</p></dd>
779: <dt><span class="term">Precompiled/binary package</span></dt>
780: <dd>
781: <p>A set of binaries built with pkgsrc from a distfile
782: and stuffed together in a single <code class="filename">.tgz</code>
783: file so it can be installed on machines of the same
784: machine architecture without the need to
785: recompile. Packages are usually generated in
786: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 787: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 788: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 789: especially in the context of precompiled packages.</p>
790: </dd>
791: <dt><span class="term">Program</span></dt>
792: <dd><p>The piece of software to be installed which will be
793: constructed from all the files in the distfile by the
794: actions defined in the corresponding package.</p></dd>
795: </dl></div>
1.41 asau 796: <div class="sect2">
1.1 dsieger 797: <div class="titlepage"><div><div><h3 class="title">
798: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 799: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 800: <dt><span class="term">pkgsrc users</span></dt>
801: <dd>
802: <p>The
803: pkgsrc users are people who use the packages provided by pkgsrc.
804: Typically they are system administrators. The people using the
1.23 wiz 805: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
806: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 807: <p>There are two kinds of pkgsrc users: Some only want to
808: install pre-built binary packages. Others build the pkgsrc
809: packages from source, either for installing them directly or for
1.10 hubertf 810: 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 811: documentation.</p>
812: </dd>
813: <dt><span class="term">package maintainers</span></dt>
814: <dd><p>A
1.10 hubertf 815: 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 816: <dt><span class="term">infrastructure developers</span></dt>
817: <dd><p>These people are involved in all those files
818: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 819: 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 820: too.</p></dd>
821: </dl></div>
822: </div>
823: </div>
1.41 asau 824: <div class="sect1">
1.1 dsieger 825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
826: <a name="typography"></a>1.4. Typography</h2></div></div></div>
827: <p>When giving examples for commands, shell prompts are used to
828: show if the command should/can be issued as root, or if
1.23 wiz 829: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 830: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
831: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.229 gutterid 832: Bourne shell and derivatives.</p>
1.1 dsieger 833: </div>
834: </div>
1.41 asau 835: <div class="part">
1.1 dsieger 836: <div class="titlepage"><div><div><h1 class="title">
837: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
838: <div class="toc">
839: <p><b>Table of Contents</b></p>
1.100 leot 840: <dl class="toc">
1.154 rillig 841: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
842: <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 843: <dd><dl>
1.154 rillig 844: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 845: <dd><dl>
1.154 rillig 846: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
847: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 848: </dl></dd>
1.154 rillig 849: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 850: <dd><dl>
1.154 rillig 851: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
852: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 853: </dl></dd>
854: </dl></dd>
1.154 rillig 855: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 856: <dd><dl>
1.154 rillig 857: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
858: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 859: </dl></dd>
1.154 rillig 860: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 861: <dd><dl>
1.154 rillig 862: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 863: <dd><dl>
1.154 rillig 864: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
865: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 866: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
867: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
868: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
869: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
870: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
871: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 872: </dl></dd>
1.154 rillig 873: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 874: <dd><dl>
1.154 rillig 875: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
876: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
877: <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 878: </dl></dd>
879: </dl></dd>
1.154 rillig 880: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 881: <dd><dl>
1.154 rillig 882: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
883: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 884: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
885: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
886: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
887: <dd><dl>
888: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
889: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
890: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 891: </dl></dd>
1.241 rillig 892: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
893: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 894: </dl></dd>
1.154 rillig 895: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 896: <dd><dl>
1.154 rillig 897: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
898: <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 899: </dl></dd>
1.154 rillig 900: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 901: builds)</a></span></dt>
1.1 dsieger 902: <dd><dl>
1.154 rillig 903: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 904: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 905: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
906: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 907: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
908: <dd><dl>
1.179 rillig 909: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
910: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181 rillig 911: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
912: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
913: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
914: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
915: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
916: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
917: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
918: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 919: </dl></dd>
920: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
921: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 922: </dl></dd>
923: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
924: <dd><dl>
925: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
926: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
927: </dl></dd>
928: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
929: <dd><dl>
930: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
931: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
932: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
933: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
934: <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>
935: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
936: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
937: <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>
938: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
939: <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 940: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 941: <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>
1.221 nia 942: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 943: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
944: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
945: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
946: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
947: <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 948: </dl></dd>
949: </dl>
950: </div>
1.41 asau 951: <div class="chapter">
1.1 dsieger 952: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 953: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
954: <p>
955: To get help when using pkgsrc, the definitive source is this
956: document, the pkgsrc guide. If you don't find anything here,
957: there are alternatives:
958: </p>
959: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
960: <li class="listitem">
961: <p>
962: The built-in pkgsrc help, which is available after bootstrapping
963: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
964: help for any topic, such as a variable name like
965: <code class="varname">BUILD_DEFS</code>, a make target like
966: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
967: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207 leot 968: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.154 rillig 969: </li>
970: <li class="listitem"><p>
1.163 rillig 971: To see the value of a single variable, run <span class="command"><strong>bmake
972: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
973: </p></li>
974: <li class="listitem"><p>
975: To see the values of the most common variables, run
976: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
977: topic. To see the variables for a single topic, run
978: <span class="command"><strong>bmake
979: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
980: <span class="command"><strong>bmake show-all-fetch</strong></span>.
981: </p></li>
982: <li class="listitem"><p>
1.154 rillig 983: The pkgsrc-users mailing list, to which
984: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
985: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
986: questions</a>.</p></li>
987: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
988: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
989: or by using a specialized chat program such as
990: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
991: Pick any user name and join the channel #pkgsrc.</p></li>
992: </ul></div>
993: </div>
994: <div class="chapter">
995: <div class="titlepage"><div><div><h2 class="title">
996: <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 997: <div class="toc">
998: <p><b>Table of Contents</b></p>
1.100 leot 999: <dl class="toc">
1.154 rillig 1000: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 1001: <dd><dl>
1.154 rillig 1002: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1003: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 1004: </dl></dd>
1.154 rillig 1005: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 1006: <dd><dl>
1.154 rillig 1007: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1008: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 1009: </dl></dd>
1010: </dl>
1011: </div>
1012: <p>Before you download and extract the files, you need to decide
1013: where you want to extract them. When using pkgsrc as root user, pkgsrc
1014: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1015: free to install the sources and binary packages wherever you want in
1016: your filesystem, provided that the pathname does not contain white-space
1017: or other characters that are interpreted specially by the shell and some
1018: other programs. A safe bet is to use only letters, digits, underscores
1019: and dashes.</p>
1.41 asau 1020: <div class="sect1">
1.1 dsieger 1021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1022: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 1023: <p>Before you download any pkgsrc files, you should decide
1024: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1025: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1026: quarterly basis from the current branch and only gets modified
1027: for security updates. The names of the stable branches are built
1028: from the year and the quarter, for example
1.214 leot 1029: <code class="literal">2021Q4</code>.</p>
1.1 dsieger 1030: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 1031: want to download pkgsrc. You can get it as a tar file or via CVS.
1032: Both ways are described here.</p>
1.51 asau 1033: <p>Note that tar archive contains CVS working copy.
1034: Thus you can switch to using CVS at any later time.</p>
1.41 asau 1035: <div class="sect2">
1.1 dsieger 1036: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1037: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 1038: <p>The primary download location for all pkgsrc files is
1.151 sevan 1039: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 1040: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1041: (it points to the same location).
1042: There are a number of subdirectories for different purposes,
1.207 leot 1043: which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix D. Directory layout of the pkgsrc FTP server">Appendix D, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.51 asau 1044: <p>The tar archive for the current branch is in the directory
1.151 sevan 1045: <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 1046: It is autogenerated weekly.</p>
1.51 asau 1047: <p>To save download time we provide bzip2- and
1048: xz-compressed archives which are published at
1.151 sevan 1049: <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 1050: and
1.151 sevan 1051: <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 1052: respectively.
1053: </p>
1054: <p>You can fetch the same files using FTP.</p>
1.214 leot 1055: <p>The tar file for the stable branch 2021Q4 is in the
1056: directory <code class="filename">pkgsrc-2021Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136 leot 1057: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1058: <pre class="screen">
1.214 leot 1059: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q4/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 1060: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1061: or your web browser.</p>
1.12 weinem 1062: <p>Then, extract it with:</p>
1.78 snj 1063: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1064: <p>This will create the directory <code class="filename">pkgsrc/</code>
1065: in <code class="filename">/usr/</code> and all the package source will be
1066: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1067: <p>To download pkgsrc-current, run:</p>
1068: <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 1069: </div>
1.41 asau 1070: <div class="sect2">
1.1 dsieger 1071: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1072: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1073: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.214 leot 1074: <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-2021Q4 -P pkgsrc</code></strong>
1.23 wiz 1075: </pre>
1076: <p>This will create the directory <code class="filename">pkgsrc/</code>
1077: in your <code class="filename">/usr/</code> directory and all the package source
1078: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1079: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1080: <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 1081: </pre>
1.174 leot 1082: <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 1083: <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 1084: <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 1085: </pre>
1086: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1087: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1088: or better globally in <code class="filename">/etc/profile</code>:</p>
1089: <pre class="programlisting">
1090: # set CVS remote shell command
1091: CVS_RSH=ssh
1092: export CVS_RSH
1093: </pre>
1094: <p>By default, CVS doesn't do things like most people would expect it to do.
1095: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1096: in your home directory and saving the following lines to it.
1097: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1098: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1099: <pre class="programlisting">
1100: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1101: cvs -q
1.2 rillig 1102: checkout -P
1.4 rillig 1103: update -dP
1104: diff -upN
1.2 rillig 1105: rdiff -u
1.23 wiz 1106: release -d
1.2 rillig 1107: </pre>
1.1 dsieger 1108: </div>
1109: </div>
1.41 asau 1110: <div class="sect1">
1.1 dsieger 1111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1112: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1113: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1114: (which also works if you have first installed it via a tar
1115: file). It saves bandwidth and hard disk activity, compared to
1116: downloading the tar file again.</p>
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-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1120: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1121: <h3 class="title">Warning</h3>
1122: <p>When updating from a tar file, you first need to
1123: completely remove the old pkgsrc directory. Otherwise those
1124: files that have been removed from pkgsrc in the mean time will
1125: not be removed on your local disk, resulting in inconsistencies.
1126: When removing the old files, any changes that you have done to
1127: the pkgsrc files will be lost after updating. Therefore updating
1128: via CVS is strongly recommended.</p>
1129: </div>
1130: <p>Note that by default the distfiles and the binary packages
1131: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1132: before updating. You can also configure pkgsrc to store distfiles
1133: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1134: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1135: 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 1136: <p>To update pkgsrc from a tar file, download the tar file as
1137: explained above. Then, make sure that you have not made any
1138: changes to the files in the pkgsrc directory. Remove the pkgsrc
1139: directory and extract the new tar file. Done.</p>
1140: </div>
1.41 asau 1141: <div class="sect2">
1.1 dsieger 1142: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1143: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1144: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1145: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1146: </pre>
1147: <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>
1148: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1149: </pre>
1.41 asau 1150: <div class="sect3">
1.1 dsieger 1151: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1152: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1153: <p>When updating pkgsrc, the CVS program keeps track of the
1154: branch you selected. But if you, for whatever reason, want to
1155: switch from the stable branch to the current one, you can do it
1.23 wiz 1156: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1157: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1158: back to the stable branch, add the
1.214 leot 1159: <span class="quote">“<span class="quote">-rpkgsrc-2021Q4</span>”</span> option.</p>
1.1 dsieger 1160: </div>
1.41 asau 1161: <div class="sect3">
1.1 dsieger 1162: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1163: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1164: <p>When you update pkgsrc, the CVS program will only touch
1165: those files that are registered in the CVS repository. That
1166: means that any packages that you created on your own will stay
1167: unmodified. If you change files that are managed by CVS, later
1168: updates will try to merge your changes with those that have been
1169: done by others. See the CVS manual, chapter
1.23 wiz 1170: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1171: </div>
1172: </div>
1173: </div>
1174: </div>
1.41 asau 1175: <div class="chapter">
1.1 dsieger 1176: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1177: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1178: <div class="toc">
1179: <p><b>Table of Contents</b></p>
1.100 leot 1180: <dl class="toc">
1.154 rillig 1181: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1182: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1183: </dl>
1184: </div>
1.41 asau 1185: <div class="sect1">
1.1 dsieger 1186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1187: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1188: <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 1189: </div>
1.41 asau 1190: <div class="sect1">
1.1 dsieger 1191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1192: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1193: <p>pkgsrc can be bootstrapped for use in two different modes:
1194: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1195: to privileged one all programs are installed under one particular user
1.43 asau 1196: and cannot utilise privileged operations (packages don't create
1197: special users and all special file permissions like setuid are ignored).
1198: </p>
1.1 dsieger 1199: <p>Installing the bootstrap kit from source should be as simple as:</p>
1200: <pre class="screen">
1.60 asau 1201: <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 1202: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1203: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1204: </pre>
1.43 asau 1205: <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>
1206: <p>By default, in privileged mode pkgsrc uses
1207: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1208: where programs will be installed in,
1.118 sevan 1209: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1210: directory where pkgsrc will do its internal bookkeeping,
1211: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1212: where packages install their persistent data.
1213: In unprivileged mode pkgsrc uses
1214: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1215: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1216: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1217: </p>
1218: <p>You can change default layout using command-line arguments.
1219: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1220: </p>
1.41 asau 1221: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1222: <h3 class="title">Note</h3>
1.10 hubertf 1223: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1224: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1225: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1226: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1227: </div>
1.43 asau 1228: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1229: <h3 class="title">Note</h3>
1230: <p>It is possible to bootstrap multiple instances of pkgsrc
1231: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1232: corresponding to the installation you're working with to build
1233: and install packages.
1234: </p>
1235: </div>
1.1 dsieger 1236: </div>
1237: </div>
1.41 asau 1238: <div class="chapter">
1.1 dsieger 1239: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1240: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1241: <div class="toc">
1242: <p><b>Table of Contents</b></p>
1.100 leot 1243: <dl class="toc">
1.154 rillig 1244: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1245: <dd><dl>
1.154 rillig 1246: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1247: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 1248: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1249: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1250: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1251: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1252: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1253: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.154 rillig 1254: </dl></dd>
1255: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1256: <dd><dl>
1257: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1258: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1259: <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 1260: </dl></dd>
1261: </dl>
1262: </div>
1263: <p>Basically, there are two ways of using pkgsrc. The first
1264: is to only install the package tools and to use binary packages
1.23 wiz 1265: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1266: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1267: of pkgsrc, too. Then you are able to build your own packages,
1268: and you can still use binary packages from someone else.</p>
1.41 asau 1269: <div class="sect1">
1.1 dsieger 1270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1271: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.202 nia 1272: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151 sevan 1273: site and mirrors, there are collections of binary packages,
1.9 rillig 1274: ready to be installed. These binary packages have been built using the
1275: default settings for the directories, that is:</p>
1.41 asau 1276: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1277: <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>
1278: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1279: <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 1280: </ul></div>
1281: <p>If you cannot use these directories for whatever reasons (maybe
1282: because you're not root), you cannot use these binary packages, but
1.154 rillig 1283: 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 1284: <div class="sect2">
1.1 dsieger 1285: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1286: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1287: <p>To install binary packages, you first need to know from where
1288: to get them. The first place where you should look is on the main
1.202 nia 1289: pkgsrc CDN in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1290: <p>This directory contains binary packages for multiple
1.226 gutterid 1291: platforms. First, select your operating system. Then, select your
1292: hardware architecture, and in the third step, the OS version and
1293: the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1294: <p>In this directory, you may find a file called
1.9 rillig 1295: <code class="filename">bootstrap.tar.gz</code> which contains the package
1296: management tools. If the file is missing, it is likely that your
1297: operating system already provides those tools. Download the file and
1298: extract it in the <code class="filename">/</code> directory. It will create
1299: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1300: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1301: </div>
1.41 asau 1302: <div class="sect2">
1.1 dsieger 1303: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1304: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1305: <p>In the directory from the last section, there is a
1.85 wiz 1306: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1307: binary packages that are available for the platform, excluding those
1.202 nia 1308: that may not be distributed via HTTP or FTP.</p>
1.9 rillig 1309: <p>To install packages directly from an FTP or HTTP server, run
1310: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1311: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1312: <pre class="screen">
1.202 nia 1313: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1314: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169 rillig 1315: <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 1316: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.202 nia 1317: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.9 rillig 1318: </pre>
1319: <p>Instead of URLs, you can also use local paths, for example if
1320: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1321: repository. If you want to install packages from multiple sources,
1322: you can separate them by a semicolon in
1323: <code class="varname">PKG_PATH</code>.</p>
1324: <p>After these preparations, installing a package is very
1325: easy:</p>
1326: <pre class="screen">
1.202 nia 1327: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1328: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1329: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1330: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1331: </pre>
1332: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1333: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1334: <p>Any prerequisite packages needed to run the
1.1 dsieger 1335: package in question will be installed, too, assuming they are
1.202 nia 1336: present in the repository.</p>
1.1 dsieger 1337: <p>After you've installed packages, be sure to have
1338: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1339: <code class="varname">PATH</code> so you can actually start the just
1340: installed program.</p>
1341: </div>
1.41 asau 1342: <div class="sect2">
1.1 dsieger 1343: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1344: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1345: <p>To update binary packages, it is recommended that you use
1346: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1347: package repository to your locally installed packages and safely
1348: replace any older packages.</p>
1349: <p>Note that pkgsrc is released as quarterly branches.
1350: If you are updating to a newer quarterly branch of pkgsrc, you may
1351: need to adjust the repository in
1352: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1353: </div>
1354: <div class="sect2">
1355: <div class="titlepage"><div><div><h3 class="title">
1356: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1357: <p>To deinstall a package, it does not matter whether it was
1.202 nia 1358: installed from source code or from a binary package. Neither the
1359: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1360: command need to know.</p>
1361: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.1 dsieger 1362: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.202 nia 1363: name can be given with or without version number.</p>
1.1 dsieger 1364: </div>
1.41 asau 1365: <div class="sect2">
1.1 dsieger 1366: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1367: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1368: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.202 nia 1369: installed packages or binary package files.
1370: As with other management tools, it works with packages installed
1371: from source or binaries.</p>
1.1 dsieger 1372: </div>
1.41 asau 1373: <div class="sect2">
1.1 dsieger 1374: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1375: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1376: <p>
1.164 leot 1377: The pkgsrc Security Team and Packages Groups maintain a list of
1.202 nia 1378: known vulnerabilities to packages which are (or have been)
1.1 dsieger 1379: included in pkgsrc. The list is available from the NetBSD
1.202 nia 1380: CDN at <a class="ulink" href="https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1381: </p>
1382: <p>
1383: Please note that not every "vulnerability" with a CVE assignment is
1384: exploitable in every configuration.
1385: Some bugs are marked as active simply because an fix was not
1386: marked as such.
1387: Operating system specific hardening and mitigation features may also
1388: reduce the impact of bugs.
1.1 dsieger 1389: </p>
1390: <p>
1.22 jakllsch 1391: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1392: this list can be downloaded
1393: automatically, and a security audit of all packages installed on a system
1394: can take place.
1395: </p>
1396: <p>
1.22 jakllsch 1397: There are two components to auditing. The first
1398: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1399: is for downloading
1.1 dsieger 1400: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1401: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1402: installed packages are vulnerable. If a package is vulnerable, you
1403: will see output similar to the following:
1404: </p>
1405: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1406: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1 dsieger 1407: <p>
1.22 jakllsch 1408: You may wish to have the
1.202 nia 1409: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1410: file downloaded daily so that
1411: it remains current. This may be done by adding an appropriate entry
1.207 leot 1412: to the root users <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1413: </p>
1414: <pre class="screen">
1.121 sevan 1415: # Download vulnerabilities file
1.118 sevan 1416: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1417: # Audit the installed packages and email results to root
1418: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1419: root >/dev/null 2>&1
1.22 jakllsch 1420: </pre>
1421: <p>
1.118 sevan 1422: will update the vulnerability list every day at 3AM, followed by an audit
1423: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1424:
1.118 sevan 1425: On NetBSD this may be accomplished instead by adding the following
1426: line to <code class="filename">/etc/daily.conf</code>:
1427: </p>
1428: <pre class="screen">
1429: fetch_pkg_vulnerabilities=YES
1430: </pre>
1431: <p>
1432: to fetch the vulnerability list from the daily security script. The system
1433: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1434: desired (not required), by adding the following line to
1.118 sevan 1435: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1436: </p>
1437: <pre class="screen">
1.118 sevan 1438: check_pkg_vulnerabilities=YES
1.22 jakllsch 1439: </pre>
1440: <p>
1.207 leot 1441: see <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1 dsieger 1442: </p>
1443: </div>
1.41 asau 1444: <div class="sect2">
1.1 dsieger 1445: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1446: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.1 dsieger 1447: <p>
1.207 leot 1448: Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1449: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.202 nia 1450: argument to check if any packages are stale, e.g.
1.1 dsieger 1451: </p>
1452: <pre class="screen">
1453: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1454: ...
1455: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1456: </pre>
1457: </div>
1.41 asau 1458: <div class="sect2">
1.1 dsieger 1459: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1460: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.10 hubertf 1461: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1462: administrative functions on the package system.</p>
1463: </div>
1464: </div>
1.41 asau 1465: <div class="sect1">
1.1 dsieger 1466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1467: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1468: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1469: directory now contains a set of packages, organized into
1470: categories. You can browse the online index of packages, or run
1.10 hubertf 1471: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1472: directory to build local <code class="filename">README.html</code> files for
1.207 leot 1473: all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/index.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1 dsieger 1474: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1475: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1476: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1477: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1478: different <code class="varname">LOCALBASE</code> definitions on the same
1479: system (inside a chroot is an exception). </p>
1480: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1481: 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 1482: instructions how to create your own packages.</p>
1.41 asau 1483: <div class="sect2">
1.1 dsieger 1484: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1485: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1486: <p>To build packages from source, you need a working C
1487: compiler. On NetBSD, you need to install the
1.23 wiz 1488: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1489: sets. If you want to build X11-related packages, the
1.23 wiz 1490: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1491: sets are required, too.</p>
1492: </div>
1.41 asau 1493: <div class="sect2">
1.1 dsieger 1494: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1495: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1496: <p>The first step for building a package is downloading the
1497: distfiles (i.e. the unmodified source). If they have not yet been
1498: downloaded, pkgsrc will fetch them automatically.</p>
1499: <p>If you have all files that you need in the
1500: <code class="filename">distfiles</code> directory,
1501: you don't need to connect. If the distfiles are on CD-ROM, you can
1502: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1503: </p>
1504: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1505: <p>
1.10 hubertf 1506: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1507: <p>By default a list of distribution sites will be randomly
1508: intermixed to prevent huge load on servers which holding popular
1509: packages (for example, SourceForge.net mirrors). Thus, every
1510: time when you need to fetch yet another distfile all the mirrors
1511: will be tried in new (random) order. You can turn this feature
1512: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1513: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1514: <p>You can overwrite some of the major distribution sites to
1515: fit to sites that are close to your own. By setting one or two
1516: variables you can modify the order in which the master sites are
1517: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1518: delimited list of domain suffixes.
1519: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1520: contains a whitespace delimited list of regular expressions. It
1521: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1522: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1523: some examples. This may save some of your bandwidth and
1524: time.</p>
1525: <p>You can change these settings either in your shell's environment, or,
1526: if you want to keep the settings, by editing the
1.10 hubertf 1527: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1528: and adding the definitions there.</p>
1529: <p>
1530: If a package depends on many other packages (such as
1.207 leot 1531: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/index.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.1 dsieger 1532: alternate between periods of
1533: downloading source, and compiling. To ensure you have all the source
1534: downloaded initially you can run the command:
1535: </p>
1536: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1537: <p>
1538: which will output and run a set of shell commands to fetch the
1539: necessary files into the <code class="filename">distfiles</code> directory. You can
1540: also choose to download the files manually.
1541: </p>
1542: </div>
1.41 asau 1543: <div class="sect2">
1.1 dsieger 1544: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1545: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1546: <p>
1547: Once the software has downloaded, any patches will be applied, then it
1548: will be compiled for you. This may take some time depending on your
1549: computer, and how many other packages the software depends on and their
1550: compile time.
1551: </p>
1.41 asau 1552: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1553: <h3 class="title">Note</h3>
1554: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1555: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1556: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1557: </div>
1558: <p>For example, type</p>
1559: <pre class="screen">
1560: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1561: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1562: </pre>
1563: <p>at the shell prompt to build the various components of the
1564: package.</p>
1565: <p>The next stage is to actually install the newly compiled
1566: program onto your system. Do this by entering:
1567:
1568: </p>
1569: <pre class="screen">
1570: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1571: </pre>
1572: <p>
1573:
1574: while you are still in the directory for whatever package you
1575: are installing.</p>
1576: <p>Installing the package on your system may require you to
1577: be root. However, pkgsrc has a
1578: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1579: to only become root for the actual installation step.</p>
1580: <p>That's it, the software should now be installed and setup for use.
1581: You can now enter:
1582:
1583: </p>
1584: <pre class="screen">
1585: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1586: </pre>
1587: <p>
1588:
1589: to remove the compiled files in the work directory, as you shouldn't need
1590: them any more. If other packages were also added to your system
1591: (dependencies) to allow your program to compile, you can tidy these up
1592: also with the command:</p>
1593: <pre class="screen">
1594: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1595: </pre>
1596: <p>Taking the figlet utility as an example, we can install it on our
1.207 leot 1597: system by building as shown in <a class="xref" href="#logs" title="Appendix C. Build logs">Appendix C, <i>Build logs</i></a>.</p>
1.1 dsieger 1598: <p>The program is installed under the default root of the
1599: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1600: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1601: variable in your environment, and it will use that value as the
1602: root of your packages tree. So, to use
1603: <code class="filename">/usr/local</code>, set
1604: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1605: Please note that you should use a directory which is dedicated to
1606: packages and not shared with other programs (i.e., do not try and
1607: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1608: to add any of your own files or directories (such as
1609: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1610: <code class="filename">pkgsrc/</code>) below the
1611: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1612: conflicts between programs and other files installed by the
1613: package system and whatever else may have been installed
1614: there.</p>
1.10 hubertf 1615: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1616: alter some configuration options at build time. Have a look at
1617: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1618: of what will be set there by default. Environment variables such
1619: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1620: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1621: set them each time you want to use pkgsrc.</p>
1.23 wiz 1622: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1623: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1624: or being installed. This may be for debugging purposes, or out of
1625: simple curiosity. A number of utility values have been added to
1626: help with this.</p>
1.23 wiz 1627: <div class="orderedlist"><ol class="orderedlist" type="1">
1628: <li class="listitem">
1.207 leot 1629: <p>If you invoke the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1630: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1631: information will be displayed. For example,</p>
1632: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1633: <p>will show all the commands that are invoked, up to and
1.23 wiz 1634: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1635: </li>
1.23 wiz 1636: <li class="listitem">
1.207 leot 1637: <p>If you want to know the value of a certain <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1638: definition, then the <code class="varname">VARNAME</code> definition
1639: should be used, in conjunction with the show-var
1.207 leot 1640: target. e.g. to show the expansion of the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1641: variable <code class="varname">LOCALBASE</code>:</p>
1642: <pre class="screen">
1643: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1644: /usr/pkg
1645: <code class="prompt">%</code>
1646: </pre>
1647: </li>
1648: </ol></div>
1649: <p>If you want to install a binary package that you've either
1650: created yourself (see next section), that you put into
1651: pkgsrc/packages manually or that is located on a remote FTP
1652: server, you can use the "bin-install" target. This target will
1.207 leot 1653: install a binary package - if available - via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 1654: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1655: sites searched is kept in the variable
1656: <code class="varname">BINPKG_SITES</code>, which defaults to
1.207 leot 1657: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 1658: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1659: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1660: details.</p>
1661: <p>A final word of warning: If you set up a system that has a
1662: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1663: set that before any packages are installed, as you cannot use
1664: several directories for the same purpose. Doing so will result in
1665: pkgsrc not being able to properly detect your installed packages,
1666: and fail miserably. Note also that precompiled binary packages are
1667: usually built with the default <code class="varname">LOCALBASE</code> of
1668: <code class="filename">/usr/pkg</code>, and that you should
1669: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1670: <code class="varname">LOCALBASE</code>.</p>
1671: </div>
1672: </div>
1673: </div>
1.41 asau 1674: <div class="chapter">
1.1 dsieger 1675: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1676: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1677: <div class="toc">
1678: <p><b>Table of Contents</b></p>
1.100 leot 1679: <dl class="toc">
1.154 rillig 1680: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1681: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 1682: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
1683: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
1684: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
1685: <dd><dl>
1686: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
1687: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1688: <dt><span class="sect2"><a href="#conf.ldflags">6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 1689: </dl></dd>
1.241 rillig 1690: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
1691: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 1692: </dl>
1693: </div>
1.4 rillig 1694: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1695: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1696: that file depends on the installation. On NetBSD, when you use
1.207 leot 1697: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 1698: <code class="filename">/etc/</code>. In all other cases the default location is
1699: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1700: bootstrap program to install the binary packages.</p>
1701: <p>The format of the configuration file is that of the usual
1702: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1703: is done by setting variables in this file. Note that you can define all
1704: kinds of variables, and no special error checking (for example for
1.112 rillig 1705: spelling mistakes) takes place.</p>
1.41 asau 1706: <div class="sect1">
1.1 dsieger 1707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1708: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1709: <p>The following variables apply to all
1.1 dsieger 1710: pkgsrc packages. A complete list of the variables that can be
1711: configured by the user is available in
1712: <code class="filename">mk/defaults/mk.conf</code>, together with some
1713: comments that describe each variable's intent.</p>
1.41 asau 1714: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1715: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1716: packages will be installed. The default is
1717: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1718: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1719: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1720: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1721: installed. The default is
1722: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1723: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1724: X11 is installed on the system. The default is
1.84 wiz 1725: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1726: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1727: downloaded copies of the original source distributions used
1728: for building pkgsrc packages. The default is
1729: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1730: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1731: database about installed packages is stored. The default is
1.118 sevan 1732: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1733: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1734: If set, override the packages'
1735: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1736: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1737: Backup location(s) for distribution files and patch files
1738: if not found locally or in
1739: <code class="filename">${MASTER_SITES}</code> or
1740: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1741: The defaults is
1742: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1743: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1744: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1745: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1746: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1747: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1748: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1749: List of acceptable licenses. License names are case-sensitive.
1750: Whenever you try to build a package whose license is not in this
1751: list, you will get an error message. If the license condition is
1752: simple enough, the error message will include specific
1753: instructions on how to change this variable.</p></li>
1.1 dsieger 1754: </ul></div>
1755: </div>
1.41 asau 1756: <div class="sect1">
1.1 dsieger 1757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1758: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1759: <p>
1.1 dsieger 1760: </p>
1.41 asau 1761: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1762: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1763: directory for the binary packages. The default is
1764: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1765: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1766: The top level directory where, if defined, the separate
1767: working directories will get created, and symbolically
1768: linked to from <code class="filename">${WRKDIR}</code> (see below).
1769: This is useful for building packages on several
1770: architectures, then <code class="filename">${PKGSRCDIR}</code>
1771: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1772: is local to every architecture. (It should be noted that
1773: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1774: — it is an internal definition which refers to the
1.1 dsieger 1775: root of the pkgsrc tree. It is possible to have many
1776: pkgsrc tree instances.)</p></li>
1.23 wiz 1777: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1778: Directory for local patches that aren't part of pkgsrc.
1.184 rillig 1779: See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more
1.1 dsieger 1780: information.</p></li>
1.23 wiz 1781: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1782: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1783: BSD-style Makefile. If this is not set,
1784: <code class="varname">MAKECONF</code> is set to
1785: <code class="filename">/dev/null</code> to avoid picking up
1786: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1787: </ul></div>
1788: </div>
1.41 asau 1789: <div class="sect1">
1.1 dsieger 1790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 1791: <a name="native-or-pkgsrc-preference"></a>6.3. Preferences for native or pkgsrc software</h2></div></div></div>
1792: <p>Whenever a package depends on a package that has a
1793: <code class="filename">builtin.mk</code> file, the dependent package can
1794: either use the built-in (native) version from the base system or the
1795: pkgsrc-provided version. This only affects dependencies, so it is
1796: still possible to build the pkgsrc package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pcre++/index.html" target="_top"><code class="filename">devel/pcre++</code></a> even when other packages depend
1797: on the native pcre++ version instead.</p>
1798: <p>To force using the pkgsrc-provided version for a particular
1799: package, define <span class="quote">“<span class="quote"><code class="varname">PREFER_PKGSRC</code> =
1800: <em class="replaceable"><code>package-ID</code></em></span>”</span> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. To force
1801: using the native package, define
1802: <span class="quote">“<span class="quote"><code class="varname">PREFER_NATIVE</code> =
1803: <em class="replaceable"><code>package-ID</code></em></span>”</span>. In both cases, the
1804: <em class="replaceable"><code>package-ID</code></em> is the one from the
1805: <code class="filename">buildlink3.mk</code> of the package. In most cases,
1806: this ID is the same as the directory name of the package, but for
1807: example, <code class="filename">devel/pcre++</code> has the
1808: package ID <span class="quote">“<span class="quote">pcrexx</span>”</span>.</p>
1809: <p>For the packages that are not listed by their package ID,
1810: pkgsrc uses the pkgsrc-provided version if
1811: <code class="varname">PREFER_PKGSRC</code> contains the word
1812: <span class="quote">“<span class="quote">yes</span>”</span>. Otherwise, if <code class="varname">PREFER_NATIVE</code>
1813: contains the word <span class="quote">“<span class="quote">yes</span>”</span>, pkgsrc uses the native
1814: version. For example, to require using the pkgsrc-provided versions
1815: for all but the most basic bits on a NetBSD system, you can
1816: set:</p>
1817: <pre class="programlisting">
1818: PREFER_PKGSRC= yes
1819: PREFER_NATIVE= getopt skey tcp_wrappers
1820: </pre>
1821: <p>A package <span class="emphasis"><em>must</em></span> have a
1822: <code class="filename">builtin.mk</code> file to be listed in
1823: <code class="varname">PREFER_NATIVE</code>, otherwise it is simply ignored in
1824: that list.</p>
1825: <p><code class="varname">PREFER_PKGSRC</code> and
1826: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap to
1827: ensure that the bootstrap process does not use inapropriate native
1828: tools as dependencies for core packages.</p>
1829: <pre class="screen">
1830: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
1831: </pre>
1832: <p>Switching between settings globally at a later date can
1833: introduce complications with dependency resolution. This is caused
1834: by packages built with the opposite preference being installed
1835: alongside each other. Hence, when changing any of these variables
1836: after bootstrap, you need to rebuild all packages depending on those
1837: whose preference has been changed. This is not trivial and should
1838: be avoided.</p>
1839: <p>When using pkgsrc on Linux systems, there is high risk of
1840: <span class="quote">“<span class="quote">leakage</span>”</span>, where programs installed by pkgsrc may
1841: inadvertently use a command or library not installed by pkgsrc, e.g.
1842: those installed by yum or apt. Such foreign dependencies may be
1843: installed, removed, or upgraded to a version incompatible with the
1844: pkgsrc package at any time, causing pkgsrc packages to subsequently
1845: malfunction. Pkgsrc cannot prevent this, as it has no control over
1846: other package managers. Another potential problem is that under
1847: Redhat Enterprise and related Linux systems, yum packages are only
1848: patched and never upgraded, so eventually they may become too
1849: outdated for use by pkgsrc. Even intentionally using foreign
1850: dependencies, not considered leakage, can lead to these problems, so
1851: it is generally discouraged. In order to minimize such problems,
1852: PREFER_PKGSRC defaults to <span class="quote">“<span class="quote">yes</span>”</span> on Linux systems. This ensures that
1853: pkgsrc is aware of any changes to dependency packages and can
1854: rebuild or upgrade the entire dependency tree as needed. This
1855: default can be overridden by setting --prefer-pkgsrc to a
1856: list of packages and --prefer-native to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1857: </div>
1858: <div class="sect1">
1859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1860: <a name="variables-affecting-installation"></a>6.4. Variables affecting the installation process</h2></div></div></div>
1.198 leot 1861: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.143 maya 1862: By default, binary packages of built packages are
1.150 leot 1863: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1864: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1865: <p>Packages have to support installation into a
1.4 rillig 1866: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1867: to be built, before the actual filesystem is touched. DESTDIR
1868: support exists in two variations:</p>
1.41 asau 1869: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1870: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1871: installation and packaging is still run as root.</p></li>
1872: <li class="listitem"><p>Full DESTDIR support can run the complete
1873: build, installation and packaging as normal user. Root
1874: privileges are only needed to add packages.</p></li>
1875: </ul></div>
1.4 rillig 1876: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1877: clean</code></strong> needs to be run as root.</p>
1.17 imil 1878: <p>Considering the <code class="filename">foo/bar</code> package,
1879: DESTDIR full support can be tested using the following commands
1880:
1881: </p>
1882: <pre class="programlisting">
1883: <code class="prompt">$</code> id
1884: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1885: <code class="prompt">$</code> mkdir $HOME/packages
1886: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1887: </pre>
1888: <p>
1889:
1890: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1891: should be needed
1892:
1893: </p>
1894: <pre class="programlisting">
1.66 asau 1895: <code class="prompt">$</code> make stage-install
1.17 imil 1896: </pre>
1897: <p>
1898:
1899: Create a package without root privileges
1900:
1901: </p>
1902: <pre class="programlisting">
1.66 asau 1903: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1904: </pre>
1905: <p>
1906:
1907: For the following command, you must be able to gain root
1.207 leot 1908: privileges using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 1909:
1910: </p>
1911: <pre class="programlisting">
1.66 asau 1912: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1913: </pre>
1914: <p>
1915:
1916: Then, as a simple user
1917:
1918: </p>
1919: <pre class="programlisting">
1920: <code class="prompt">$</code> make clean
1921: </pre>
1922: <p>
1923:
1924: </p>
1.4 rillig 1925: </div>
1.41 asau 1926: <div class="sect1">
1.4 rillig 1927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 1928: <a name="conf.compiler"></a>6.5. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1929: <div class="sect2">
1.1 dsieger 1930: <div class="titlepage"><div><div><h3 class="title">
1.241 rillig 1931: <a name="selecting-the-compiler"></a>6.5.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1932: <p>By default, pkgsrc will use GCC to build packages. This may be
1933: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1934: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1935: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1936: <dd>
1937: <p>This is a list of values specifying the chain of
1938: compilers to invoke when building packages. Valid values
1939: are:</p>
1.41 asau 1940: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1941: <li class="listitem"><p><code class="varname">ccc</code>:
1942: Compaq C Compilers (Tru64)</p></li>
1943: <li class="listitem"><p><code class="varname">ccache</code>:
1944: compiler cache (chainable)</p></li>
1945: <li class="listitem"><p><code class="varname">clang</code>:
1946: Clang C and Objective-C compiler</p></li>
1.23 wiz 1947: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1948: distributed C/C++ (chainable)</p></li>
1.66 asau 1949: <li class="listitem"><p><code class="varname">f2c</code>:
1950: Fortran 77 to C compiler (chainable)</p></li>
1951: <li class="listitem"><p><code class="varname">icc</code>:
1952: Intel C++ Compiler (Linux)</p></li>
1953: <li class="listitem"><p><code class="varname">ido</code>:
1954: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1955: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1956: GNU C/C++ Compiler</p></li>
1.66 asau 1957: <li class="listitem"><p><code class="varname">hp</code>:
1958: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1959: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1960: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1961: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1962: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1963: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1964: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1965: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1966: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1967: </ul></div>
1968: <p>The default is
1.23 wiz 1969: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1970: <code class="varname">ccache</code> and/or
1971: <code class="varname">distcc</code> with an appropriate
1972: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1973: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1974: variable should always be terminated with a value for
1975: a real compiler. Note that only one real compiler
1.23 wiz 1976: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1977: is not allowed).</p>
1978: </dd>
1979: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1980: <dd><p>This specifies the minimum version of GCC to use
1981: when building packages. If the system GCC doesn't
1982: satisfy this requirement, then pkgsrc will build and
1983: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1984: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1985: <dd><p>Specifies which version of python to use when several
1986: options are available.</p></dd>
1987: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.176 gutterid 1988: <dd><p>Specifies the Fortran compiler to use.
1989: The default is <code class="varname">gfortran</code>.</p></dd>
1.114 maya 1990: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1991: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1992: <code class="varname">gfortran</code> is used, this option specifies which
1993: version to use.</p></dd>
1.1 dsieger 1994: </dl></div>
1995: </div>
1.41 asau 1996: <div class="sect2">
1.1 dsieger 1997: <div class="titlepage"><div><div><h3 class="title">
1.241 rillig 1998: <a name="conf.cflags"></a>6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 1999: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2000: please make sure to use the <code class="literal">+=</code> operator
2001: instead of the <code class="literal">=</code> operator:</p>
2002: <pre class="programlisting">
2003: CFLAGS+= -your -flags
2004: </pre>
2005: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 2006: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2007: need to add their own flags. You may want to take a look
1.207 leot 2008: at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 2009: package if you're interested in optimization specifically
2010: for the current CPU. </p>
1.1 dsieger 2011: </div>
1.41 asau 2012: <div class="sect2">
1.1 dsieger 2013: <div class="titlepage"><div><div><h3 class="title">
1.241 rillig 2014: <a name="conf.ldflags"></a>6.5.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2015: <p>If you want to pass flags to the linker, both in the configure
2016: step and the build step, you can do this in two ways. Either set
2017: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2018: between the two is that <code class="varname">LIBS</code> will be appended to
2019: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2020: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2021: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2022: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2023: <code class="varname">CFLAGS</code>, if you do not wish to override these
2024: settings, use the <code class="literal">+=</code> operator:</p>
2025: <pre class="programlisting">
2026: LDFLAGS+= -your -linkerflags
2027: </pre>
2028: </div>
2029: </div>
1.41 asau 2030: <div class="sect1">
1.1 dsieger 2031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 2032: <a name="developer-advanced-settings"></a>6.6. Developer/advanced settings</h2></div></div></div>
1.84 wiz 2033: <p>
1.1 dsieger 2034: </p>
1.41 asau 2035: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2036: <li class="listitem">
1.1 dsieger 2037: <p><code class="varname">PKG_DEVELOPER</code>:
1.232 gutterid 2038: Run some sanity checks that package developers want:
2039: </p>
1.41 asau 2040: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2041: <li class="listitem"><p>make sure patches apply with zero
1.232 gutterid 2042: fuzz</p></li>
1.23 wiz 2043: <li class="listitem"><p>run check-shlibs to see that all
1.232 gutterid 2044: binaries will find their shared libs.</p></li>
1.1 dsieger 2045: </ul></div>
2046: </li>
1.232 gutterid 2047: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>:
2048: Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
2049: </code> values in PLIST entries.
2050: </p></li>
1.23 wiz 2051: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.232 gutterid 2052: of debugging output which is displayed whilst making and
2053: installing the package. The default value for this is 0,
2054: which will not display the commands as they are executed
2055: (normal, default, quiet operation); the value 1 will display
2056: all shell commands before their invocation, and the value 2
2057: will display both the shell commands before their invocation,
2058: as well as their actual execution progress with <span class="command"><strong>set
2059: -x</strong></span>.</p></li>
1.1 dsieger 2060: </ul></div>
2061: <p>
2062: </p>
2063: </div>
1.41 asau 2064: <div class="sect1">
1.1 dsieger 2065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 2066: <a name="selecting-build-options"></a>6.7. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2067: <p>Some packages have build time options, usually to select
2068: between different dependencies, enable optional support for big
2069: dependencies or enable experimental features.</p>
2070: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2071: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2072: show-options</strong></span>, for example:</p>
2073: <pre class="programlisting">
2074: The following options are supported by this package:
2075: ssl Enable SSL support.
2076: Exactly one of the following gecko options is required:
2077: firefox Use firefox as gecko rendering engine.
2078: mozilla Use mozilla as gecko rendering engine.
2079: At most one of the following database options may be selected:
2080: mysql Enable support for MySQL database.
2081: pgsql Enable support for PostgreSQL database.
2082:
2083: These options are enabled by default: firefox
2084: These options are currently enabled: mozilla ssl
2085: </pre>
2086: <p>The following variables can be defined in
1.10 hubertf 2087: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2088: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2089: which can be used to select or disable options for all packages
2090: that support them, and
2091: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2092: which can be used to select or disable options specifically for
2093: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2094: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2095: are disabled. A few examples:</p>
2096: <pre class="screen">
1.10 hubertf 2097: <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 2098: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2099: PKG_OPTIONS.kdebase= debug -sasl
2100: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2101: <p>It is important to note that options that were specifically
1.18 snj 2102: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2103: you do not wish to include the option. If you are unsure you can view
2104: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2105: <p>The following settings are consulted in the order given, and
2106: the last setting that selects or disables an option is
2107: used:</p>
1.23 wiz 2108: <div class="orderedlist"><ol class="orderedlist" type="1">
2109: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2110: maintainer</p></li>
1.23 wiz 2111: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2112: variables (see below)</p></li>
1.23 wiz 2113: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2114: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2115: </ol></div>
2116: <p>For groups of mutually exclusive options, the last option
2117: selected is used, all others are automatically disabled. If an
2118: option of the group is explicitly disabled, the previously
2119: selected option, if any, is used. It is an error if no option
2120: from a required group of options is selected, and building the
2121: package will fail.</p>
2122: <p>Before the options framework was introduced, build options
2123: were selected by setting a variable (often named
2124: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2125: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2126: transition to the options framework for the user, these legacy
2127: variables are converted to the appropriate options setting
2128: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2129: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2130: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2131: directly. Support for the legacy variables will be removed
2132: eventually.</p>
2133: </div>
2134: </div>
1.41 asau 2135: <div class="chapter">
1.1 dsieger 2136: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2137: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2138: <div class="toc">
2139: <p><b>Table of Contents</b></p>
1.100 leot 2140: <dl class="toc">
1.154 rillig 2141: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2142: <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 2143: </dl>
2144: </div>
1.41 asau 2145: <div class="sect1">
1.1 dsieger 2146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2147: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2148: <p>Once you have built and installed a package, you can create
2149: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.207 leot 2150: another system with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2151: the same package on a group of hosts and wasting CPU time. It also
2152: provides a simple means for others to install your package, should
2153: you distribute it.</p>
2154: <p>To create a binary package, change into the appropriate
1.10 hubertf 2155: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2156: package</strong></span>:</p>
2157: <pre class="screen">
1.112 rillig 2158: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2159: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2160: </pre>
1.242 gutterid 2161: <p>This will build your package (if not already done) and package
2162: it into a binary package. You can then use the
2163: <span class="command"><strong>pkg_*</strong></span> tools to manipulate it. Binary packages are
2164: created in <code class="varname">PACKAGES</code>, which defaults to
2165: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a compressed
2166: tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a continuation of
2167: the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/index.html" target="_top"><code class="filename">misc/figlet</code></a>
2168: example.</p>
1.154 rillig 2169: <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 2170: such a binary package.</p>
2171: </div>
1.41 asau 2172: <div class="sect1">
1.1 dsieger 2173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2174: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.184 rillig 2175: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a>.</p>
1.6 rillig 2176: </div>
2177: </div>
1.41 asau 2178: <div class="chapter">
1.6 rillig 2179: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2180: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2181: builds)</h2></div></div></div>
2182: <div class="toc">
2183: <p><b>Table of Contents</b></p>
1.100 leot 2184: <dl class="toc">
1.154 rillig 2185: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 2186: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 2187: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2188: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 2189: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2190: <dd><dl>
1.179 rillig 2191: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2192: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181 rillig 2193: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2194: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2195: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2196: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2197: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2198: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2199: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2200: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 2201: </dl></dd>
2202: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2203: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2204: </dl>
2205: </div>
1.175 gutterid 2206: <p>For a number of reasons, you may want to build binary packages
2207: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.71 wiz 2208: For instance, when you have multiple machines that should run the same software,
2209: it is wasted time if they all build their packages themselves from source.
2210: Or you may want to build a list of packages you want and check them before
1.175 gutterid 2211: deploying onto production systems.
1.71 wiz 2212: There is a way of getting a set of binary packages:
1.175 gutterid 2213: the bulk build system, or pbulk ("p" stands for "parallel").
1.112 rillig 2214: This chapter describes how to set it up.</p>
1.41 asau 2215: <div class="sect1">
1.6 rillig 2216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2217: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2218: <p>First of all, you have to decide whether you build all packages
2219: or a limited set of them. Full bulk builds usually consume a lot more resources,
2220: both space and time, than builds for some practical sets of packages.
1.175 gutterid 2221: A number of particularly heavy packages exist that are not actually
2222: interesting to a wide audience. (The approximate resource consumption for a
2223: 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>.)
2224: For limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2225: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2226: </p>
2227: <p>During bulk builds various packages are installed and deinstalled
2228: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2229: so make sure that you don't need any package during the builds.
1.112 rillig 2230: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2231: or something even more restrictive, depending on what the operating system provides,
2232: or dedicate the whole physical machine.
2233: As a useful side effect this makes sure that bulk builds cannot
2234: break anything in your system. There have been numerous cases where
1.6 rillig 2235: certain packages tried to install files outside the
2236: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2237: <code class="filename">/etc</code>.
2238: </p>
1.6 rillig 2239: </div>
1.41 asau 2240: <div class="sect1">
1.6 rillig 2241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 rillig 2242: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2243: <p>Running a bulk build works roughly as follows:</p>
1.41 asau 2244: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2245: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2246: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2247: </ul></div>
1.41 asau 2248: <div class="sect2">
1.15 rillig 2249: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2250: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2251: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2252: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2253: Configure network access to fetch distribution files.
1.112 rillig 2254: Create a user with name "pbulk".</p>
1.68 asau 2255: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2256: <pre class="screen">
1.151 sevan 2257: <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>
2258: <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 2259: <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 2260: </pre>
2261: <p>Or any other way that fits (e.g., curl, wget).</p>
2262: <p>Deploy and configure pbulk tools, e.g.:</p>
2263: <pre class="screen">
1.118 sevan 2264: <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 2265: <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>
2266: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2267: </pre>
2268: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2269: <h3 class="title">Note</h3>
2270: <p><code class="filename">mk.conf.frag</code> is a fragment of
2271: <code class="filename">mk.conf</code> that contains settings you want to
2272: apply to packages you build. For instance,</p>
2273: <pre class="programlisting">
1.112 rillig 2274: PKG_DEVELOPER= yes # perform more checks
2275: X11_TYPE= modular # use pkgsrc X11
2276: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2277: # when building all packages)
1.68 asau 2278: </pre>
2279: </div>
2280: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2281: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2282: <pre class="programlisting">
2283: www/firefox
2284: mail/thunderbird
2285: misc/libreoffice4
2286: </pre>
1.69 asau 2287: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2288: and make final amendments, if wanted.</p>
1.68 asau 2289: <p>Start it:</p>
2290: <pre class="screen">
2291: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2292: </pre>
2293: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2294: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2295: </p>
2296: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2297: <h3 class="title">Note</h3>
2298: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2299: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2300: The script is kept small enough for better understanding.</p>
2301: </div>
2302: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2303: <h3 class="title">Note</h3>
2304: <p>The <code class="filename">pbulk.sh</code> script supports running
1.205 wiz 2305: unprivileged bulk build and helps configuring distributed bulk builds.
2306: Distributed bulk builds support either building in worker chroots
2307: (each node is a path to a different chroot)
2308: that replicate the target system, including the pbulk prefix,
2309: or remote machines (each node is
2310: an IP address that must be accessible over SSH without a password).</p>
1.68 asau 2311: </div>
1.6 rillig 2312: </div>
2313: </div>
1.41 asau 2314: <div class="sect1">
1.6 rillig 2315: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2316: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2317: <p>A complete bulk build requires lots of disk space. Some of the
2318: disk space can be read-only, some other must be writable. Some can be on
2319: remote filesystems (such as NFS) and some should be local. Some can be
2320: temporary filesystems, others must survive a sudden reboot.</p>
2321: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.205 wiz 2322: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2323: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.71 wiz 2324: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2325: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2326: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2327: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2328: </ul></div>
2329: </div>
2330: <div class="sect1">
2331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.178 rillig 2332: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2333: <p>To ensure that pkgsrc packages work in different configurations, it
2334: makes sense to run non-default bulk builds from time to time. This
2335: section lists some ideas for bulk builds that intentionally let packages
2336: fail if they don't follow the pkgsrc style.</p>
2337: <div class="sect2">
2338: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2339: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.178 rillig 2340: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2341: <pre class="programlisting">
2342: GNU_CONFIGURE_STRICT= yes
2343: </pre>
2344: <p>When a package fails this additional check, the most common cause
2345: is that the configure option was valid for an older version of the
2346: package but does not apply anymore. In that case, just remove it.</p>
2347: </div>
2348: <div class="sect2">
2349: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2350: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178 rillig 2351: <p>The job of a compiler is not restricted to producing executable
1.179 rillig 2352: code, most compilers also detect typical programming mistakes. The pkgsrc
2353: compiler wrappers make it easy to force compiler options when the package
2354: is built. This can be used to find typical bugs across all packages that
2355: are in pkgsrc. By reporting these bugs upstream, the packages will be
2356: more reliable with the next updates.</p>
2357: <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 2358: <pre class="programlisting">
2359: CFLAGS+= -Werror=char-subscripts
1.179 rillig 2360: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 2361: </pre>
1.179 rillig 2362: <p>When a package fails to build using these stricter compiler
2363: options, document the circumstances in which the compiler produced the
2364: error message. This includes:</p>
1.178 rillig 2365: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2366: <li class="listitem"><p>The platform
2367: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2368: <li class="listitem"><p>The source file</p></li>
2369: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2370: part of the diagnostic.</p></li>
1.179 rillig 2371: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178 rillig 2372: </ul></div>
2373: <p>If a package produces these error messages, but the package is
1.179 rillig 2374: 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
2375: in the next builds:</p>
1.178 rillig 2376: <pre class="programlisting">
1.179 rillig 2377: .if ${PKGPATH} == category/package
1.178 rillig 2378: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2379: # error message
2380: # code
1.179 rillig 2381: # Reason why the code does not need to be fixed.
1.178 rillig 2382: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 2383: .endif
1.178 rillig 2384: </pre>
2385: <p>If the error messages from the compiler are valid and the code
1.179 rillig 2386: needs to be fixed, prepare a local patch (see
2387: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2388: authors of the package, providing them with the information you collected
2389: above.</p>
2390: <p>Patches that are not essential for the package to work should only
2391: be reported upstream but not committed to pkgsrc, to make future updates
2392: easier.</p>
1.178 rillig 2393: </div>
2394: <div class="sect2">
2395: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2396: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2397: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2398: these apply to all phases of the package build process. Especially in the
2399: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2400: decisions. The GNU configure scripts feed many small test programs to the
2401: C compiler to see whether certain headers are available, functions are
2402: defined in a library and programs can be run. In many cases these
2403: programs would not survive a strict compiler run with <code class="literal">-Wall
2404: -Wextra -Werror</code>.</p>
2405: <p>The pkgsrc infrastructure is flexible enough to support compiler
2406: options being added between the <code class="literal">configure</code> and
2407: <code class="literal">build</code> phases. It's a little more complicated than the
2408: other examples in this section but still easy enough.</p>
2409: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2410: desired compiler options. The compiler wrapper's original task is to hide
2411: unwanted directories of include files and to normalize compiler options.
2412: It does this by wrapping the compiler command and rewriting the command
2413: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2414: package directory and examine the
2415: <code class="filename">work/.cwrappers/config</code> directory. It contains
2416: individual configurations for the C compiler and the related tools. The
2417: plan is to find a hook between the configure and build phases, and to
2418: modify these configuration files at that point.</p>
2419: <p>To find this hook, have a look at
2420: <code class="filename">mk/build/build.mk</code>, which contains among others the
2421: <code class="literal">pre-build-checks-hook</code>. The word
2422: <code class="literal">checks</code> doesn't quite fit, but the
2423: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2424: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2425: <pre class="programlisting">
2426: # Just a few example options.
2427: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2428:
2429: .if ${BUILD_ONLY_CFLAGS:U:M*}
2430: pre-build-checks-hook: add-build-only-cflags
2431:
2432: add-build-only-cflags: .PHONY
2433: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2434: ${TEST} ! -f ${.TARGET} || exit 0; \
2435: for flag in ${BUILD_ONLY_CFLAGS}; do \
2436: ${ECHO} "append=$$flag" >> cc; \
2437: done; \
2438: > ${.TARGET}
2439: .endif
2440: </pre>
2441: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2442: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2443: not with spaces.)</p>
2444: <p>The condition in the <code class="literal">.if</code> statement contains the
2445: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2446: should be undefined, possibly because it is only defined for a subset of
2447: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2448: at least one compiler option, to prevent a syntax error in the shell
2449: parser.</p>
2450: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2451: that the additional compiler options are only appended once, even if
2452: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2453: creates a marker file.</p>
2454: <p>To verify that this setup works, run <span class="command"><strong>bmake
2455: configure</strong></span> in a package directory. Up to now, everything works
2456: as usual. Examine the directory
2457: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2458: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2459: the file <code class="filename">cc</code>. Examine the tail of the
2460: <code class="filename">work/.work.log</code> file to see that the normal compiler
2461: options are used.</p>
2462: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2463: options to the file <code class="filename">cc</code> and will create the marker
2464: file in the same directory. After that, the build starts as usual, but
2465: with the added compiler options. Examine the tail of the file
2466: <code class="filename">work/.work.log</code> to see that the lines starting with
2467: <code class="literal">[*]</code> don't contain the compiler options, but the
2468: corresponding lines starting with <code class="literal"><.></code> do end
2469: with these options.</p>
2470: <p>Building packages using this setup variant and fixing the resulting
2471: bugs is the same as in <a class="xref" href="#bulk.var.comperr" title="8.4.2. Detect classes of bugs by forcing compiler warnings">Section 8.4.2, “Detect classes of bugs by forcing compiler warnings”</a>.</p>
2472: </div>
2473: <div class="sect2">
2474: <div class="titlepage"><div><div><h3 class="title">
2475: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.178 rillig 2476: <p>Some directories like <code class="varname">PREFIX</code>,
2477: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2478: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2479: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2480: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2481: <pre class="programlisting">
2482: PREFIX= /a-random-uuid
2483: PKG_SYSCONFDIR= /a-random-uuid
2484: VARBASE= /a-random-uuid
2485: PKGMANDIR= a-random-uuid
2486: PKG_INFODIR= a-random-uuid
2487: </pre>
2488: </div>
2489: <div class="sect2">
2490: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2491: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.178 rillig 2492: <p>When building a package, warnings are typically ignored since they
2493: just flow by and do not cause the build to fail immediately. To find
2494: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2495: <pre class="programlisting">
2496: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2497: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2498: </pre>
2499: <p>(There are many more classes of warnings in pkgsrc, and most of
2500: them can be redefined with a simple definition like above.</p>
1.179 rillig 2501: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178 rillig 2502: the package Makefile, research whether the package actually needs Perl.
2503: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2504: Makefile, and if it doesn't, add
2505: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2506: </div>
2507: <div class="sect2">
2508: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2509: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178 rillig 2510: <p>Using pkglint as part of the regular build process is mostly a
2511: waste of time. If you want to fix some of the warnings, just run pkglint
2512: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2513: 10), which is much faster than a complete bulk build.</p>
2514: </div>
2515: <div class="sect2">
2516: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2517: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.178 rillig 2518: <p>To ensure that the binary packages don't contain references to the
2519: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2520: that variable includes the item <code class="literal">extra</code>, it is
2521: possible to define additional patterns that must not appear in any
2522: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2523: <pre class="programlisting">
2524: CHECK_WRKREF= extra
2525: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2526: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2527: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2528: </pre>
2529: <p>The above patterns will probably generate many false positives,
2530: therefore the results need to be taken with a grain of salt.</p>
2531: </div>
2532: <div class="sect2">
2533: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2534: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.178 rillig 2535: <p>To run the test suites that come with each package, add this line
2536: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2537: <pre class="programlisting">
2538: PKGSRC_RUN_TEST= yes
2539: </pre>
2540: <p>Be prepared that even the most basic packages fail this test. When
2541: doing a bulk build with this, it will often abort in the early phase
2542: where the packages are scanned for their dependencies since there are
2543: cyclic dependencies. There is still a lot to do in this area.</p>
2544: </div>
2545: <div class="sect2">
2546: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2547: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.178 rillig 2548: <p>To catch typos in the shell snippets from the Makefile fragments,
2549: add the <code class="literal">-u</code> flag to most of the commands by adding this
2550: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2551: <pre class="programlisting">
2552: RUN= @set -eu;
2553: </pre>
1.181 rillig 2554: <p>After that, ensure that none of the bulk build log files (even
2555: those for successfully built packages) contains the string
2556: <code class="literal">parameter not set</code> or whatever error message the
2557: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.178 rillig 2558: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2559: definition.</p>
2560: </div>
2561: <div class="sect2">
2562: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2563: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.178 rillig 2564: <p>The build logs of a package are often quite long. This allows error
2565: messages or other interesting details to hide between the noise. To make
2566: the actual error message stand out more, add these lines to
2567: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2568: <pre class="programlisting">
2569: GNU_CONFIGURE_QUIET= yes
2570: MAKE_FLAGS+= -s
2571: </pre>
2572: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2573: Make. On exotic platforms with their own make, it may be a little
2574: different.</p>
2575: </div>
2576: </div>
2577: <div class="sect1">
2578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2579: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2580: <p>After your pkgsrc bulk-build has completed, you may wish to
2581: create a CD-ROM set of the resulting binary packages to assist
2582: in installing packages on other machines. The
1.207 leot 2583: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/index.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.1 dsieger 2584: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2585: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2586: way that keeps all the dependencies for a given package on the same
2587: CD as that package.</p>
1.41 asau 2588: <div class="sect2">
1.1 dsieger 2589: <div class="titlepage"><div><div><h3 class="title">
1.178 rillig 2590: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2591: <p>Complete documentation for cdpack is found in the cdpack(1)
2592: man page. The following short example assumes that the binary
2593: packages are left in
2594: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2595: sufficient disk space exists in <code class="filename">/u2</code> to
2596: hold the ISO 9660 images.</p>
2597: <pre class="screen">
2598: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2599: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2600: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2601: </pre>
2602: <p>If you wish to include a common set of files
2603: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2604: etc.) on each CD in the collection, then you need to create a
1.175 gutterid 2605: directory which contains these files, e.g.:</p>
1.1 dsieger 2606: <pre class="screen">
2607: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2608: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2609: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2610: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2611: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2612: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2613: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2614: </pre>
2615: <p>Now create the images:</p>
2616: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2617: <p>Each image will contain <code class="filename">README</code>,
2618: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2619: in their root directories.</p>
2620: </div>
2621: </div>
2622: </div>
1.41 asau 2623: <div class="chapter">
1.1 dsieger 2624: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2625: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2626: <div class="toc">
2627: <p><b>Table of Contents</b></p>
1.100 leot 2628: <dl class="toc">
1.154 rillig 2629: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2630: <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 2631: </dl>
2632: </div>
2633: <p>The files that are installed by pkgsrc are organized in a way that
2634: is similar to what you find in the <code class="filename">/usr</code> directory
2635: of the base system. But some details are different. This is because
2636: pkgsrc initially came from FreeBSD and had adopted its file system
2637: hierarchy. Later it was largely influenced by NetBSD. But no matter
2638: which operating system you are using pkgsrc with, you can expect the
2639: same layout for pkgsrc.</p>
2640: <p>There are mainly four root directories for pkgsrc, which are all
2641: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2642: When pkgsrc has been installed as root, the default locations
2643: are:</p>
2644: <pre class="programlisting">
2645: LOCALBASE= /usr/pkg
2646: PKG_SYSCONFBASE= /usr/pkg/etc
2647: VARBASE= /var
1.119 sevan 2648: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2649: </pre>
2650: <p>In unprivileged mode (when pkgsrc has been installed as any other
2651: user), the default locations are:</p>
2652: <pre class="programlisting">
2653: LOCALBASE= ${HOME}/pkg
2654: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2655: VARBASE= ${HOME}/pkg/var
1.119 sevan 2656: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2657: </pre>
2658: <p>What these four directories are for, and what they look like is
2659: explained below.</p>
1.41 asau 2660: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2661: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2662: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2663: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2664: the well-known subdirectories like <code class="filename">bin</code>,
2665: <code class="filename">include</code>, <code class="filename">lib</code>,
2666: <code class="filename">share</code> and
2667: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2668: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2669: <code class="filename">/var</code> in the base system. Some programs (especially
2670: games, network daemons) need write access to it during normal
2671: operation.</p></li>
1.23 wiz 2672: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2673: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2674: 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 2675: itself.</p></li>
2676: </ul></div>
1.41 asau 2677: <div class="sect1">
1.1 dsieger 2678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2679: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2680: </h2></div></div></div>
2681: <p>The following directories exist in a typical pkgsrc installation
2682: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2683: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2684: <dt><span class="term"><code class="filename">bin</code></span></dt>
2685: <dd><p>Contains executable programs that are intended to be
2686: directly used by the end user.</p></dd>
2687: <dt><span class="term"><code class="filename">emul</code></span></dt>
2688: <dd><p>Contains files for the emulation layers of various other
2689: operating systems, especially for
2690: NetBSD.</p></dd>
2691: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2692: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2693: <dd><p>Contains
2694: the configuration files.</p></dd>
2695: <dt><span class="term"><code class="filename">include</code></span></dt>
2696: <dd><p>Contains headers for the C and C++ programming
2697: languages.</p></dd>
2698: <dt><span class="term"><code class="filename">info</code></span></dt>
2699: <dd><p>Contains GNU info files of various
2700: packages.</p></dd>
2701: <dt><span class="term"><code class="filename">lib</code></span></dt>
2702: <dd><p>Contains shared and static
2703: libraries.</p></dd>
2704: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2705: <dd><p>Contains data files that don't change after
2706: installation. Other data files belong into
2707: <code class="filename">${VARBASE}</code>.</p></dd>
2708: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2709: <dd><p>Contains programs that are not intended to be used by
2710: end users, such as helper programs or network
2711: daemons.</p></dd>
2712: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2713: <dd><p>Contains programs that are intended to be executed as
2714: CGI scripts by a web server.</p></dd>
2715: <dt><span class="term"><code class="filename">man</code> (the usual value of
2716: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2717: <dd><p>Contains brief
2718: documentation in form of manual pages.</p></dd>
2719: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2720: <dd><p>Contains programs that are intended to be used only by
2721: the super-user.</p></dd>
2722: <dt><span class="term"><code class="filename">share</code></span></dt>
2723: <dd><p>Contains platform-independent data files that don't
2724: change after installation.</p></dd>
2725: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2726: <dd><p>Contains documentation files provided by the
2727: packages.</p></dd>
2728: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2729: <dd><p>Contains example files provided by the packages. Among
2730: others, the original configuration files are saved here and copied to
2731: <code class="filename">${PKG_SYSCONFDIR}</code> during
2732: installation.</p></dd>
2733: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2734: <dd><p>Contains the original files for rc.d
2735: scripts.</p></dd>
2736: <dt><span class="term"><code class="filename">var</code> (the usual location of
2737: <code class="filename">${VARBASE}</code>)</span></dt>
2738: <dd><p>Contains files
2739: that may be modified after
2740: installation.</p></dd>
2741: </dl></div>
2742: </div>
1.41 asau 2743: <div class="sect1">
1.1 dsieger 2744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2745: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2746: </h2></div></div></div>
1.41 asau 2747: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2748: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2749: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2750: <dd><p>Contains
2751: information about the currently installed
2752: packages.</p></dd>
2753: <dt><span class="term"><code class="filename">games</code></span></dt>
2754: <dd><p>Contains highscore
2755: files.</p></dd>
2756: <dt><span class="term"><code class="filename">log</code></span></dt>
2757: <dd><p>Contains log files.</p></dd>
2758: <dt><span class="term"><code class="filename">run</code></span></dt>
2759: <dd><p>Contains informational files about daemons that are
2760: currently running.</p></dd>
2761: </dl></div>
2762: </div>
2763: </div>
1.41 asau 2764: <div class="chapter">
1.1 dsieger 2765: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2766: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2767: <div class="toc">
2768: <p><b>Table of Contents</b></p>
1.100 leot 2769: <dl class="toc">
1.154 rillig 2770: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2771: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2772: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2773: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2774: <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>
2775: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2776: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2777: <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>
2778: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2779: <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 2780: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 2781: <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>
1.221 nia 2782: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 2783: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2784: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2785: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2786: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2787: <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 2788: </dl>
2789: </div>
2790: <p>This section contains hints, tips & tricks on special things in
2791: pkgsrc that we didn't find a better place for in the previous chapters, and
2792: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2793: <div class="sect1">
1.1 dsieger 2794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2795: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2796: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2797: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2798: <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 2799: This is a general purpose list for most issues regarding
2800: pkgsrc, regardless of platform, e.g. soliciting user help
2801: for pkgsrc configuration, unexpected build failures, using
2802: particular packages, upgrading pkgsrc installations,
2803: questions regarding the pkgsrc release branches, etc. General announcements or
2804: proposals for changes that impact the pkgsrc user community,
2805: e.g. major infrastructure changes, new features, package
2806: removals, etc., may also be posted.</p></li>
1.174 leot 2807: <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 2808: A list where the results of pkgsrc bulk builds are sent and
2809: discussed.</p></li>
1.174 leot 2810: <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 2811: This list is for those who are interested in getting a
2812: commit message for every change committed to pkgsrc. It is
2813: also available in digest form, meaning one daily message
2814: containing all commit messages for changes to the package
2815: source tree in that 24 hour period.</p></li>
2816: </ul></div>
2817: <p>To subscribe, do:</p>
2818: <pre class="programlisting">
2819: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2820: </pre>
2821: <p>Archives for all these mailing lists are available from
1.174 leot 2822: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2823: </div>
1.41 asau 2824: <div class="sect1">
1.1 dsieger 2825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2826: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2827: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2828: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2829: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2830: they might be useful, and not to duplicate the documentation that comes
2831: with each package.</p>
2832: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.207 leot 2833: <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/index.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1 dsieger 2834: Symlinks for use by buildlink.</p></li></ul></div>
2835: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2836: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2837: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/index.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.121 sevan 2838: Calculates various kinds of checksums (including SHA3).</p></li>
1.207 leot 2839: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/index.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1 dsieger 2840: Compatibility library for pkgsrc tools.</p></li>
1.207 leot 2841: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/index.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1 dsieger 2842: non-BSD systems due to lack of native mtree.</p></li>
1.207 leot 2843: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1 dsieger 2844: Up-to-date replacement for
2845: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2846: systems where pkg_install is not present.</p></li>
2847: </ul></div>
2848: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2849: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2850: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1 dsieger 2851: Create a binary package from an
1.10 hubertf 2852: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2853: save the old package.</p></li>
1.207 leot 2854: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/index.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1 dsieger 2855: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2856: from multiple locations. It currently supports the following
2857: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.207 leot 2858: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/index.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16 jnemeth 2859: the best compiler flags to optimise code for your current
1.23 wiz 2860: CPU and compiler. </p></li>
1.1 dsieger 2861: </ul></div>
2862: <p>Utilities for keeping track of installed packages, being up to date,
2863: etc:</p>
1.41 asau 2864: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2865: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/index.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.65 wiz 2866: update tool similar to apt(1). Download, install, and upgrade
2867: binary packages easily.</p></li>
1.207 leot 2868: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1 dsieger 2869: packages whose installed versions do not match the latest pkgsrc
2870: entries.</p></li>
1.207 leot 2871: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1 dsieger 2872: dependency graphs of packages, to aid in choosing a strategy for
2873: updating.</p></li>
1.207 leot 2874: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/index.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
2875: graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/index.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
2876: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12 weinem 2877: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.207 leot 2878: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/index.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1 dsieger 2879: does various checks on the complete pkgsrc system.</p></li>
1.207 leot 2880: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/index.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1 dsieger 2881: packages you have installed.</p></li>
2882: </ul></div>
2883: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2884: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2885: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1 dsieger 2886: making and maintaining patches for a package (includes pkgdiff,
2887: pkgvi, mkpatches, etc.).</p></li>
1.207 leot 2888: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/index.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.1 dsieger 2889: converting to pkgsrc.</p></li>
2890: </ul></div>
2891: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2892: utilities)</p>
1.41 asau 2893: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2894: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/index.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1 dsieger 2895: packages in a chrooted area.</p></li>
1.207 leot 2896: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/index.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1 dsieger 2897: kernel version for chrooted cross builds.</p></li>
2898: </ul></div>
2899: </div>
1.41 asau 2900: <div class="sect1">
1.1 dsieger 2901: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2902: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2903: <p>To install packages from source as a non-root user, download
1.154 rillig 2904: 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 2905: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2906: --unprivileged</strong></span>.</p>
2907: <p>This will install the binary part of pkgsrc to
2908: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2909: into <code class="filename">~/pkg/etc</code>.</p>
2910: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2911: </div>
1.41 asau 2912: <div class="sect1">
1.1 dsieger 2913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2914: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2915: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2916: enable this feature by adding the option
2917: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2918: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2919: distfile is found, pkgsrc will try to resume it.</p>
2920: <p>You can also
1.61 wiz 2921: use a different program than the platform default program by changing the
1.16 jnemeth 2922: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2923: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2924: by using the value manual. A value of custom disables the system defaults
2925: and dependency tracking for the fetch program. In that case you have to
2926: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2927: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2928: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2929: <p>For example, if you want to use
1.16 jnemeth 2930: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2931: like:</p>
2932: <pre class="programlisting">
1.112 rillig 2933: FETCH_USING= wget
1.1 dsieger 2934: </pre>
2935: </div>
1.41 asau 2936: <div class="sect1">
1.1 dsieger 2937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2938: <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 2939: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2940: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2941: you will have to add the following line into
1.10 hubertf 2942: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2943: <pre class="programlisting">
1.4 rillig 2944: X11_TYPE=modular
1.1 dsieger 2945: </pre>
2946: </div>
1.41 asau 2947: <div class="sect1">
1.1 dsieger 2948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2949: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2950: <p>If you are sitting behind a firewall which does not allow direct
2951: connections to Internet hosts (i.e. non-NAT), you may specify the
2952: relevant proxy hosts. This is done using an environment variable in the
2953: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2954: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2955: port 80 as the proxy port number. So the proxy environment variables
2956: are:</p>
2957: <pre class="programlisting">
2958: ftp_proxy=ftp://orpheus.amdahl.com:80/
2959: http_proxy=http://orpheus.amdahl.com:80/
2960: </pre>
2961: </div>
1.41 asau 2962: <div class="sect1">
1.1 dsieger 2963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2964: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2965: <p>Some fetch tools are not prepared to support HTTPS by default
2966: (for example, the one in NetBSD 6.0), or the one installed by the
2967: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2968: dependency graph).</p>
2969: <p>Usually you won't notice, because distribution files are
2970: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2971: be often enough if you are following pkgsrc-current. In that case, set
2972: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2973: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2974: with HTTPS support by default. Of course, these tools need to be
2975: installed before you can use them this way.</p>
2976: </div>
2977: <div class="sect1">
2978: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2979: <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 2980: <p>This depends on which utility is used to retrieve distfiles. From
2981: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2982: the first available command from the following list:</p>
1.41 asau 2983: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2984: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2985: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2986: </ul></div>
2987: <p>On a default NetBSD installation, this will be
2988: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2989: connections first, and falls back to active connections if the server
2990: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2991: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2992: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2993: <p>Having that option present will prevent
2994: <code class="filename">/usr/bin/ftp</code> from falling back to active
2995: transfers.</p>
2996: </div>
1.41 asau 2997: <div class="sect1">
1.1 dsieger 2998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2999: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3000: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3001: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3002: 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 3003: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3004: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3005: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3006: resulting list to your machine at work/school and use it there. If you
1.207 leot 3007: don't have a NetBSD-compatible <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 3008: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3009: URL:</p>
3010: <p>At home:</p>
3011: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3012: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3013: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3014: <p>At work:</p>
3015: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3016: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3017: home.</p>
3018: <p>If you have a machine running NetBSD, and you want to get
3019: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3020: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3021: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3022: directly by running:</p>
3023: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3024: <p>If you even decide to ignore
3025: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3026: by running:</p>
3027: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3028: </div>
1.41 asau 3029: <div class="sect1">
1.1 dsieger 3030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3031: <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 3032: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.207 leot 3033: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.1 dsieger 3034: package, you get the error from make that it doesn't know how to make
3035: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 3036: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3037: the NetBSD base distribution on your machine. It is recommended to do
3038: that to format man pages.</p>
1.207 leot 3039: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.1 dsieger 3040: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3041: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3042: </div>
1.41 asau 3043: <div class="sect1">
1.1 dsieger 3044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3045: <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 3046: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3047: when you installed your NetBSD machine. Please get and install it, by
3048: extracting it in <code class="filename">/</code>:</p>
3049: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3050: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3051: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3052: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3053: -r</strong></span>).</p>
3054: </div>
1.41 asau 3055: <div class="sect1">
1.1 dsieger 3056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.221 nia 3057: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.1 dsieger 3058: <p>When installing packages as non-root user and using the just-in-time
1.207 leot 3059: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/su.1"><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 3060: password for each required package installed. To avoid this, the sudo
3061: package can be used, which does password caching over a limited time. To
1.221 nia 3062: use it, install <span class="command"><strong>sudo</strong></span> or
3063: <span class="command"><strong>priv</strong></span> (either as binary package, from
3064: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/priv/index.html" target="_top"><code class="filename">security/priv</code></a>, or
1.207 leot 3065: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/index.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10 hubertf 3066: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3067: <span class="emphasis"><em>after</em></span> the definition of the
3068: <code class="varname">LOCALBASE</code> variable:</p>
3069: <pre class="programlisting">
3070: .if exists(${LOCALBASE}/bin/sudo)
3071: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3072: .endif
3073: </pre>
3074: </div>
1.41 asau 3075: <div class="sect1">
1.1 dsieger 3076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3077: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3078: <p>As the system administrator, you can choose where configuration files
3079: are installed. The default settings make all these files go into
3080: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3081: be suboptimal depending on your expectations (e.g., a read-only,
3082: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3083: configuration of the provided packages).</p>
3084: <p>In order to change the defaults, you can modify the
3085: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3086: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3087: directory; some common examples include <code class="filename">/etc</code> or
3088: <code class="filename">/etc/pkg</code>.</p>
3089: <p>Furthermore, you can change this value on a per-package basis by
3090: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3091: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3092: package you would like to modify, that is, the contents of
3093: <code class="varname">PKGBASE</code>.</p>
3094: <p>Note that after changing these settings, you must rebuild and
3095: reinstall any affected packages.</p>
3096: </div>
1.41 asau 3097: <div class="sect1">
1.1 dsieger 3098: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3099: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3100: <p>Please be aware that there can often be bugs in third-party software,
3101: and some of these bugs can leave a machine vulnerable to exploitation by
3102: attackers. In an effort to lessen the exposure, the NetBSD packages team
3103: maintains a database of known-exploits to packages which have at one time
3104: been included in pkgsrc. The database can be downloaded automatically, and
3105: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3106: do this, refer to the following two tools (installed as part of the
1.207 leot 3107: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/index.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23 wiz 3108: <div class="orderedlist"><ol class="orderedlist" type="1">
3109: <li class="listitem">
1.20 snj 3110: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3111: download a list of the security vulnerabilities information. This list
1.25 spz 3112: is kept up to date by the pkgsrc security team, and is distributed
3113: from the NetBSD ftp server:</p>
1.177 leot 3114: <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 3115: </li>
1.23 wiz 3116: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3117: current machine, checking each known vulnerability. If a
1.1 dsieger 3118: vulnerable package is installed, it will be shown by output to stdout,
3119: including a description of the type of vulnerability, and a URL
3120: containing more information.</p></li>
3121: </ol></div>
1.121 sevan 3122: <p>Use of these tools is strongly recommended!
1.202 nia 3123: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, “Checking for security vulnerabilities in installed packages”</a> for instructions on how to automate checking and
1.121 sevan 3124: reporting.</p>
3125: <p>If this database is installed, pkgsrc builds will use it to
3126: perform a security check before building any package.</p>
1.1 dsieger 3127: </div>
1.41 asau 3128: <div class="sect1">
1.1 dsieger 3129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3130: <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 3131: <p>When you add your own preferences to the
3132: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3133: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3134: environment variables to the <code class="filename">./configure</code>
1.207 leot 3135: scripts and to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 3136: <code class="varname">CFLAGS</code> from the environment variable by
3137: overriding them in the <code class="filename">Makefile</code>s of their
3138: package.</p>
3139: <p>Currently there is no solution to this problem. If you
3140: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3141: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3142: directory and then inspect any <code class="filename">Makefile</code> and
3143: <code class="filename">Makefile.in</code> for whether they define
3144: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3145: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3146: programmers write so bad code that it only works for the
3147: specific combination of <code class="varname">CFLAGS</code> they have
3148: chosen.</p>
1.172 rillig 3149: <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>
3150: <pre class="programlisting">
3151: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3152: CFLAGS+= -Dpkgsrc___CFLAGS
3153: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3154: </pre>
3155: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3156: to see whether the above flags are passed to the actual build
3157: commands in general.</p>
3158: <p>To find out whether the flags are passed to individual compiler
3159: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3160: most cases, the flags from the original command lines (the lines starting
3161: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3162: (the lines starting with <code class="literal"><.></code>). If the flag is
3163: missing from the actual compiler command, it must have been removed by
1.184 rillig 3164: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1 dsieger 3165: </div>
1.41 asau 3166: <div class="sect1">
1.1 dsieger 3167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3168: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3169: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3170: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3171: case that occurs often is that people only update pkgsrc in
3172: parts, because of performance reasons. Since pkgsrc is one large
3173: system, not a collection of many small systems, there are
3174: sometimes changes that only work when the whole pkgsrc tree is
3175: updated.</p></li>
1.41 asau 3176: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3177: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3178: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3179: files.</p></li>
1.41 asau 3180: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3181: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3182: verify this.</p></li>
1.108 rillig 3183: <li class="step"><p>If you are a package developer who wants to invest
1.154 rillig 3184: 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 3185: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3186: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3187: </ol></div>
3188: </div>
1.41 asau 3189: <div class="sect1">
1.1 dsieger 3190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3191: <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 3192: <p>You have modified a file from pkgsrc, and someone else has
3193: modified that same file afterwards in the CVS repository. Both changes
3194: are in the same region of the file, so when you updated pkgsrc, the
3195: <code class="literal">cvs</code> command marked the conflicting changes in the
3196: file. Because of these markers, the file is no longer a valid
3197: <code class="filename">Makefile</code>.</p>
3198: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3199: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3200: -dP</strong></span> in that directory to download the current version.</p>
3201: </div>
3202: </div>
3203: </div>
1.41 asau 3204: <div class="part">
1.1 dsieger 3205: <div class="titlepage"><div><div><h1 class="title">
3206: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3207: <div class="partintro">
1.1 dsieger 3208: <div></div>
3209: <p>This part of the book deals with creating and
1.23 wiz 3210: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3211: guide on creating a new package. The remaining chapters are more
3212: like a reference manual for pkgsrc.</p>
3213: <div class="toc">
3214: <p><b>Table of Contents</b></p>
1.100 leot 3215: <dl class="toc">
1.154 rillig 3216: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 3217: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 3218: <dd><dl>
1.184 rillig 3219: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3220: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3221: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 3222: <dd><dl>
1.184 rillig 3223: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3224: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3225: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3226: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3227: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 3228: </dl></dd>
1.184 rillig 3229: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3230: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3231: <dd><dl>
3232: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3233: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3234: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3235: </dl></dd>
3236: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3237: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3238: </dl></dd>
1.184 rillig 3239: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 3240: <dd><dl>
1.184 rillig 3241: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3242: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3243: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3244: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3245: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 3246: <dd><dl>
1.184 rillig 3247: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3248: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 3249: </dl></dd>
1.184 rillig 3250: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3251: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3252: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3253: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3254: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3255: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3256: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3257: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3258: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3259: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3260: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3261: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3262: </dl></dd>
3263: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3264: <dd><dl>
3265: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 3266: <dd><dl>
1.219 nia 3267: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3268: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3269: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 3270: </dl></dd>
1.184 rillig 3271: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3272: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6 rillig 3273: </dl></dd>
1.184 rillig 3274: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3275: <dd><dl>
1.184 rillig 3276: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3277: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3278: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3279: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 3280: <dd><dl>
1.184 rillig 3281: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3282: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3283: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
3284: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 3285: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 3286: </dl></dd>
3287: </dl></dd>
1.184 rillig 3288: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 3289: <dd><dl>
1.184 rillig 3290: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3291: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
3292: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3293: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3294: </dl></dd>
1.184 rillig 3295: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 3296: <dd><dl>
1.184 rillig 3297: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3298: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3299: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3300: </dl></dd>
3301: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3302: <dd><dl>
3303: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3304: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3305: <dd><dl>
1.184 rillig 3306: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3307: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 3308: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3309: and
3310: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3311: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3312: </dl></dd>
1.184 rillig 3313: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.241 rillig 3314: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.184 rillig 3315: </dl></dd>
3316: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 3317: <dd><dl>
1.184 rillig 3318: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3319: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3320: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
3321: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3322: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3323: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3324: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3325: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3326: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3327: </dl></dd>
1.184 rillig 3328: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3329: <dd><dl>
3330: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3331: <dd><dl>
3332: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3333: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 3334: </dl></dd>
1.184 rillig 3335: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 3336: <dd><dl>
1.184 rillig 3337: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3338: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 3339: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
3340: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
3341: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 3342: </dl></dd>
3343: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3344: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3345: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3346: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3347: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3348: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3349: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154 rillig 3350: </dl></dd>
3351: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3352: <dd><dl>
3353: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3354: <dd><dl>
3355: <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>
3356: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3357: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3358: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3359: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3360: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3361: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3362: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3363: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3364: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3365: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3366: </dl></dd>
3367: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3368: <dd><dl>
3369: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3370: <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>
3371: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3372: </dl></dd>
3373: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3374: <dd><dl>
3375: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3376: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3377: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 3378: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 3379: </dl></dd>
3380: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3381: <dd><dl>
3382: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3383: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 3384: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 3385: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
3386: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
3387: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
3388: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 3389: </dl></dd>
3390: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3391: <dd><dl>
3392: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3393: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 3394: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3395: <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>
3396: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 3397: </dl></dd>
3398: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3399: <dd><dl>
3400: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3401: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3402: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3403: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3404: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 3405: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 3406: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
3407: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 3408: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
3409: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
3410: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
3411: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
3412: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
3413: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
3414: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 3415: emulation</a></span></dt>
1.203 nia 3416: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
3417: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 3418: </dl></dd>
1.154 rillig 3419: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3420: </dl></dd>
1.184 rillig 3421: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3422: <dd><dl>
3423: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3424: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3425: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3426: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3427: </dl></dd>
1.154 rillig 3428: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3429: <dd><dl>
1.154 rillig 3430: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3431: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3432: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3433: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3434: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3435: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3436: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3437: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3438: </dl></dd>
3439: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 3440: </dl>
3441: </div>
3442: </div>
1.41 asau 3443: <div class="chapter">
1.1 dsieger 3444: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3445: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3446: <p>
3447: To get help when developing pkgsrc, the definitive source is this
3448: document, the pkgsrc guide. If you don't find anything here,
3449: there are alternatives:
3450: </p>
3451: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3452: <li class="listitem">
3453: <p>
3454: The built-in pkgsrc help, which is available after bootstrapping
3455: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3456: help for any topic, such as a variable name like
3457: <code class="varname">BUILD_DEFS</code>, a make target like
3458: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3459: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207 leot 3460: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.154 rillig 3461: </li>
3462: <li class="listitem"><p>
1.163 rillig 3463: To see the value of a single variable, run <span class="command"><strong>bmake
3464: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3465: </p></li>
3466: <li class="listitem"><p>
3467: To see the values of the most common variables, run
3468: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3469: topic. To see the variables for a single topic, run
3470: <span class="command"><strong>bmake
3471: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3472: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3473: </p></li>
3474: <li class="listitem"><p>
1.154 rillig 3475: The tech-pkg mailing list, to which
3476: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3477: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3478: questions</a>.</p></li>
3479: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3480: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3481: or by using a specialized chat program such as
3482: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3483: Pick any user name and join the channel #pkgsrc.</p></li>
3484: </ul></div>
3485: </div>
3486: <div class="chapter">
3487: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 3488: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3489: <div class="toc">
3490: <p><b>Table of Contents</b></p>
1.100 leot 3491: <dl class="toc">
1.184 rillig 3492: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3493: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3494: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3495: <dd><dl>
3496: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3497: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3498: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3499: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3500: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3501: </dl></dd>
3502: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3503: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3504: <dd><dl>
3505: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3506: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3507: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3508: </dl></dd>
1.184 rillig 3509: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3510: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3511: </dl>
3512: </div>
1.184 rillig 3513: <p>Whenever you're preparing a package, there are a number of
3514: files involved which are described in the following
3515: sections.</p>
3516: <div class="sect1">
3517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3518: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3519: </h2></div></div></div>
3520: <p>Building, installation and creation of a binary package are all
3521: controlled by the package's <code class="filename">Makefile</code>.
3522: The <code class="filename">Makefile</code> describes various things about
3523: a package, for example from where to get it, how to configure,
3524: build, and install it.</p>
3525: <p>A package <code class="filename">Makefile</code> contains several
3526: sections that describe the package.</p>
3527: <p>In the first section there are the following variables, which
3528: should appear exactly in the order given here. The order and
3529: grouping of the variables is mostly historical and has no further
3530: meaning.</p>
3531: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3532: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3533: distribution file to be downloaded from the package's
3534: website.</p></li>
3535: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3536: package, as used by pkgsrc. You need to provide it if
3537: <code class="varname">DISTNAME</code> (which is the default) is not a good
3538: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3539: provided (no distribution file is required). Usually it is the pkgsrc
3540: directory name together with the version number. It must match the
3541: regular expression
3542: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3543: starts with a letter or digit, and contains only letters, digits,
1.204 nia 3544: dashes, underscores, dots and plus signs.
3545: New packages should have entirely lower-case names, with the exception
3546: of some that must follow pre-existing conventions
3547: (e.g. R packages begin with <code class="varname">R-</code>).
3548: You can use the <code class="code">:tl</code> variable modifier to lower-case
3549: the package name.</p></li>
1.184 rillig 3550: <li class="listitem">
3551: <p><code class="varname">CATEGORIES</code> is a list of categories
3552: which the package fits in. You can choose any of the top-level
3553: directories of pkgsrc for it.</p>
3554: <p>Currently the following values are available for
3555: <code class="varname">CATEGORIES</code>. If more than
3556: one is used, they need to be separated by spaces:</p>
1.1 dsieger 3557: <pre class="programlisting">
1.184 rillig 3558: archivers cross geography meta-pkgs security
3559: audio databases graphics misc shells
3560: benchmarks devel ham multimedia sysutils
3561: biology editors inputmethod net textproc
3562: cad emulators lang news time
3563: chat finance mail parallel wm
3564: comms fonts math pkgtools www
3565: converters games mbone print x11
1.1 dsieger 3566: </pre>
3567: </li>
1.184 rillig 3568: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3569: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3570: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3571: and <code class="varname">DISTFILES</code> are discussed in detail in
3572: <a class="xref" href="#build.fetch" title="13.5. The fetch phase">Section 13.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
3573: </ul></div>
3574: <p>The second section contains information about separately
3575: downloaded patches, if any.
3576: </p>
3577: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3578: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3579: Name(s) of additional files that contain distribution patches.
3580: There is no default. pkgsrc will look for them at
3581: <code class="varname">PATCH_SITES</code>.
3582: They will automatically be uncompressed before patching if
3583: the names end with <code class="filename">.gz</code> or
3584: <code class="filename">.Z</code>.</p></li>
3585: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3586: Primary location(s) for distribution patch files (see
3587: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3588: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.207 leot 3589: an argument to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.184 rillig 3590: help find the correct files to patch. It defaults to
3591: <span class="command"><strong>-p0</strong></span>.</p></li>
3592: </ul></div>
3593: <p>The third section contains the following variables.
3594: </p>
3595: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3596: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
3597: address of the person who feels responsible for this package,
3598: and who is most likely to look at problems or questions regarding
1.207 leot 3599: this package which have been reported with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.184 rillig 3600: Other developers may contact the <code class="varname">MAINTAINER</code>
3601: before making changes to the package, but are not required to
3602: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
3603: to yourself. If you really can't maintain the package for future
3604: updates, set it to
3605: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
3606: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
3607: of <code class="varname">MAINTAINER</code> when you do not want other
3608: developers to update or change the package without contacting
3609: you first. A package Makefile should contain one of
3610: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
1.243 gutterid 3611: not both.</p></li>
1.184 rillig 3612: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3613: find more information about the package.</p></li>
3614: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3615: description of the package (should not include the package
3616: name).</p></li>
3617: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3618: 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>
3619: </ul></div>
3620: <p>Other variables that affect the build:
3621: </p>
3622: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3623: <p><code class="varname">WRKSRC</code>: The directory where the
3624: interesting distribution files of the package are found. The
3625: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3626: works for most packages.</p>
3627: <p>If a package doesn't create a subdirectory for itself
3628: (most GNU software does, for instance), but extracts itself in
3629: the current directory, you should set
3630: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3631: <p>If a package doesn't create a subdirectory with the
3632: name of <code class="varname">DISTNAME</code> but some different name,
3633: set <code class="varname">WRKSRC</code> to point to the proper name in
3634: <code class="filename">${WRKDIR}</code>, for example
3635: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.207 leot 3636: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/index.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/index.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.184 rillig 3637: <p>The name of the working directory created by pkgsrc is
3638: taken from the <code class="varname">WRKDIR_BASENAME</code>
3639: variable. By default, its value is
3640: <code class="filename">work</code>. If you want to use the same
3641: pkgsrc tree for building different kinds of binary packages,
3642: you can change the variable according to your needs. Two
3643: other variables handle common cases of setting
3644: <code class="varname">WRKDIR_BASENAME</code> individually. If
3645: <code class="varname">OBJHOSTNAME</code> is defined in
3646: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3647: the host's name is attached to the directory name. If
3648: <code class="varname">OBJMACHINE</code> is defined, the platform name
3649: is attached, which might look like
3650: <code class="filename">work.i386</code> or
3651: <code class="filename">work.sparc</code>.</p>
3652: </li></ul></div>
3653: <p>Please pay attention to the following gotchas:</p>
3654: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3655: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3656: installed in compressed form by the package. For packages using
3657: BSD-style makefiles which honor MANZ, there is
3658: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3659: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3660: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3661: below).</p></li>
3662: <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>
3663: </ul></div>
3664: </div>
1.41 asau 3665: <div class="sect1">
1.1 dsieger 3666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 3667: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3668: </h2></div></div></div>
3669: <p>The <code class="filename">distinfo</code> file contains the message
3670: digest, or checksum, of each distfile needed for the package. This
3671: ensures that the distfiles retrieved from the Internet have not been
3672: corrupted during transfer or altered by a malign force to introduce
3673: a security hole. To provide maximum security, all distfiles are
1.243 gutterid 3674: protected using two different message digest algorithms (BLAKE2s
3675: and SHA512), as well as the file size.</p>
1.184 rillig 3676: <p>The <code class="filename">distinfo</code> file also contains the
3677: checksums for all the patches found in the
3678: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a>). These checksums ensure that patches
3679: are only applied intentionally and that they don't accidentally change,
3680: e.g. when merging different changes together. They also make sure that
3681: new patches are actually added to CVS and old ones are removed.
3682: Too see whether the patches and the <code class="filename">distinfo</code> file
3683: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3684: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3685: <span class="command"><strong>make distinfo</strong></span> command.</p>
3686: <p>Some packages have different sets of distfiles depending on
1.207 leot 3687: the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/index.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
1.184 rillig 3688: <code class="filename">distinfo</code> file and care should be taken when
3689: upgrading such a package to ensure distfile information is not
3690: lost.</p>
3691: </div>
3692: <div class="sect1">
3693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3694: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3695: </h2></div></div></div>
3696: <p>Some packages don't work out-of-the box on the various
3697: platforms that are supported by pkgsrc. These packages need
3698: to be patched to make them work. The patch files can be
3699: found in the <code class="filename">patches/</code> directory.</p>
3700: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3701: applied to the files in <code class="varname">WRKSRC</code> directory after
3702: extracting them, in alphabetic order.</p>
1.41 asau 3703: <div class="sect2">
1.1 dsieger 3704: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3705: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3706: <p>The <code class="filename">patch-*</code> files should be in
3707: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3708: problems. (To force patches to apply with fuzz you can set
3709: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3710: should contain only changes for a single file, and no file should be
3711: patched by more than one patch file. This helps to keep future
3712: modifications simple.</p>
3713: <p>Each patch file is structured as follows: In the first line,
3714: there is the RCS Id of the patch itself. The second line should be
3715: empty for aesthetic reasons. After that, there should be a comment for
3716: each change that the patch does. There are a number of standard
3717: cases:</p>
3718: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3719: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3720: mention the vulnerability ID (CAN, CVE).</p></li>
3721: <li class="listitem"><p>Patches that change source code should mention the
3722: platform and other environment (for example, the compiler) that the
3723: patch is needed for.</p></li>
3724: </ul></div>
3725: <p>The patch should be commented so that any
3726: developer who knows the code of the application can make some use of
3727: the patch. Special care should be taken for the upstream developers,
3728: since we generally want that they accept our patches, so we have less
3729: work in the future.</p>
1.1 dsieger 3730: </div>
1.41 asau 3731: <div class="sect2">
1.1 dsieger 3732: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3733: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3734: <p>One important thing to mention is to pay attention that no RCS
3735: IDs get stored in the patch files, as these will cause problems when
3736: later checked into the NetBSD CVS tree. Use the
1.207 leot 3737: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.184 rillig 3738: problems.</p>
3739: <p>For even more automation, we recommend using
3740: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.222 gutterid 3741: whole set of patches. You just have to back up files before you
3742: edit them to <code class="filename">filename.orig</code>, e.g., with
1.184 rillig 3743: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3744: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3745: you upgrade a package this way, you can easily compare the new
3746: set of patches with the previously existing one with
3747: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3748: are replaced by new files, so carefully check if you want to take all
3749: the changes.</p>
3750: <p>When you have finished a package, remember to generate
3751: the checksums for the patch files by using the <span class="command"><strong>make
3752: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="12.2. distinfo">Section 12.2, “<code class="filename">distinfo</code>”</a>.</p>
3753: <p>When adding a patch that corrects a problem in the
3754: distfile (rather than e.g. enforcing pkgsrc's view of where
3755: man pages should go), send the patch as a bug report to the
3756: maintainer. This benefits non-pkgsrc users of the package,
3757: and usually makes it possible to remove the patch in future
3758: version.</p>
3759: <p>The file names of the patch files are usually of the form
3760: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3761: Many packages still use the previous convention
3762: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3763: but new patches should be of the form containing the filename.
1.207 leot 3764: <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
1.184 rillig 3765: automatically.</p>
1.222 gutterid 3766: <p>When updating pre-existing patch files, if a file uses the old
3767: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
3768: convention, it's best not to change it to the new form, as that will
3769: just cause churn that makes it harder to track changes to patching
3770: over time. Similarly, if a patch now applies at different line offsets,
3771: but still applies cleanly as-is, there's no need to update it, as that
3772: also unnecessarily complicates the patch history.</p>
1.17 imil 3773: </div>
1.160 brook 3774: <div class="sect2">
3775: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3776: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3777: <p>If you want to share patches between multiple packages
3778: in pkgsrc, e.g. because they use the same distfiles, set
3779: <code class="varname">PATCHDIR</code> to the path where the patch files
3780: can be found, e.g.:</p>
3781: <pre class="programlisting">
3782: PATCHDIR= ../../editors/xemacs/patches
3783: </pre>
3784: <p>Patch files that are distributed by the author or other
3785: maintainers can be listed in
3786: <code class="varname">PATCHFILES</code>.</p>
3787: <p>If it is desired to store any patches that should not be
3788: committed into pkgsrc, they can be kept outside the pkgsrc
3789: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3790: directory tree there is expected to have the same
3791: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3792: patches are expected to be stored inside these dirs (also
3793: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3794: example, if you want to keep a private patch for
3795: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3796: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3797: files in the named directory are expected to be patch files,
3798: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3799: applied</em></span>.</p>
1.160 brook 3800: </div>
3801: <div class="sect2">
3802: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3803: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3804: <p>When fixing a portability issue in the code do not use
3805: preprocessor magic to check for the current operating system nor
3806: platform. Doing so hurts portability to other platforms because
3807: the OS-specific details are not abstracted appropriately.</p>
3808: <p>The general rule to follow is: instead of checking for the
3809: operating system the application is being built on, check for the
3810: specific <span class="emphasis"><em>features</em></span> you need. For example,
3811: instead of assuming that kqueue is available under NetBSD and
3812: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3813: kqueue support, add a check that detects kqueue itself —
3814: yes, this generally involves patching the
3815: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3816: that prevents some OSes from adopting interfaces from other OSes
3817: (e.g. Linux implementing kqueue), something that the above checks
3818: cannot take into account.</p>
3819: <p>Of course, checking for features generally involves more
3820: work on the developer's side, but the resulting changes are
3821: cleaner and there are chances they will work on many other
3822: platforms. Not to mention that there are higher chances of being
3823: later integrated into the mainstream sources. Remember:
3824: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3825: <p>Some typical examples:</p>
3826: <div class="table">
3827: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3828: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3829: <colgroup>
3830: <col>
3831: <col>
3832: <col>
3833: </colgroup>
3834: <thead><tr>
3835: <th>Where</th>
3836: <th>Incorrect</th>
3837: <th>Correct</th>
3838: </tr></thead>
3839: <tbody>
3840: <tr>
3841: <td>configure script</td>
3842: <td>
1.160 brook 3843: <pre class="programlisting">
1.184 rillig 3844: case ${target_os} in
3845: netbsd*) have_kvm=yes ;;
3846: *) have_kvm=no ;;
3847: esac
1.160 brook 3848: </pre>
1.184 rillig 3849: </td>
3850: <td>
1.160 brook 3851: <pre class="programlisting">
1.184 rillig 3852: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160 brook 3853: </pre>
1.184 rillig 3854: </td>
3855: </tr>
3856: <tr>
3857: <td>C source file</td>
3858: <td>
1.1 dsieger 3859: <pre class="programlisting">
1.184 rillig 3860: #if defined(__NetBSD__)
3861: # include <sys/event.h>
3862: #endif
1.1 dsieger 3863: </pre>
1.184 rillig 3864: </td>
3865: <td>
1.1 dsieger 3866: <pre class="programlisting">
1.184 rillig 3867: #if defined(HAVE_SYS_EVENT_H)
3868: # include <sys/event.h>
3869: #endif
1.1 dsieger 3870: </pre>
1.184 rillig 3871: </td>
3872: </tr>
3873: <tr>
3874: <td>C source file</td>
3875: <td>
1.1 dsieger 3876: <pre class="programlisting">
1.184 rillig 3877: int
3878: monitor_file(...)
3879: {
3880: #if defined(__NetBSD__)
3881: int fd = kqueue();
3882: ...
3883: #else
3884: ...
3885: #endif
3886: }
1.1 dsieger 3887: </pre>
1.184 rillig 3888: </td>
3889: <td>
1.1 dsieger 3890: <pre class="programlisting">
1.184 rillig 3891: int
3892: monitor_file(...)
3893: {
3894: #if defined(HAVE_KQUEUE)
3895: int fd = kqueue();
3896: ...
3897: #else
3898: ...
3899: #endif
3900: }
1.1 dsieger 3901: </pre>
1.184 rillig 3902: </td>
3903: </tr>
3904: </tbody>
3905: </table></div>
3906: </div>
3907: <br class="table-break">
3908: </div>
3909: <div class="sect2">
3910: <div class="titlepage"><div><div><h3 class="title">
3911: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3912: <p>Always, always, <span class="strong"><strong>always</strong></span>
3913: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3914: improvements you do to a package to the mainstream developers.
3915: This is the only way to get their attention on portability issues
3916: and to ensure that future versions can be built out-of-the box on
3917: NetBSD. Furthermore, any user that gets newer distfiles will get
3918: the fixes straight from the packaged code.</p>
3919: <p>This generally involves cleaning up the patches
3920: (because sometimes the patches that are
3921: added to pkgsrc are quick hacks), filing bug reports in the
3922: appropriate trackers for the projects and working with the
3923: mainstream authors to accept your changes. It is
3924: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3925: the packages in pkgsrc are kept simple and thus further changes
3926: can be done without much hassle.</p>
3927: <p>When you have done this, please add a URL to the upstream
3928: bug report to the patch comment.</p>
3929: <p>Support the idea of free software!</p>
3930: </div>
1.1 dsieger 3931: </div>
1.184 rillig 3932: <div class="sect1">
3933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3934: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3935: <div class="variablelist"><dl class="variablelist">
3936: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3937: <dd><p>A multi-line description of the piece of software. This should include
3938: any credits where they are due. Please bear in mind that others do not
3939: share your sense of humour (or spelling idiosyncrasies), and that others
3940: will read everything that you write here.</p></dd>
3941: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3942: <dd><p>This file governs the files that are installed on your
3943: system: all the binaries, manual pages, etc. There are other
3944: directives which may be entered in this file, to control the
3945: creation and deletion of directories, and the location of
3946: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3947: information.</p></dd>
3948: </dl></div>
3949: </div>
3950: <div class="sect1">
3951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3952: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3953: <div class="sect2">
3954: <div class="titlepage"><div><div><h3 class="title">
3955: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3956: <div class="variablelist"><dl class="variablelist">
3957: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3958: <dd>
1.207 leot 3959: <p>This shell script is invoked twice by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.184 rillig 3960: First time after package extraction and before files are
3961: moved in place, the second time after the files to install
3962: are moved in place. This can be used to do any custom
3963: procedures not possible with @exec commands in
1.207 leot 3964: <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3965: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><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="20.1. Files and directories outside the installation prefix">Section 20.1, “Files and directories outside the installation prefix”</a>.
1.184 rillig 3966: Please note that you can modify variables in it easily by using
3967: <code class="varname">FILES_SUBST</code> in the package's
3968: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3969: <pre class="programlisting">
1.184 rillig 3970: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3971: </pre>
1.184 rillig 3972: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3973: <code class="filename">INSTALL</code>. By default, substitution is
3974: performed for <code class="varname">PREFIX</code>,
3975: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3976: <code class="varname">VARBASE</code>, and a few others, type
3977: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3978: complete list.</p>
3979: </dd>
3980: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3981: <dd><p>This script is executed before and after any files are removed. It is
3982: this script's responsibility to clean up any additional messy details
3983: around the package's installation, since all pkg_delete knows is how to
3984: delete the files created in the original distribution.
1.207 leot 3985: See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
3986: and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.184 rillig 3987: The same methods to replace variables can be used as for
3988: the <code class="filename">INSTALL</code> file.</p></dd>
3989: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
3990: <dd>
3991: <p>This file is displayed after installation of the package.
1.198 leot 3992: While this was used often in the past, it has two
3993: problems: the display will be missed if many packages are
3994: intalled at once, and the person installing the package
3995: and the one using or configuring it may be different. It
3996: should therefore be used only in exceptional circumstances
3997: where lasting negative consequences would result from
3998: someone not reading it.</p>
3999: <p>MESSAGE should not be used for:</p>
4000: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4001: <li class="listitem"><p>exhortations to read the documentation</p></li>
4002: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
4003: <li class="listitem"><p>anything that should be explained in the
4004: installation/configuration documentation that should
4005: come with the package</p></li>
4006: </ul></div>
4007: <p>If the documentation provided by upstream needs
4008: enhancing, create e.g. files/README.pkgsrc and install it
4009: in the package's documentation directory.
4010: </p>
4011: <p>Note that MESSAGE is shown for all operating
4012: systems and all init systems. If a MESSAGE is necessary,
4013: it should be narrowed to only those operating systems and
4014: init systems to which it applies.</p>
4015: <p>Note that you can modify variables in it easily by using
1.184 rillig 4016: <code class="varname">MESSAGE_SUBST</code> in the package's
4017: <code class="filename">Makefile</code>:</p>
1.1 dsieger 4018: <pre class="programlisting">
1.184 rillig 4019: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 4020: </pre>
1.184 rillig 4021: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
4022: <code class="filename">MESSAGE</code>. By default, substitution is
4023: performed for <code class="varname">PKGNAME</code>,
4024: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4025: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4026: <code class="varname">PKG_SYSCONFDIR</code>,
4027: <code class="varname">ROOT_GROUP</code>, and
4028: <code class="varname">ROOT_USER</code>.</p>
4029: <p>You can display a different or additional files by
4030: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4031: default is <code class="filename">MESSAGE</code>, if the file
4032: exists.</p>
4033: </dd>
4034: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4035: <dd>
4036: <p>This file is used by the alternatives framework.
4037: It creates, configures, and destroys generic wrappers used to
4038: run programs with similar interfaces.
4039: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4040: for more information.</p>
4041: <p>Each line of the file contains two filenames, first
4042: the wrapper and then the alternative provided by the package.
4043: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4044: </dd>
4045: </dl></div>
4046: </div>
4047: <div class="sect2">
4048: <div class="titlepage"><div><div><h3 class="title">
4049: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
4050: <div class="variablelist"><dl class="variablelist">
4051: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4052: <dd><p>This file contains arbitrary things that could
4053: also go into a <code class="filename">Makefile</code>, but its purpose is
4054: to be used by more than one package. This file should only be
4055: used when the packages that will use the file are known in
4056: advance. For other purposes it is often better to write a
4057: <code class="filename">*.mk</code> file and give it a good name that
4058: describes what it does.</p></dd>
4059: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4060: <dd><p>This file contains the dependency information
4061: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
4062: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4063: <dd><p>This file contains workarounds for compiler bugs
4064: and similar things. It is included automatically by the pkgsrc
4065: infrastructure, so you don't need an extra
4066: <code class="literal">.include</code> line for
4067: it.</p></dd>
4068: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4069: <dd><p>This file contains the code for the
4070: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
4071: selected by the user. If a package has only one or two options,
4072: it is equally acceptable to put the code directly into the
4073: <code class="filename">Makefile</code>.</p></dd>
4074: </dl></div>
4075: </div>
4076: <div class="sect2">
4077: <div class="titlepage"><div><div><h3 class="title">
4078: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
4079: <div class="variablelist"><dl class="variablelist">
4080: <dt><span class="term"><code class="filename">README*</code></span></dt>
4081: <dd><p>These files do not take place in the creation of
4082: a package and thus are purely informative to the package
4083: developer.</p></dd>
4084: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4085: <dd><p>This file contains things that need to be done
4086: to make the package even
4087: better.</p></dd>
4088: </dl></div>
4089: </div>
4090: </div>
4091: <div class="sect1">
4092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4093: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
4094: </h2></div></div></div>
4095: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4096: unpacked into the directory denoted by
4097: <code class="varname">WRKDIR</code>. It can be removed by running
4098: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4099: directory is also used to keep various timestamp files.
4100: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4101: The default is <code class="filename">${.CURDIR}/work</code>
4102: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4103: if <code class="varname">OBJMACHINE</code> is set.</p>
1.1 dsieger 4104: </div>
1.184 rillig 4105: <div class="sect1">
4106: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4107: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4108: </h2></div></div></div>
4109: <p>If you have any files that you wish to be placed in the package
4110: prior to configuration or building, you can place these files here
4111: and use a <span class="command"><strong>${CP}</strong></span> command in the
4112: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4113: <p>If you want to share files in this way with other
4114: packages, set the <code class="varname">FILESDIR</code> variable to point
4115: to the other package's <code class="filename">files</code> directory,
4116: e.g.:</p>
1.1 dsieger 4117: <pre class="programlisting">
1.184 rillig 4118: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4119: </pre>
4120: </div>
4121: </div>
1.41 asau 4122: <div class="chapter">
1.1 dsieger 4123: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 4124: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1 dsieger 4125: <div class="toc">
4126: <p><b>Table of Contents</b></p>
1.100 leot 4127: <dl class="toc">
1.184 rillig 4128: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4129: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4130: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4131: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4132: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4133: <dd><dl>
4134: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4135: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4136: </dl></dd>
4137: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4138: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4139: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4140: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4141: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4142: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4143: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4144: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4145: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4146: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4147: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4148: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1 dsieger 4149: </dl>
4150: </div>
1.41 asau 4151: <div class="sect1">
1.1 dsieger 4152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4153: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4154: <p>This chapter gives a detailed description on how a package is
4155: built. Building a package is separated into different
4156: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4157: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4158: described in the following sections. Each phase is split into
4159: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4160: containing phase, prefixed by one of <code class="varname">pre-</code>,
4161: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4162: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4163: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4164: <p>Never override the regular targets (like
4165: <code class="varname">fetch</code>), if you have to, override the
4166: <code class="varname">do-*</code> ones instead.</p>
4167: <p>The basic steps for building a program are always the same. First
4168: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4169: the local system and then extracted. After any pkgsrc-specific patches
4170: to compile properly are applied, the software can be configured, then
4171: built (usually by compiling), and finally the generated binaries, etc.
4172: can be put into place on the system.</p>
4173: <p>To get more details about what is happening at each step,
4174: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4175: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4176: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4177: </div>
4178: <div class="sect1">
4179: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4180: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4181: <p>Before outlining the process performed by the NetBSD package system in
4182: the next section, here's a brief discussion on where programs are
4183: installed, and which variables influence this.</p>
4184: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4185: where all files of the final program shall be installed. It is
4186: usually set to <code class="varname">LOCALBASE</code>
4187: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4188: for pkgs in the <code class="filename">cross</code> category. The value of
4189: <code class="varname">PREFIX</code> needs to be put
4190: into the various places in the program's source where paths to
4191: these files are encoded. See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.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>
4192: <p>When choosing which of these variables to use,
4193: follow the following rules:</p>
1.41 asau 4194: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 4195: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4196: where the current pkg will be installed. When referring to a
4197: pkg's own installation path, use
4198: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.223 nia 4199: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.184 rillig 4200: are installed. If you need to construct a -I or -L argument
4201: to the compiler to find includes and libraries installed by
1.223 nia 4202: another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.184 rillig 4203: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4204: installed all packages in <code class="filename">/usr/local</code>. As
4205: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4206: administrator, this variable is a misnomer.</p></li>
4207: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4208: distribution (from xsrc, etc.) is installed. When looking for
4209: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4210: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4211: <li class="listitem"><p>X11-based packages using imake must set
4212: <code class="varname">USE_IMAKE</code> to be installed correctly under
4213: <code class="varname">LOCALBASE</code>.</p></li>
4214: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.207 leot 4215: install files according to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.184 rillig 4216: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4217: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4218: </ul></div>
4219: </div>
4220: <div class="sect1">
4221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4222: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4223: <p>When building a package, various directories are used to store
4224: source files, temporary files, pkgsrc-internal files, and so on. These
4225: directories are explained here.</p>
4226: <p>Some of the directory variables contain relative pathnames. There
4227: are two common base directories for these relative directories:
4228: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4229: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4230: inside the package itself.</p>
4231: <div class="variablelist"><dl class="variablelist">
4232: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4233: <dd><p>This is an absolute pathname that points to the pkgsrc
4234: root directory. Generally, you don't need
4235: it.</p></dd>
4236: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4237: <dd><p>This is an absolute pathname that points to the
4238: current package.</p></dd>
4239: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.228 gutterid 4240: <dd>
4241: <p>This is a pathname relative to
4242: <code class="varname">PKGSRCDIR</code> that points to the current package.
4243: It is defined after including <code class="filename">bsd.prefs.mk</code>
4244: and can be used in makefile fragments that are used by several
4245: packages to distinguish between these packages. Other variables
4246: that would serve the same purpose are <code class="varname">PKGBASE</code>
4247: and <code class="varname">PKGNAME</code>, but these are only defined after
4248: including <code class="filename">bsd.pkg.mk</code>, which is too
4249: late.</p>
4250: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
4251: <code class="varname">PKGPATH</code> to tweak variables like
4252: <code class="varname">MAKE_JOBS</code> and
4253: <code class="varname">CFLAGS</code>.</p>
4254: </dd>
1.184 rillig 4255: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4256: <dd><p>This is an absolute pathname pointing to the directory
4257: where all work takes place. The distfiles are extracted to this
4258: directory. It also contains temporary directories and log files used by
4259: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4260: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4261: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4262: <dd><p>This is an absolute pathname pointing to the directory
4263: where the distfiles are extracted. It is usually a direct subdirectory
4264: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4265: that isn't hidden. This variable may be changed by a package
4266: <code class="filename">Makefile</code>.</p></dd>
4267: </dl></div>
4268: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4269: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4270: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4271: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4272: If users would like to have their pkgsrc trees behave in a
4273: read-only manner, then the value of
4274: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4275: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 4276: </div>
1.41 asau 4277: <div class="sect1">
1.1 dsieger 4278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4279: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4280: <p>You can run a particular phase by typing <span class="command"><strong>make
1.228 gutterid 4281: <em class="replaceable"><code>phase</code></em></strong></span>, where
4282: <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
4283: automatically run all phases that are required for this phase. The
4284: default phase is <code class="varname">build</code>, that is, when you run
4285: <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.184 rillig 4286: the package will be built, but not installed.</p>
1.1 dsieger 4287: </div>
1.41 asau 4288: <div class="sect1">
1.1 dsieger 4289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4290: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4291: <p>The first step in building a package is to fetch the
4292: distribution files (distfiles) from the sites that are providing
4293: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4294: phase.</p>
1.41 asau 4295: <div class="sect2">
1.1 dsieger 4296: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 4297: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4298: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4299: defines all URLs from where the distfile, whose name is
4300: derived from the <code class="varname">DISTNAME</code> variable, is
4301: fetched. The more complicated cases are described
4302: below.</p>
4303: <p>The variable <code class="varname">DISTFILES</code> specifies
4304: the list of distfiles that have to be fetched. Its value
4305: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4306: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4307: so that most packages don't need to define it at all.
4308: <code class="varname">EXTRACT_SUFX</code> is
4309: <code class="literal">.tar.gz</code> by default, but can be changed
4310: freely. Note that if your package requires additional
4311: distfiles to the default one, you cannot just append the
4312: additional filenames using the <code class="literal">+=</code>
4313: operator, but you have write for example:</p>
4314: <pre class="programlisting">
4315: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4316: </pre>
4317: <p>Each distfile is fetched from a list of sites, usually
4318: <code class="varname">MASTER_SITES</code>. If the package has multiple
4319: <code class="varname">DISTFILES</code> or multiple
4320: <code class="varname">PATCHFILES</code> from different sites, you can
4321: set
4322: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4323: to the list of URLs where the file
4324: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4325: (including the suffix) can be found.</p>
4326: <pre class="programlisting">
4327: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4328: DISTFILES+= foo-file.tar.gz
4329: SITES.foo-file.tar.gz= \
4330: https://www.somewhere.com/somehow/ \
4331: https://www.somewhereelse.com/mirror/somehow/
4332: </pre>
4333: <p>When actually fetching the distfiles, each item from
4334: <code class="varname">MASTER_SITES</code> or
4335: <code class="varname">SITES.*</code> gets the name of each distfile
4336: appended to it, without an intermediate slash. Therefore,
4337: all site values have to end with a slash or other separator
4338: character. This allows for example to set
4339: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4340: that gets the name of the distfile as a parameter. In this
4341: case, the definition would look like:</p>
4342: <pre class="programlisting">
4343: MASTER_SITES= https://www.example.com/download.cgi?file=
4344: </pre>
4345: <p> The exception to this rule are URLs starting with a dash.
4346: In that case the URL is taken as is, fetched and the result
4347: stored under the name of the distfile. You can use this style
4348: for the case when the download URL style does not match the
4349: above common case. For example, if permanent download URL is a
4350: redirector to the real download URL, or the download file name
4351: is offered by an HTTP Content-Disposition header. In the
4352: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4353: created instead of the default
4354: <code class="filename">v1.0.0.tar.gz</code>.</p>
4355: <pre class="programlisting">
4356: DISTNAME= foo-1.0.0
4357: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4358: </pre>
4359: <p>There are some predefined values for
4360: <code class="varname">MASTER_SITES</code>, which can be used in
4361: packages. The names of the variables should speak for
4362: themselves.</p>
4363: <table border="0" summary="Simple list" class="simplelist">
4364: <tr>
4365: <td>MASTER_SITE_APACHE</td>
4366: <td>MASTER_SITE_BACKUP</td>
4367: </tr>
4368: <tr>
4369: <td>MASTER_SITE_CRATESIO</td>
4370: <td>MASTER_SITE_CYGWIN</td>
4371: </tr>
4372: <tr>
4373: <td>MASTER_SITE_DEBIAN</td>
4374: <td>MASTER_SITE_FREEBSD</td>
4375: </tr>
4376: <tr>
4377: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4378: <td>MASTER_SITE_GENTOO</td>
4379: </tr>
4380: <tr>
4381: <td>MASTER_SITE_GITHUB</td>
1.225 gutterid 4382: <td>MASTER_SITE_GITLAB</td>
4383: </tr>
4384: <tr>
1.184 rillig 4385: <td>MASTER_SITE_GNOME</td>
1.225 gutterid 4386: <td>MASTER_SITE_GNU</td>
1.184 rillig 4387: </tr>
4388: <tr>
4389: <td>MASTER_SITE_GNUSTEP</td>
1.225 gutterid 4390: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.184 rillig 4391: </tr>
4392: <tr>
4393: <td>MASTER_SITE_IFARCHIVE</td>
1.225 gutterid 4394: <td>MASTER_SITE_KDE</td>
1.184 rillig 4395: </tr>
4396: <tr>
4397: <td>MASTER_SITE_MOZILLA</td>
1.225 gutterid 4398: <td>MASTER_SITE_MOZILLA_ALL</td>
1.184 rillig 4399: </tr>
4400: <tr>
4401: <td>MASTER_SITE_MYSQL</td>
1.225 gutterid 4402: <td>MASTER_SITE_NETLIB</td>
1.184 rillig 4403: </tr>
4404: <tr>
4405: <td>MASTER_SITE_OPENBSD</td>
1.225 gutterid 4406: <td>MASTER_SITE_OPENOFFICE</td>
1.184 rillig 4407: </tr>
4408: <tr>
4409: <td>MASTER_SITE_OSDN</td>
1.225 gutterid 4410: <td>MASTER_SITE_PERL_CPAN</td>
1.184 rillig 4411: </tr>
4412: <tr>
4413: <td>MASTER_SITE_PGSQL</td>
1.225 gutterid 4414: <td>MASTER_SITE_PYPI</td>
1.184 rillig 4415: </tr>
4416: <tr>
4417: <td>MASTER_SITE_RUBYGEMS</td>
1.225 gutterid 4418: <td>MASTER_SITE_R_CRAN</td>
1.184 rillig 4419: </tr>
4420: <tr>
4421: <td>MASTER_SITE_SOURCEFORGE</td>
1.225 gutterid 4422: <td>MASTER_SITE_SUNSITE</td>
1.184 rillig 4423: </tr>
1.1 dsieger 4424: <tr>
1.184 rillig 4425: <td>MASTER_SITE_SUSE</td>
1.225 gutterid 4426: <td>MASTER_SITE_TEX_CTAN</td>
1.1 dsieger 4427: </tr>
4428: <tr>
1.184 rillig 4429: <td>MASTER_SITE_XCONTRIB</td>
1.225 gutterid 4430: <td>MASTER_SITE_XEMACS</td>
1.1 dsieger 4431: </tr>
4432: <tr>
1.184 rillig 4433: <td>MASTER_SITE_XORG</td>
1.225 gutterid 4434: <td> </td>
1.184 rillig 4435: </tr>
4436: </table>
4437: <p>Some explanations for the less self-explaining ones:
4438: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
4439: 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
4440: 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>
4441: <p>If you choose one of these predefined sites, you may
4442: want to specify a subdirectory of that site. Since these
4443: macros may expand to more than one actual site, you
4444: <span class="emphasis"><em>must</em></span> use the following construct to
4445: specify a subdirectory:</p>
1.1 dsieger 4446: <pre class="programlisting">
1.184 rillig 4447: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4448: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 4449: </pre>
1.184 rillig 4450: <p>Note the trailing slash after the subdirectory
4451: name.</p>
4452: </div>
4453: <div class="sect2">
4454: <div class="titlepage"><div><div><h3 class="title">
4455: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4456: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4457: all the distfiles exist in a local directory
4458: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4459: user). If the files do not exist, they are fetched using
4460: commands of the form</p>
1.1 dsieger 4461: <pre class="programlisting">
1.184 rillig 4462: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4463: </pre>
4464: <p>where <code class="literal">${site}</code> varies through
4465: several possibilities in turn: first,
4466: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4467: sites specified in either <code class="varname">SITES.file</code> if
4468: defined, else <code class="varname">MASTER_SITES</code> or
4469: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4470: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4471: all except the first and the last can be optionally sorted
4472: by the user, via setting either
4473: <code class="varname">MASTER_SORT_RANDOM</code>, and
4474: <code class="varname">MASTER_SORT_AWK</code> or
4475: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4476: <p> The specific command and arguments used depend on the
4477: <code class="varname">FETCH_USING</code> parameter. The example above is
4478: for <code class="literal">FETCH_USING=custom</code>.</p>
4479: <p>The distfiles mirror run by the NetBSD Foundation uses the
4480: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4481: distfiles, if they are freely distributable. Packages setting
4482: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4483: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4484: mirrored.</p>
1.1 dsieger 4485: </div>
4486: </div>
1.184 rillig 4487: <div class="sect1">
4488: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4489: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4490: <p>After the distfile(s) are fetched, their checksum is
4491: generated and compared with the checksums stored in the
4492: distinfo file. If the checksums don't match, the build is
4493: aborted. This is to ensure the same distfile is used for
4494: building, and that the distfile wasn't changed, e.g. by some
4495: malign force, deliberately changed distfiles on the master
4496: distribution site or network lossage.</p>
1.1 dsieger 4497: </div>
1.41 asau 4498: <div class="sect1">
1.1 dsieger 4499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4500: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4501: <p>When the distfiles are present on the local system, they
4502: need to be extracted, as they usually come in the form of some
4503: compressed archive format.</p>
4504: <p>By default, all <code class="varname">DISTFILES</code> are
4505: extracted. If you only need some of them, you can set the
4506: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4507: files.</p>
4508: <p>Extracting the files is usually done by a little
4509: program, <code class="filename">mk/extract/extract</code>, which
4510: already knows how to extract various archive formats, so most
4511: likely you will not need to change anything here. But if you
4512: need, the following variables may help you:</p>
1.41 asau 4513: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4514: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4515: <dd><p>Use these variables to override the default
4516: options for an extract command, which are defined in
4517: <code class="filename">mk/extract/extract</code>.</p></dd>
4518: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4519: <dd><p>This variable can be set to
4520: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4521: (which is the default value), <code class="literal">pax</code>, or an
4522: absolute pathname pointing to the command with which tar
4523: archives should be extracted. It is preferred to choose bsdtar over gtar
4524: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 4525: </dl></div>
1.184 rillig 4526: <p>If the <code class="filename">extract</code> program doesn't
4527: serve your needs, you can also override the
4528: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4529: command used for extracting the files. This command is
4530: executed in the <code class="filename">${WRKSRC}</code>
4531: directory. During execution of this command, the shell
4532: variable <code class="varname">extract_file</code> holds the absolute
4533: pathname of the file that is going to be extracted.</p>
4534: <p>And if that still does not suffice, you can override the
4535: <code class="varname">do-extract</code> target in the package
4536: Makefile.</p>
1.1 dsieger 4537: </div>
1.41 asau 4538: <div class="sect1">
1.1 dsieger 4539: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4540: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4541: <p>After extraction, all the patches named by the
4542: <code class="varname">PATCHFILES</code>, those present in the patches
4543: subdirectory of the package as well as in
4544: $LOCALPATCHES/$PKGPATH (e.g.
4545: <code class="filename">/usr/local/patches/graphics/png</code>) are
4546: applied. Patchfiles ending in <code class="filename">.Z</code> or
4547: <code class="filename">.gz</code> are uncompressed before they are
4548: applied, files ending in <code class="filename">.orig</code> or
4549: <code class="filename">.rej</code> are ignored. Any special options to
1.207 leot 4550: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.184 rillig 4551: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, “<code class="filename">patches/*</code>”</a> for more details.</p>
1.207 leot 4552: <p>By default <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.184 rillig 4553: fail if the expected text from the patch context is not found in the
4554: patched file. If that happens, fix the patch file by comparing it
4555: with the actual text in the file to be patched.</p>
1.1 dsieger 4556: </div>
1.41 asau 4557: <div class="sect1">
1.1 dsieger 4558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4559: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4560: <p>This is covered in <a class="xref" href="#tools" title="Chapter 17. Tools needed for building or running">Chapter 17, <i>Tools needed for building or running</i></a>.
4561: </p>
1.1 dsieger 4562: </div>
1.41 asau 4563: <div class="sect1">
1.1 dsieger 4564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4565: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4566: <p>This phase creates wrapper programs for the compilers and
4567: linkers. The following variables can be used to tweak the
4568: wrappers.</p>
4569: <div class="variablelist"><dl class="variablelist">
4570: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4571: <dd><p>The command used to print progress
4572: messages. Does nothing by default. Set to
4573: <code class="literal">${ECHO}</code> to see the progress
4574: messages.</p></dd>
4575: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4576: <dd><p>This variable can be set to
4577: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4578: depending on whether you want additional information in the
4579: wrapper log file.</p></dd>
4580: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4581: <dd><p>This variable can be set to
4582: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4583: on whether the wrapper should use its cache, which will
4584: improve the speed. The default value is
4585: <code class="literal">yes</code>, but is forced to
4586: <code class="literal">no</code> if the platform does not support
4587: it.</p></dd>
4588: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4589: <dd><p>A list of reordering commands. A reordering
4590: command has the form
4591: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4592: It ensures that that
4593: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4594: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4595: </p></dd>
4596: </dl></div>
4597: </div>
4598: <div class="sect1">
4599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4600: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4601: <p>Most pieces of software need information on the header
4602: files, system calls, and library routines which are available
4603: on the platform they run on. The process of determining this
4604: information is known as configuration, and is usually
4605: automated. In most cases, a script is supplied with the
4606: distfiles, and its invocation results in generation of header
4607: files, Makefiles, etc.</p>
4608: <p>If the package contains a configure script, this can be
4609: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4610: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4611: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.187 rillig 4612: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4613: <p>In the <code class="literal">do-configure</code> stage, a rough
4614: equivalent of the following command is run. See
4615: <code class="filename">mk/configure/configure.mk</code>, target
4616: <code class="literal">do-configure-script</code> for the exact
4617: definition.</p>
4618: <pre class="programlisting">
4619: .for dir in ${CONFIGURE_DIRS}
4620: cd ${WRKSRC} && cd ${dir} \
4621: && env ${CONFIGURE_ENV} \
4622: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 4623: .endfor
1.1 dsieger 4624: </pre>
1.184 rillig 4625: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4626: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4627: <code class="varname">WRKSRC</code>. In each of these directories, the
4628: configure script is run with the environment
4629: <code class="varname">CONFIGURE_ENV</code> and arguments
4630: <code class="varname">CONFIGURE_ARGS</code>. The variables
4631: <code class="varname">CONFIGURE_ENV</code>,
4632: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4633: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4634: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4635: package.</p>
4636: <p>If the program uses the Perl way of configuration (mainly Perl
4637: modules, but not only), i.e. a file called
4638: <code class="filename">Makefile.PL</code>, it should include
4639: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4640: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4641: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4642: <p>If the program uses an <code class="filename">Imakefile</code>
4643: for configuration, the appropriate steps can be invoked by
4644: setting <code class="varname">USE_IMAKE</code> to
4645: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4646: You can add variables to xmkmf's environment by adding them to the
4647: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4648: <p>If the program uses <code class="filename">cmake</code>
4649: for configuration, the appropriate steps can be invoked by
1.233 wiz 4650: including <code class="filename">../../devel/cmake/build.mk</code>.
1.184 rillig 4651: You can add variables to cmake's environment by adding them to the
4652: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4653: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
1.233 wiz 4654: If you want to add arguments only for particular stages, you can use the
4655: <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
4656: <code class="varname">CMAKE_BUILD_ARGS</code>, and
4657: <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
4658: You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
4659: directories in which CMake should be run, relative to
4660: <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
4661: </p>
1.184 rillig 4662: <p>If there is no configure step at all, set
4663: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4664: </div>
1.41 asau 4665: <div class="sect1">
1.1 dsieger 4666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4667: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187 rillig 4668: <p>For building a package, a rough equivalent of the following
4669: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4670: <code class="literal">do-build</code> for the exact definition.</p>
1.1 dsieger 4671: <pre class="programlisting">
1.187 rillig 4672: .for dir in ${BUILD_DIRS}
4673: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 4674: && env ${MAKE_ENV} \
1.187 rillig 4675: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 4676: -f ${MAKE_FILE} \
4677: ${BUILD_TARGET}
4678: .endfor
1.1 dsieger 4679: </pre>
1.184 rillig 4680: <p><code class="varname">BUILD_DIRS</code> (default:
4681: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4682: <code class="varname">WRKSRC</code>. In each of these directories,
4683: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4684: <code class="varname">MAKE_ENV</code> and arguments
4685: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4686: <code class="varname">MAKE_ENV</code>,
4687: <code class="varname">BUILD_MAKE_FLAGS</code>,
4688: <code class="varname">MAKE_FILE</code> and
4689: <code class="varname">BUILD_TARGET</code> may all be changed by the
4690: package.</p>
4691: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4692: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4693: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4694: default value of <code class="varname">MAKE_FILE</code> is
4695: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4696: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4697: <p>If there is no build step at all, set
4698: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4699: </div>
1.41 asau 4700: <div class="sect1">
1.1 dsieger 4701: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4702: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4703: <p>[TODO]</p>
1.1 dsieger 4704: </div>
1.41 asau 4705: <div class="sect1">
1.1 dsieger 4706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4707: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4708: <p>Once the build stage has completed, the final step is to
4709: install the software in public directories, so users can
4710: access the programs and files.</p>
1.187 rillig 4711: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4712: of the following code is executed; see
4713: <code class="filename">mk/install/install.mk</code>, target
4714: <code class="literal">do-install</code> for the exact definition. Additionally,
4715: before and after this code, several consistency checks are run
4716: against the files-to-be-installed, see
4717: <code class="filename">mk/check/*.mk</code> for details.</p>
4718: <pre class="programlisting">
4719: .for dir in ${INSTALL_DIRS}
4720: cd ${WRKSRC} && cd ${dir} \
4721: && env ${INSTALL_ENV} ${MAKE_ENV} \
4722: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4723: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 4724: .endfor
1.1 dsieger 4725: </pre>
1.184 rillig 4726: <p>The variable's meanings are analogous to the ones in the
4727: <span class="emphasis"><em>build</em></span> phase.
4728: <code class="varname">INSTALL_DIRS</code> defaults to
4729: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4730: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4731: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4732: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4733: defined.</p>
4734: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4735: variables are useful. They are all variations of the
1.207 leot 4736: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.184 rillig 4737: permissions preset. <code class="varname">INSTALL</code> is the plain
4738: install command. The specialized variants, together with their
4739: intended use, are:</p>
4740: <div class="variablelist"><dl class="variablelist">
4741: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4742: <dd><p>directories that contain
4743: binaries</p></dd>
4744: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4745: <dd><p>directories that contain
4746: scripts</p></dd>
4747: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4748: <dd><p>directories that contain shared and static
4749: libraries</p></dd>
4750: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4751: <dd><p>directories that contain data
4752: files</p></dd>
4753: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4754: <dd><p>directories that contain man
4755: pages</p></dd>
4756: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4757: <dd><p>directories that contain data files for games
4758: </p></dd>
4759: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4760: <dd><p>binaries that can be stripped from debugging
4761: symbols</p></dd>
4762: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4763: <dd><p>binaries that cannot be
4764: stripped</p></dd>
4765: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4766: <dd><p>game
4767: binaries</p></dd>
4768: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4769: <dd><p>shared and static
4770: libraries</p></dd>
4771: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4772: <dd><p>data files</p></dd>
4773: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4774: <dd><p>data files for
4775: games</p></dd>
4776: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4777: <dd><p>man pages</p></dd>
4778: </dl></div>
4779: <p>Some other variables are:</p>
4780: <div class="variablelist"><dl class="variablelist">
4781: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.207 leot 4782: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.184 rillig 4783: when installing binaries. Any debugging sections and symbols present in
4784: binaries will be preserved.
4785: </p></dd>
4786: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4787: <dd><p>A list of directories relative to
4788: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4789: beginning of the <span class="emphasis"><em>install</em></span> phase.
4790: The package is supposed to create all needed directories itself
4791: before installing files to it and list all other directories here.
4792: </p></dd>
4793: </dl></div>
4794: <p>In the rare cases that a package shouldn't install anything,
4795: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4796: mostly relevant for packages in the <code class="filename">regress</code>
4797: category.</p>
1.1 dsieger 4798: </div>
1.41 asau 4799: <div class="sect1">
1.1 dsieger 4800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4801: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4802: <p>Once the install stage has completed, a binary package of
4803: the installed files can be built. These binary packages can be
4804: used for quick installation without previous compilation, e.g. by
4805: the <span class="command"><strong>make bin-install</strong></span> or by using
4806: <span class="command"><strong>pkg_add</strong></span>.</p>
4807: <p>By default, the binary packages are created in
4808: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4809: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4810: one for each category in the <code class="varname">CATEGORIES</code>
4811: variable. <code class="varname">PACKAGES</code> defaults to
4812: <code class="filename">pkgsrc/packages</code>.</p>
1.1 dsieger 4813: </div>
1.41 asau 4814: <div class="sect1">
1.1 dsieger 4815: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4816: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4817: <p>Once you're finished with a package, you can clean the work
4818: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4819: to clean the work directories of all dependencies too, use
4820: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 4821: </div>
1.41 asau 4822: <div class="sect1">
1.1 dsieger 4823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4824: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41 asau 4825: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4826: <dt><span class="term">pre/post-*</span></dt>
4827: <dd>
4828: <p>For any of the main targets described in the previous
4829: section (configure, build, install, etc.), two auxiliary
4830: targets exist with
4831: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4832: prefix for the main target's name. These targets are
4833: invoked before and after the main target is called,
4834: allowing extra configuration or installation steps be
4835: performed from a package's Makefile, for example, which
4836: a program's configure script or install target
4837: omitted.</p>
4838: <p>About 5% of the pkgsrc packages define their custom
4839: post-extract target, another 5% define pre-configure, and 10%
4840: define post-install. The other pre/post-* targets are defined
4841: even less often.</p>
4842: </dd>
4843: <dt><span class="term">do-*</span></dt>
1.1 dsieger 4844: <dd>
1.184 rillig 4845: <p>Should one of the main targets do the wrong thing,
4846: and should there be no variable to fix this, you can
4847: redefine it with the do-* target. (Note that redefining
4848: the target itself instead of the do-* target is a bad
4849: idea, as the pre-* and post-* targets won't be called
4850: anymore, etc.)</p>
4851: <p>About 15% of the pkgsrc packages override the default
4852: do-install, the other do-* targets are overridden even less
4853: often.</p>
1.1 dsieger 4854: </dd>
1.184 rillig 4855: <dt><span class="term">reinstall</span></dt>
1.1 dsieger 4856: <dd>
1.184 rillig 4857: <p>If you did a <span class="command"><strong>make install</strong></span> and
4858: you noticed some file was not installed properly, you
4859: can repeat the installation with this target, which will
4860: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4861: <p>This is the default value of
4862: <code class="varname">DEPENDS_TARGET</code> except in the case of
4863: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4864: package</strong></span>, where the defaults are
4865: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4866: respectively.</p>
1.1 dsieger 4867: </dd>
1.184 rillig 4868: <dt><span class="term">deinstall</span></dt>
4869: <dd>
1.207 leot 4870: <p>This target does a <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.184 rillig 4871: current directory, effectively de-installing the
4872: package. The following variables can be used to tune the
4873: behaviour:</p>
4874: <div class="variablelist"><dl class="variablelist">
4875: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.207 leot 4876: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.184 rillig 4877: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4878: <dd><p>Remove all packages that require (depend on)
4879: the given package. This can be used to remove any
4880: packages that may have been pulled in by a given
4881: package, e.g. if <span class="command"><strong>make deinstall
4882: DEINSTALLDEPENDS=1</strong></span> is done in
4883: <code class="filename">pkgsrc/x11/kde</code>, this is
4884: likely to remove whole KDE. Works by adding
1.207 leot 4885: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.184 rillig 4886: command line.</p></dd>
4887: </dl></div>
4888: </dd>
4889: <dt><span class="term">bin-install</span></dt>
4890: <dd><p>Install a binary package from local disk and via FTP
4891: from a list of sites (see the
4892: <code class="varname">BINPKG_SITES</code> variable), and do a
4893: <span class="command"><strong>make package</strong></span> if no binary package is
4894: available anywhere. The arguments given to
4895: <span class="command"><strong>pkg_add</strong></span> can be set via
4896: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4897: operation, etc.</p></dd>
4898: <dt><span class="term">install-clean</span></dt>
4899: <dd><p>This target removes the state files for the "install" and later
4900: phases so that the "install" target may be re-invoked. This can be
4901: used after editing the PLIST to install the package without
4902: rebuilding it.</p></dd>
4903: <dt><span class="term">build-clean</span></dt>
4904: <dd><p>This target removes the state files for the "build" and later
4905: phases so that the "build" target may be re-invoked.</p></dd>
4906: <dt><span class="term">update</span></dt>
4907: <dd>
4908: <p>This target causes the current package to be
4909: updated to the latest version. The package and all
4910: depending packages first get de-installed, then current
4911: versions of the corresponding packages get compiled and
4912: installed. This is similar to manually noting which
4913: packages are currently installed, then performing a
4914: series of <span class="command"><strong>make deinstall</strong></span> and
4915: <span class="command"><strong>make install</strong></span> (or whatever
4916: <code class="varname">UPDATE_TARGET</code> is set to) for these
4917: packages.</p>
4918: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4919: resume package updating in case a previous <span class="command"><strong>make
4920: update</strong></span> was interrupted for some reason.
4921: However, in this case, make sure you don't call
4922: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4923: list of dependent packages in <code class="varname">WRKDIR</code>.
4924: Otherwise, you lose the ability to automatically update
4925: the current package along with the dependent packages
4926: you have installed.</p>
4927: <p>Resuming an interrupted <span class="command"><strong>make
4928: update</strong></span> will only work as long as the package
4929: tree remains unchanged. If the source code for one of
4930: the packages to be updated has been changed, resuming
4931: <span class="command"><strong>make update</strong></span> will most certainly
4932: fail!</p>
4933: <p>The following variables can be used either on the
4934: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4935: alter the behaviour of <span class="command"><strong>make
4936: update</strong></span>:</p>
4937: <div class="variablelist"><dl class="variablelist">
4938: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4939: <dd><p>Install target to recursively use for the
4940: updated package and the dependent packages.
4941: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4942: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4943: <span class="command"><strong>make update</strong></span>. Other good
4944: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4945: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4946: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4947: endless loop!</p></dd>
4948: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4949: <dd><p>Don't clean up after updating. Useful if
4950: you want to leave the work sources of the updated
4951: packages around for inspection or other purposes.
4952: Be sure you eventually clean up the source tree
4953: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4954: or you may run into troubles with old source code
4955: still lying around on your next
4956: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4957: update</strong></span>.</p></dd>
4958: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4959: <dd><p>Deinstall each package before installing
4960: (making <code class="varname">DEPENDS_TARGET</code>). This
4961: may be necessary if the
4962: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4963: called after interrupting a running <span class="command"><strong>make
4964: update</strong></span>.</p></dd>
4965: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4966: <dd><p>Allows you to disable recursion and hardcode
4967: the target for packages. The default is
4968: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4969: facilitating a recursive update of prerequisite
4970: packages. Only set
4971: <code class="varname">DEPENDS_TARGET</code> if you want to
4972: disable recursive updates. Use
4973: <code class="varname">UPDATE_TARGET</code> instead to just
4974: set a specific target for each package to be
4975: installed during <span class="command"><strong>make update</strong></span>
4976: (see above).</p></dd>
4977: </dl></div>
4978: </dd>
4979: <dt><span class="term">clean-update</span></dt>
4980: <dd>
4981: <p>Clean the source tree for all packages that would
4982: get updated if <span class="command"><strong>make update</strong></span> was called
4983: from the current directory. This target should not be
4984: used if the current package (or any of its depending
4985: packages) have already been de-installed (e.g., after
4986: calling <span class="command"><strong>make update</strong></span>) or you may lose
4987: some packages you intended to update. As a rule of
4988: thumb: only use this target <span class="emphasis"><em>before</em></span>
4989: the first time you run <span class="command"><strong>make update</strong></span>
4990: and only if you have a dirty package tree (e.g., if you
4991: used <code class="varname">NOCLEAN</code>).</p>
4992: <p>If you are unsure about whether your tree is
4993: clean, you can either perform a <span class="command"><strong>make
4994: clean</strong></span> at the top of the tree, or use the
4995: following sequence of commands from the directory of the
4996: package you want to update (<span class="emphasis"><em>before</em></span>
4997: running <span class="command"><strong>make update</strong></span> for the first
4998: time, otherwise you lose all the packages you wanted to
4999: update!):</p>
5000: <pre class="screen">
5001: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
5002: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
5003: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
5004: </pre>
5005: <p>The following variables can be used either on the
5006: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
5007: <span class="command"><strong>make clean-update</strong></span>:</p>
5008: <div class="variablelist"><dl class="variablelist">
5009: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
5010: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
5011: reconstruct the list of directories to update for
5012: this package. Only use this if <span class="command"><strong>make
5013: update</strong></span> successfully installed all
5014: packages you wanted to update. Normally, this is
5015: done automatically on <span class="command"><strong>make
5016: update</strong></span>, but may have been suppressed by
5017: the <code class="varname">NOCLEAN</code> variable (see
5018: above).</p></dd>
5019: </dl></div>
5020: </dd>
5021: <dt><span class="term">replace</span></dt>
5022: <dd>
5023: <p>Update the installation of the current package. This
5024: differs from update in that it does not replace dependent
1.207 leot 5025: packages. You will need to install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/index.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.184 rillig 5026: target to work.</p>
5027: <p><span class="emphasis"><em>Be careful when using this
5028: target!</em></span> There are no guarantees that dependent
5029: packages will still work, in particular they will most
5030: certainly break if you <span class="command"><strong>make replace</strong></span> a
5031: library package whose shared library major version changed
5032: between your installed version and the new one. For this
5033: reason, this target is not officially supported and only
5034: recommended for advanced users.</p>
5035: </dd>
5036: <dt><span class="term">info</span></dt>
1.207 leot 5037: <dd><p>This target invokes <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.184 rillig 5038: package. You can use this to check which version of a
5039: package is installed.</p></dd>
5040: <dt><span class="term">index</span></dt>
5041: <dd>
5042: <p>This is a top-level command, i.e. it should be used in
5043: the <code class="filename">pkgsrc</code> directory. It creates a
5044: database of all packages in the local pkgsrc tree, including
5045: dependencies, comment, maintainer, and some other useful
5046: information. Individual entries are created by running
5047: <span class="command"><strong>make describe</strong></span> in the packages'
5048: directories. This index file is saved as
5049: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
5050: verbose format by running <span class="command"><strong>make
5051: print-index</strong></span>. You can search in it with
5052: <span class="command"><strong>make search
5053: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
5054: extract a list of all packages that depend on a particular
5055: one by running <span class="command"><strong>make show-deps
5056: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
5057: <p>Running this command takes a very long time, some
5058: hours even on fast machines!</p>
5059: </dd>
5060: <dt><span class="term">readme</span></dt>
5061: <dd>
5062: <p>This target generates a
1.199 nia 5063: <code class="filename">index.html</code> file, which can be
1.207 leot 5064: viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/index.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/index.html" target="_top"><code class="filename">www/links</code></a>. The generated files
1.184 rillig 5065: contain references to any packages which are in the
5066: <code class="varname">PACKAGES</code> directory on the local
5067: host. The generated files can be made to refer to URLs
5068: based on <code class="varname">FTP_PKG_URL_HOST</code> and
5069: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.199 nia 5070: wanted to generate <code class="filename">index.html</code>
1.184 rillig 5071: files which pointed to binary packages on the local
5072: machine, in the directory
5073: <code class="filename">/usr/packages</code>, set
5074: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
5075: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
5076: <code class="varname">${PACKAGES}</code> directory and its
5077: subdirectories will be searched for all the binary
5078: packages.</p>
5079: <p>The target can be run at the toplevel or in category
5080: directories, in which case it descends recursively.</p>
5081: </dd>
5082: <dt><span class="term">readme-all</span></dt>
5083: <dd><p>This is a top-level command, run it in
5084: <code class="filename">pkgsrc</code>. Use this target to create a
5085: file <code class="filename">README-all.html</code> which contains a
5086: list of all packages currently available in the NetBSD
5087: Packages Collection, together with the category they belong
5088: to and a short description. This file is compiled from the
1.199 nia 5089: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.184 rillig 5090: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
5091: readme</strong></span>.</p></dd>
5092: <dt><span class="term">cdrom-readme</span></dt>
5093: <dd><p>This is very much the same as the
5094: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
5095: used when generating a pkgsrc tree to be written to a
5096: CD-ROM. This target also produces
1.199 nia 5097: <code class="filename">index.html</code> files, and can be made
1.184 rillig 5098: to refer to URLs based on
5099: <code class="varname">CDROM_PKG_URL_HOST</code> and
5100: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5101: <dt><span class="term">show-distfiles</span></dt>
5102: <dd><p>This target shows which distfiles and patchfiles
5103: are needed to build the package
5104: (<code class="varname">ALLFILES</code>, which contains all
5105: <code class="varname">DISTFILES</code> and
5106: <code class="varname">PATCHFILES</code>, but not
5107: <code class="filename">patches/*</code>).</p></dd>
5108: <dt><span class="term">show-downlevel</span></dt>
5109: <dd><p>This target shows nothing if the package is not
5110: installed. If a version of this package is installed,
5111: but is not the version provided in this version of
5112: pkgsrc, then a warning message is displayed. This target
5113: can be used to show which of your installed packages are
5114: downlevel, and so the old versions can be deleted, and
5115: the current ones added.</p></dd>
5116: <dt><span class="term">show-pkgsrc-dir</span></dt>
5117: <dd><p>This target shows the directory in the pkgsrc
5118: hierarchy from which the package can be built and
5119: installed. This may not be the same directory as the one
5120: from which the package was installed. This target is
5121: intended to be used by people who may wish to upgrade
5122: many packages on a single host, and can be invoked from
5123: the top-level pkgsrc Makefile by using the
5124: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
5125: <dt><span class="term">show-installed-depends</span></dt>
5126: <dd><p>This target shows which installed packages match
5127: the current package's <code class="varname">DEPENDS</code>. Useful
5128: if out of date dependencies are causing build
5129: problems.</p></dd>
5130: <dt><span class="term">print-build-depends-list</span></dt>
5131: <dd><p>This target shows the list of packages that the current package
5132: depends on for building.</p></dd>
5133: <dt><span class="term">print-run-depends-list</span></dt>
5134: <dd><p>This target shows the list of packages that the current package
5135: depends on for running.</p></dd>
5136: <dt><span class="term">check-shlibs</span></dt>
5137: <dd><p>After a package is installed, check all its
5138: binaries and (on ELF platforms) shared libraries to see
5139: if they find the shared libs they need. Run by default
5140: 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>
5141: <dt><span class="term">print-PLIST</span></dt>
5142: <dd>
5143: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5144: upgraded pkg, this prints out an attempt to generate a
5145: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5146: -newer work/.extract_done</strong></span>. An attempt is made
5147: to care for shared libs etc., but it is
5148: <span class="emphasis"><em>strongly</em></span> recommended to review the
5149: result before putting it into
5150: <code class="filename">PLIST</code>. On upgrades, it's useful to
5151: diff the output of this command against an already
5152: existing <code class="filename">PLIST</code> file.</p>
1.207 leot 5153: <p>If the package installs files via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.184 rillig 5154: other methods that don't update file access times, be
5155: sure to add these files manually to your
5156: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5157: -newer</span>”</span> command used by this target won't catch
5158: them!</p>
5159: <p>See <a class="xref" href="#print-PLIST" title="19.3. Tweaking output of make print-PLIST">Section 19.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
5160: information on this target.</p>
5161: </dd>
5162: </dl></div>
5163: </div>
5164: </div>
5165: <div class="chapter">
5166: <div class="titlepage"><div><div><h2 class="title">
5167: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5168: <div class="toc">
5169: <p><b>Table of Contents</b></p>
5170: <dl class="toc">
5171: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5172: <dd><dl>
1.219 nia 5173: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5174: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5175: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.184 rillig 5176: </dl></dd>
5177: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5178: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
5179: </dl>
5180: </div>
5181: <p>When you find a package that is not yet in pkgsrc, you
5182: most likely have a URL from where you can download the source
5183: code. Starting with this URL, creating a package involves only a
5184: few steps.</p>
5185: <div class="procedure"><ol class="procedure" type="1">
5186: <li class="step"><p>In your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, set <code class="code">PKG_DEVELOPER=yes</code> to
5187: enable the basic quality checks.</p></li>
5188: <li class="step">
1.207 leot 5189: <p>Install the package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkg_developer/index.html" target="_top"><code class="filename">meta-pkgs/pkg_developer</code></a>, which among others will
1.184 rillig 5190: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5191: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5192: <span class="command"><strong>mkpatches</strong></span>:</p>
5193: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5194: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5195: </li>
5196: <li class="step">
5197: <p>Choose one of the top-level directories as the category in
5198: which you want to place your package. You can also create a directory of
1.219 nia 5199: your own (maybe called <code class="filename">local</code>). Change into that
5200: category directory:</p>
5201: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em></code></strong></pre>
1.184 rillig 5202: </li>
5203: <li class="step">
1.219 nia 5204: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5205: argument the URL of the distribution file (in most cases a
5206: <code class="filename">.tar.gz</code> file). This will download the distribution
5207: file and create the necessary files of the package, based on what's in
5208: the distribution file:</p>
1.184 rillig 5209: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>url2pkg <em class="replaceable"><code>https://www.example.org/packages/package-1.0.tar.gz</code></em></code></strong></pre>
5210: </li>
5211: <li class="step">
5212: <p>Examine the extracted files to determine the dependencies of
5213: your package. Ideally, this is mentioned in some
5214: <code class="filename">README</code> file, but things may differ. For each of
5215: these dependencies, look where it exists in pkgsrc, and if there is a
5216: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5217: line to your package <code class="filename">Makefile</code> which includes that
5218: file just before the last line. If the
5219: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5220: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5221: that the package's include files and libraries are provided.</p>
1.219 nia 5222: <p>If you just need binaries from a dependent package, add a
1.184 rillig 5223: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5224: version of the dependency and where it can be found in pkgsrc. This line
5225: should be placed in the third paragraph. If the dependency is only
5226: needed for building the package, but not when using it, use
5227: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5228: instead of <code class="varname">DEPENDS</code>.
5229: The difference between <code class="varname">TOOL_DEPENDS</code> and
5230: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5231: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.219 nia 5232: packages, i.e. packages for the platform where the package is built;
1.184 rillig 5233: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.219 nia 5234: packages, i.e. packages for the platform for which the package
5235: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5236: specifies a dependency used only for testing the resulting package
5237: built, using the upstream project's included test suite, on the native
5238: platform.
1.184 rillig 5239: Your package may then look like this:</p>
5240: <pre class="programlisting">
5241: [...]
5242:
5243: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5244: DEPENDS+= screen-[0-9]*:../../misc/screen
5245: DEPENDS+= screen>=4.0:../../misc/screen
5246:
5247: [...]
5248:
5249: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5250: .include "../../devel/glib2/buildlink3.mk"
5251: .include "../../mk/bsd.pkg.mk"
5252: </pre>
5253: </li>
5254: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5255: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5256: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5257: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5258: additional explanations.</p></li>
5259: <li class="step"><p>In many cases the package is not yet ready to build. You can
5260: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="14.1. Common types of packages">Section 14.1, “Common types of packages”</a>. After you have followed the instructions
5261: over there, you can hopefully continue here.</p></li>
5262: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5263: directory from the extracted files. Besides these files, a lot of cache
1.219 nia 5264: files and other system information have been saved in the working
5265: directory, which may have become outdated after you edited the
1.184 rillig 5266: <code class="filename">Makefile</code>.</p></li>
5267: <li class="step">
5268: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5269: 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>
1.219 nia 5270: <p>If the extracted files from the package need to be fixed, run
5271: multiple rounds of these commands:</p>
5272: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.184 rillig 5273: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5274: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.219 nia 5275: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5276: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.184 rillig 5277: </li>
5278: <li class="step"><p>When the package builds fine, the next step is to install
5279: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5280: everything works.</p></li>
5281: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5282: contains a list of the files that are installed by the package, is
5283: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5284: >PLIST</strong></span> to generate a probably correct list. Check
5285: the file using your preferred text editor to see if the list of
5286: files looks plausible.</p></li>
5287: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5288: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5289: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5290: had been registered in the database of installed files, but with an
5291: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5292: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5293: registered with the list of files from
5294: <code class="filename">PLIST</code>.</p></li>
5295: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5296: from above again in a single step, making sure that the PLIST is correct
5297: and the whole package is created as intended.</p></li>
1.219 nia 5298: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5299: left to do.</p></li>
1.184 rillig 5300: <li class="step"><p>Commit the package to pkgsrc-wip or main pkgsrc; see <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a>.</p></li>
5301: </ol></div>
5302: <div class="sect1">
5303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5304: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5305: <div class="sect2">
5306: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5307: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.184 rillig 5308: <p>Python modules and programs packages are easily created using a
5309: set of predefined variables.</p>
5310: <p>
5311: If some Python versions are not supported by the software, set the
5312: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5313: that are not supported, e.g.
5314: </p>
5315: <pre class="programlisting">
5316: PYTHON_VERSIONS_INCOMPATIBLE= 27
5317: </pre>
5318: <p>
5319: If the packaged software is a Python module, include one of
1.215 wiz 5320: <code class="filename">../../lang/python/egg.mk</code> or
1.184 rillig 5321: <code class="filename">../../lang/python/extension.mk</code>.</p>
1.215 wiz 5322: <p>Most Python packages use setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
1.184 rillig 5323: If the packaged software is using setuptools, you only need
5324: to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
1.215 wiz 5325: </p>
1.184 rillig 5326: <p>Either way, the package directory should be called
5327: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5328: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5329: </p>
5330: <pre class="programlisting">
5331: DISTNAME= foopymodule-1.2.10
5332: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5333: </pre>
1.226 gutterid 5334: <p>
5335: For software in PyPi, the name should match what PyPi specifies for
5336: "pip install software".
5337: </p>
1.184 rillig 5338: <p>If it is an application, include
5339: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5340: In order to correctly set the path to the Python interpreter, use the
5341: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5342: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5343: For example:
5344: </p>
5345: <pre class="programlisting">
5346: REPLACE_PYTHON= *.py
5347: </pre>
5348: <p>Some Python modules have separate distributions for Python-2.x
5349: and Python-3.x support. In pkgsrc this is handled by the
5350: <code class="filename">versioned_dependencies.mk</code> file. Set
5351: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
5352: packages that should be depended upon and include
5353: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>”</span>,
5354: then the pkgsrc infrastructure will depend on the appropriate package
5355: version. For example:
5356: </p>
5357: <pre class="programlisting">
5358: PYTHON_VERSIONED_DEPENDENCIES=dialog
5359: </pre>
5360: <p>
5361: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
5362: of supported packages.</p>
5363: </div>
5364: <div class="sect2">
5365: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5366: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.184 rillig 5367: <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>
5368: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.207 leot 5369: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/index.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
1.184 rillig 5370: Individual packages (and optionally their dependencies) may be created
5371: and updated. R packages generally follow the same form, and most of
5372: the relevant information needed is contained in a
5373: <code class="filename">DESCRIPTION</code> file as part of each R package on
5374: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5375: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5376: creates or updates a package in the canonical form. The resulting
5377: package should be reviewed for correctness.</p>
5378: </div>
5379: <div class="sect2">
5380: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5381: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.184 rillig 5382: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.207 leot 5383: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/index.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
1.184 rillig 5384: <p>If the TeXlive package name is not known, it may be useful to
5385: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5386: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5387: 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
5388: archive</a>.</p>
5389: <p>If the TeXlive package name is known, download the files from
5390: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5391: archive</a>. For package <code class="filename">foo</code>, you will need
5392: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5393: also have associated documentation packages, so download
5394: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5395: should be placed in the appropriate category directory, which is often
5396: but not always <code class="filename">print</code>. Then run the following
5397: command in the category directory.</p>
5398: <pre class="programlisting">
5399: texlive2pkg foo.tar.xz foo.doc.tar.xz
5400: </pre>
5401: <p>This will create two packages, <code class="filename">tex-foo</code> and
5402: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5403: are correct.</p>
5404: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5405: currently does not include version information in package filenames
5406: and changes their contents periodically when updates occur.
5407: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5408: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5409: main one and the corresponding documentation, upload the distfiles
5410: with the following command in each package directory.</p>
5411: <pre class="programlisting">
5412: make upload-distfiles
5413: </pre>
5414: </div>
5415: </div>
5416: <div class="sect1">
5417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5418: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5419: <div class="sect2">
5420: <div class="titlepage"><div><div><h3 class="title">
5421: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5422: <div class="sect3">
5423: <div class="titlepage"><div><div><h4 class="title">
5424: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5425: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5426: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5427: pkgsrc. As the description says it has to do with the web, the obvious
5428: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5429: <pre class="programlisting">
5430: <code class="prompt">$</code> mkdir www/nvu
5431: <code class="prompt">$</code> cd www/nvu
5432: </pre>
5433: <p>The web site says that the sources are available as a tar file, so
5434: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5435: <pre class="programlisting">
5436: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5437: </pre>
5438: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5439: below the <code class="varname">DISTNAME</code> line, as the package name should
5440: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5441: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5442: <code class="varname">COMMENT</code> fields. Then the package
5443: <code class="filename">Makefile</code> looked like that:</p>
5444: <pre class="programlisting">
5445: # $NetBSD $
5446: #
5447:
5448: DISTNAME= nvu-1.0-sources
5449: PKGNAME= nvu-1.0
5450: CATEGORIES= www
5451: MASTER_SITES= http://cvs.nvu.com/download/
5452: EXTRACT_SUFX= .tar.bz2
5453:
5454: MAINTAINER= rillig@NetBSD.org
5455: HOMEPAGE= http://cvs.nvu.com/
5456: COMMENT= Web Authoring System
5457:
5458: # url2pkg-marker (please do not remove this line.)
5459: .include "../../mk/bsd.pkg.mk"
5460: </pre>
5461: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5462: this is a workaround to prevent CVS expanding to the filename of the
5463: guide.</p>
5464: <p>Then, I quit the editor and watched pkgsrc downloading a large
5465: source archive:</p>
5466: <pre class="programlisting">
5467: url2pkg> Running "make makesum" ...
5468: => Required installed package digest>=20010302: digest-20060826 found
5469: => Fetching nvu-1.0-sources.tar.bz2
5470: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5471: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5472: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5473: url2pkg> Running "make extract" ...
5474: => Required installed package digest>=20010302: digest-20060826 found
5475: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5476: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5477: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5478: ===> Installing dependencies for nvu-1.0
5479: ===> Overriding tools for nvu-1.0
5480: ===> Extracting for nvu-1.0
5481: url2pkg> Adjusting the Makefile.
5482:
5483: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5484:
5485: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5486: </pre>
5487: </div>
5488: <div class="sect3">
5489: <div class="titlepage"><div><div><h4 class="title">
5490: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5491: <p>Now that the package has been extracted, let's see what's inside
5492: it. The package has a <code class="filename">README.txt</code>, but that only
5493: says something about mozilla, so it's probably useless for seeing what
5494: dependencies this package has. But since there is a GNU configure script
5495: in the package, let's hope that it will complain about everything it
5496: needs.</p>
5497: <pre class="programlisting">
5498: <code class="prompt">$</code> bmake
5499: => Required installed package digest>=20010302: digest-20060826 found
5500: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5501: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5502: ===> Patching for nvu-1.0
5503: ===> Creating toolchain wrappers for nvu-1.0
5504: ===> Configuring for nvu-1.0
5505: [...]
5506: configure: error: Perl 5.004 or higher is required.
5507: [...]
5508: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5509: [...]
5510: </pre>
5511: <p>That worked quite well. So I opened the package Makefile in my
5512: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5513: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5514: package have changed now, and since a perl wrapper is automatically
5515: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5516: from scratch.</p>
5517: <pre class="programlisting">
5518: <code class="prompt">$</code> bmake clean
5519: ===> Cleaning for nvu-1.0
5520: <code class="prompt">$</code> bmake
5521: [...]
5522: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5523: GNU Make. You will not be able to build Mozilla without GNU Make.
5524: [...]
5525: </pre>
5526: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5527: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5528: <pre class="programlisting">
5529: [...]
5530: checking for GTK - version >= 1.2.0... no
5531: *** Could not run GTK test program, checking why...
5532: [...]
5533: </pre>
5534: <p>Now to the other dependencies. The first question is: Where is the
5535: GTK package hidden in pkgsrc?</p>
5536: <pre class="programlisting">
5537: <code class="prompt">$</code> echo ../../*/gtk*
5538: [many packages ...]
5539: <code class="prompt">$</code> echo ../../*/gtk
5540: ../../x11/gtk
5541: <code class="prompt">$</code> echo ../../*/gtk2
5542: ../../x11/gtk2
5543: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5544: ../../x11/gtk2/buildlink3.mk
5545: </pre>
5546: <p>The first try was definitely too broad. The second one had exactly
5547: one result, which is very good. But there is one pitfall with GNOME
5548: packages. Before GNOME 2 had been released, there were already many
5549: GNOME 1 packages in pkgsrc. To be able to continue to use these
5550: packages, the GNOME 2 packages were imported as separate packages, and
5551: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5552: whether this was the case here, and indeed it was.</p>
5553: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5554: file, adding the dependency is very easy. I just inserted an
5555: <code class="literal">.include</code> line before the last line of the package
5556: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5557: <pre class="programlisting">
5558: [...]
5559: .include "../../x11/gtk2/buildlink3.mk"
5560: .include "../../mk/bsd.pkg.mk
5561: </pre>
5562: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5563: was:</p>
1.1 dsieger 5564: <pre class="programlisting">
1.184 rillig 5565: [...]
5566: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5567: checking for GTK - version >= 1.2.0... no
5568: *** Could not run GTK test program, checking why...
5569: *** The test program failed to compile or link. See the file config.log for the
5570: *** exact error that occured. This usually means GTK was incorrectly installed
5571: *** or that you have moved GTK since it was installed. In the latter case, you
5572: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5573: configure: error: Test for GTK failed.
5574: [...]
1.111 sevan 5575: </pre>
1.184 rillig 5576: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5577: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5578: told me that this package really wanted to have the GNOME 1 version of
5579: GTK. If the package had looked for GTK2, it would have looked for
5580: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5581: So I changed the <code class="literal">x11/gtk2</code> to
5582: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5583: and tried again.</p>
1.18 snj 5584: <pre class="programlisting">
1.184 rillig 5585: [...]
5586: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5587: In file included from xpidl.c:42:
5588: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5589: In file included from xpidl.c:42:
5590: xpidl.h:132: error: parse error before "IDL_ns"
5591: [...]
1.111 sevan 5592: </pre>
1.184 rillig 5593: <p>The package still does not find all of its dependencies. Now the
5594: question is: Which package provides the
5595: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18 snj 5596: <pre class="programlisting">
1.184 rillig 5597: <code class="prompt">$</code> echo ../../*/*idl*
5598: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5599: <code class="prompt">$</code> echo ../../*/*IDL*
5600: ../../net/libIDL
1.111 sevan 5601: </pre>
1.184 rillig 5602: <p>Let's take the one from the second try. So I included the
5603: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5604: again. But the error didn't change. After digging through some of the
5605: code, I concluded that the build process of the package was broken and
5606: couldn't have ever worked, but since the Mozilla source tree is quite
5607: large, I didn't want to fix it. So I added the following to the package
5608: <code class="filename">Makefile</code> and tried again:</p>
1.86 wiz 5609: <pre class="programlisting">
1.184 rillig 5610: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5611: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.111 sevan 5612: </pre>
1.184 rillig 5613: <p>The latter line is needed because the package expects the library
5614: <code class="filename">libIDL.so</code>, but only
5615: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5616: wrapper to rewrite that on the fly.</p>
5617: <p>The next problem was related to a recent change of the FreeType
1.207 leot 5618: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/index.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.184 rillig 5619: which patch files were relevant for this issue and copied them to the
5620: <code class="filename">patches</code> directory. Then I retried, fixed the
5621: patches so that they applied cleanly and retried again. This time,
5622: everything worked.</p>
1.86 wiz 5623: </div>
1.184 rillig 5624: <div class="sect3">
5625: <div class="titlepage"><div><div><h4 class="title">
5626: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 5627: <pre class="programlisting">
1.184 rillig 5628: <code class="prompt">$</code> bmake CHECK_FILES=no install
5629: [...]
5630: <code class="prompt">$</code> bmake print-PLIST >PLIST
5631: <code class="prompt">$</code> bmake deinstall
5632: <code class="prompt">$</code> bmake install
1.111 sevan 5633: </pre>
1.184 rillig 5634: </div>
5635: </div>
1.1 dsieger 5636: </div>
5637: </div>
1.41 asau 5638: <div class="chapter">
1.1 dsieger 5639: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 5640: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 5641: <div class="toc">
5642: <p><b>Table of Contents</b></p>
1.100 leot 5643: <dl class="toc">
1.184 rillig 5644: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5645: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5646: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5647: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5648: <dd><dl>
5649: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5650: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5651: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
5652: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 5653: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.1 dsieger 5654: </dl></dd>
5655: </dl>
5656: </div>
1.184 rillig 5657: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5658: each of which forms a well-defined part of the pkgsrc system. Using
1.207 leot 5659: the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.184 rillig 5660: like pkgsrc requires some discipline to keep the code correct and
5661: understandable.</p>
5662: <p>The basic ingredients for <code class="filename">Makefile</code>
5663: programming are variables and shell
5664: commands. Among these shell commands may even be more complex ones
1.207 leot 5665: like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/awk.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.184 rillig 5666: as intended it is necessary to quote all variables correctly when they
5667: are used.</p>
5668: <p>This chapter describes some patterns that appear quite often in
5669: <code class="filename">Makefile</code>s, including the pitfalls that come along
5670: with them.</p>
1.41 asau 5671: <div class="sect1">
1.1 dsieger 5672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5673: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5674: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5675: <p>When you are creating a file as a
5676: target of a rule, always write the data to a temporary file first
5677: and finally rename that file. Otherwise there might occur an error
5678: in the middle of generating the file, and when the user runs
1.207 leot 5679: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.184 rillig 5680: regenerated properly. Example:</p>
1.1 dsieger 5681: <pre class="programlisting">
1.184 rillig 5682: wrong:
5683: @echo "line 1" > ${.TARGET}
5684: @echo "line 2" >> ${.TARGET}
5685: @false
5686:
5687: correct:
5688: @echo "line 1" > ${.TARGET}.tmp
5689: @echo "line 2" >> ${.TARGET}.tmp
5690: @false
5691: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 5692: </pre>
1.184 rillig 5693: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5694: <code class="filename">wrong</code> will exist, although there was an error
5695: message in the first run. On the other hand, running <span class="command"><strong>make
5696: correct</strong></span> gives an error message twice, as expected.</p>
1.207 leot 5697: <p>You might remember that <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.184 rillig 5698: <code class="literal">${.TARGET}</code> in case of error, but this only
5699: happens when it is interrupted, for example by pressing
5700: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.207 leot 5701: when one of the commands fails (like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.184 rillig 5702: </li></ul></div>
5703: </div>
5704: <div class="sect1">
5705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5706: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5707: <p><code class="filename">Makefile</code> variables contain strings that
5708: can be processed using the five operators <code class="code">=</code>,
5709: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.207 leot 5710: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.184 rillig 5711: page.</p>
5712: <p>When a variable's value is parsed from a
5713: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5714: the backslash character <code class="code">\</code> are handled specially. If a
5715: backslash is the last character in a line, that backslash is removed
5716: from the line and the line continues with the next line of the file.</p>
5717: <p>The <code class="code">#</code> character starts a comment that reaches
5718: until the end of the line. To get an actual <code class="code">#</code> character,
5719: such as in a URL, write <code class="code">\#</code> instead.</p>
5720: <p>The evaluation of variables either happens immediately or lazy.
5721: It happens immediately when the variable occurs on the right-hand
5722: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5723: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5724: In the other cases, it is evaluated lazily.</p>
5725: <p>Some of the modifiers split the string into words and then
5726: operate on the words, others operate on the string as a whole. When a
5727: string is split into words, double quotes and single quotes are
1.207 leot 5728: interpreted as delimiters, just like in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.184 rillig 5729: <div class="sect2">
5730: <div class="titlepage"><div><div><h3 class="title">
5731: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5732: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5733: <li class="listitem"><p>All variable names starting with an underscore
5734: are reserved for use by the pkgsrc infrastructure. They shall
5735: not be used by packages.</p></li>
5736: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5737: lowercase variable names for the iteration
5738: variables.</p></li>
5739: <li class="listitem"><p>All list variables should have a plural name,
5740: such as <code class="varname">PKG_OPTIONS</code> or
5741: <code class="varname">DISTFILES</code>.</p></li>
5742: </ul></div>
5743: </div>
5744: </div>
5745: <div class="sect1">
5746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5747: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5748: <div class="sect2">
5749: <div class="titlepage"><div><div><h3 class="title">
5750: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5751: <p>When adding a string that possibly contains whitespace or quotes to
5752: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5753: modifier.</p>
5754: <p>When adding another list to a list (example 2), it must not be
5755: quoted, since its elements are already quoted.</p>
1.1 dsieger 5756: <pre class="programlisting">
1.184 rillig 5757: STRING= foo * bar `date`
5758: LIST= # empty
5759: ANOTHER_LIST= a=b c=d
5760:
5761: LIST+= ${STRING:Q} # 1
5762: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 5763: </pre>
1.184 rillig 5764: </div>
5765: <div class="sect2">
5766: <div class="titlepage"><div><div><h3 class="title">
5767: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5768: <p>Echoing a string containing special characters needs special
5769: work.</p>
1.1 dsieger 5770: <pre class="programlisting">
1.184 rillig 5771: STRING= foo bar < > * `date` $$HOME ' "
5772: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5773:
5774: all:
5775: echo ${STRING} # 1
5776: echo ${STRING:Q} # 2
5777: printf '%s\n' ${STRING:Q}'' # 3
5778: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 5779: </pre>
1.184 rillig 5780: <p>Example 1 leads to a syntax error in the shell, as the characters
5781: are just copied.</p>
5782: <p>Example 2 quotes the string so that the shell interprets it
5783: correctly. But the echo command may additionally interpret strings with a
5784: leading dash or those containing backslashes.</p>
1.207 leot 5785: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.184 rillig 5786: interprets the format string, but not the next argument. The trailing
5787: single quotes handle the case when the string is empty. In that case, the
5788: :Q modifier would result in an empty string too, which would then be
1.207 leot 5789: skipped by the shell. For <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.184 rillig 5790: but other programs may care.</p>
5791: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5792: need to be quoted because the quoting has already been done
5793: when adding elements to the list.</p>
1.1 dsieger 5794: </div>
1.41 asau 5795: <div class="sect2">
1.1 dsieger 5796: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 5797: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5798: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5799: GNU-style configure script (especially those that call other configure
5800: scripts), it must not have leading or trailing whitespace, since
5801: otherwise the configure script gets confused. To trim leading and
5802: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5803: following example:</p>
1.1 dsieger 5804: <pre class="programlisting">
1.184 rillig 5805: CPPFLAGS= # empty
5806: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5807: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 5808:
1.184 rillig 5809: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 5810:
1.184 rillig 5811: all:
5812: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5813: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5814: </pre>
5815: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5816: trailing whitespace because the <code class="code">+=</code> operator always adds a
5817: space.</p>
5818: </div>
5819: <div class="sect2">
5820: <div class="titlepage"><div><div><h3 class="title">
5821: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5822: <p>When a possibly empty variable is used in a shell program, it may
5823: lead to a syntax error.</p>
5824: <pre class="programlisting">
5825: EGFILES= # empty
1.1 dsieger 5826:
1.184 rillig 5827: install-examples: # produces a syntax error in the shell
5828: for egfile in ${EGFILES}; do \
5829: echo "Installing $$egfile"; \
5830: done
5831: </pre>
5832: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.207 leot 5833: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.184 rillig 5834: To fix this syntax error, use one of the snippets below.</p>
5835: <pre class="programlisting">
1.229 gutterid 5836: EGFILES= # empty
1.1 dsieger 5837:
1.184 rillig 5838: install-examples:
5839: for egfile in ${EGFILES} ""; do \
5840: [ -n "$$egfile" ] || continue; \
5841: echo "Installing $$egfile"; \
5842: done
5843: </pre>
5844: <p>In this case, an empty string is appended to the iteration list (to
5845: prevent the syntax error) and filtered out later.</p>
5846: <pre class="programlisting">
5847: EGFILES= # empty
1.1 dsieger 5848:
1.184 rillig 5849: install-examples:
5850: .for egfile in ${EGFILES}
5851: echo "Installing ${egfile}"
5852: .endfor
1.1 dsieger 5853: </pre>
1.184 rillig 5854: <p>If one of the filenames contains special characters, it should be
5855: enclosed in single or double quotes.</p>
5856: <p>To have a shell command test whether a make variable is empty, use
5857: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5858: </div>
1.229 gutterid 5859: <div class="sect2">
5860: <div class="titlepage"><div><div><h3 class="title">
5861: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
5862: <p>When a variable can have the values <code class="literal">yes</code> or
5863: <code class="literal">no</code>, use the following pattern to test the variable:</p>
5864: <pre class="programlisting">
5865: .if ${VAR:U:tl} == "yes"
5866: # do something
5867: .endif
5868: </pre>
5869: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
5870: can be undefined. If the variable is guaranteed to be defined, the
5871: <code class="literal">:U</code> can be omitted.</p>
5872: <p>The <code class="literal">:tl</code> modifier converts the variable value to
5873: lowercase, allowing for the values <code class="literal">yes</code>,
5874: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
5875: </div>
1.184 rillig 5876: </div>
5877: </div>
5878: <div class="chapter">
5879: <div class="titlepage"><div><div><h2 class="title">
5880: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5881: <div class="toc">
5882: <p><b>Table of Contents</b></p>
5883: <dl class="toc">
5884: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5885: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
5886: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5887: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5888: </dl>
1.1 dsieger 5889: </div>
1.184 rillig 5890: <p>Many packages have the ability to be built to support different
5891: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5892: in pkgsrc that provides generic handling of those options that
5893: determine different ways in which the packages can be built. It's
5894: possible for the user to specify exactly which sets of options will be
5895: built into a package or to allow a set of global default options
5896: apply.</p>
5897: <p>There are two broad classes of behaviors that one might want to
5898: control via options. One is whether some particular feature is
5899: enabled in a program that will be built anyway, often by including or
5900: not including a dependency on some other package. The other is
5901: whether or not an additional program will be built as part of the
5902: package. Generally, it is better to make a split package for such
5903: additional programs instead of using options, because it enables
5904: binary packages to be built which can then be added separately. For
5905: example, the foo package might have minimal dependencies (those
5906: packages without which foo doesn't make sense), and then the foo-gfoo
5907: package might include the GTK frontend program gfoo. This is better
5908: than including a gtk option to foo that adds gfoo, because either that
5909: option is default, in which case binary users can't get foo without
5910: gfoo, or not default, in which case they can't get gfoo. With split
5911: packages, they can install foo without having GTK, and later decide to
5912: install gfoo (pulling in GTK at that time). This is an advantage to
5913: source users too, avoiding the need for rebuilds.</p>
5914: <p>Plugins with widely varying dependencies should usually be split
5915: instead of options.</p>
5916: <p>It is often more work to maintain split packages, especially if
5917: the upstream package does not support this. The decision of split
5918: vs. option should be made based on the likelihood that users will want
5919: or object to the various pieces, the size of the dependencies that are
5920: included, and the amount of work.</p>
5921: <p>A further consideration is licensing. Non-free parts, or parts
5922: that depend on non-free dependencies (especially plugins) should
5923: almost always be split if feasible.</p>
5924: <div class="sect1">
5925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5926: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5927: <p>Global default options are listed in
5928: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5929: that should be built into every package if that option is supported.
5930: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5931: </div>
1.41 asau 5932: <div class="sect1">
1.1 dsieger 5933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5934: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5935: </h2></div></div></div>
5936: <p>The following example shows how
5937: <code class="filename">bsd.options.mk</code> should be used
5938: by the hypothetical ``wibble'' package, either in the package
5939: <code class="filename">Makefile</code>, or in a file,
5940: e.g. <code class="filename">options.mk</code>, that is included by the
5941: main package <code class="filename">Makefile</code>.</p>
1.1 dsieger 5942: <pre class="programlisting">
1.184 rillig 5943: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5944: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5945: PKG_OPTIONS_OPTIONAL_GROUPS= database
5946: PKG_OPTIONS_GROUP.database= mysql pgsql
5947: PKG_SUGGESTED_OPTIONS= wibble-foo
5948: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5949: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5950:
5951: .include "../../mk/bsd.prefs.mk"
5952:
5953: # this package was previously named wibble2
5954: .if defined(PKG_OPTIONS.wibble2)
5955: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5956: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5957: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5958: .endif
5959:
5960: .include "../../mk/bsd.options.mk"
5961:
5962: # Package-specific option-handling
1.1 dsieger 5963:
1.184 rillig 5964: ###
5965: ### FOO support
5966: ###
5967: .if !empty(PKG_OPTIONS:Mwibble-foo)
5968: CONFIGURE_ARGS+= --enable-foo
5969: .endif
1.1 dsieger 5970:
1.184 rillig 5971: ###
5972: ### LDAP support
5973: ###
5974: .if !empty(PKG_OPTIONS:Mldap)
5975: . include "../../databases/openldap-client/buildlink3.mk"
5976: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5977: .endif
1.1 dsieger 5978:
1.184 rillig 5979: ###
5980: ### database support
5981: ###
5982: .if !empty(PKG_OPTIONS:Mmysql)
5983: . include "../../mk/mysql.buildlink3.mk"
5984: .endif
5985: .if !empty(PKG_OPTIONS:Mpgsql)
5986: . include "../../mk/pgsql.buildlink3.mk"
5987: .endif
5988: </pre>
5989: <p>The first section contains the information about which build
5990: options are supported by the package, and any default options settings
5991: if needed.</p>
5992: <div class="orderedlist"><ol class="orderedlist" type="1">
5993: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.207 leot 5994: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.184 rillig 5995: options. It should be set to
5996: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
5997: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
5998: at the point where the options are processed.</p></li>
5999: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6000: build options supported by the package.</p></li>
6001: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6002: list of names of groups of mutually exclusive options. The options in
6003: each group are listed in
6004: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6005: The most specific setting of any option from the group takes
6006: precedence over all other options in the group. Options from the
6007: groups will be automatically added to
6008: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6009: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6010: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6011: packages will fail if no option from the group is
6012: selected.</p></li>
6013: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6014: of names of sets of options. At least one option from each set must
6015: be selected. The options in each set are listed in
6016: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6017: Options from the sets will be automatically added to
6018: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6019: fail if no option from the set is selected.</p></li>
6020: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6021: build options which are enabled by default.</p></li>
6022: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6023: of
6024: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
6025: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
6026: their option counterparts. Pairs should be added with
6027: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
6028: warning will be issued if the user uses a legacy
6029: variable.</p></li>
6030: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6031: of
6032: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
6033: pairs that map options that have been renamed to their new
6034: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
6035: the listing of global legacy options. A warning will be issued if
6036: the user uses a legacy option.</p></li>
6037: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6038: options implied by deprecated variables used. This can be used for
6039: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6040: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6041: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6042: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6043: a list of warnings about deprecated variables or options used, and
6044: what to use instead.</p></li>
6045: </ol></div>
6046: <p>A package should never modify
6047: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6048: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6049: To suggest a default set of options, use
6050: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6051: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6052: including <code class="filename">bsd.options.mk</code>. If none of
6053: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6054: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6055: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6056: happen with platform-specific options if none of them is supported on
6057: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6058: empty list and the package is otherwise treated as not using the
6059: options framework.</p>
6060: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6061: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6062: build options, properly filtered to remove unsupported and duplicate
6063: options.</p>
6064: <p>The remaining sections contain the logic that is specific to
6065: each option. The correct way to check for an option is to check
6066: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6067: <pre class="programlisting">
6068: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1 dsieger 6069: </pre>
6070: </div>
1.184 rillig 6071: <div class="sect1">
6072: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6073: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
6074: <p>Options that enable similar features in different packages (like
6075: optional support for a library) should use a common name in all
6076: packages that support it (like the name of the library). If another
6077: package already has an option with the same meaning, use the same
6078: name.</p>
6079: <p>Options that enable features specific to one package, where it's
6080: unlikely that another (unrelated) package has the same (or a similar)
6081: optional feature, should use a name prefixed with
6082: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6083: <p>If a group of related packages share an optional feature
6084: specific to that group, prefix it with the name of the
6085: <span class="quote">“<span class="quote">main</span>”</span> package
6086: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6087: <p>For new options, add a line to
6088: <code class="filename">mk/defaults/options.description</code>. Lines have two
6089: fields, separated by tab. The first field is the option name, the
6090: second its description. The description should be a whole sentence
6091: (starting with an uppercase letter and ending with a period) that
6092: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6093: support.</span>”</span> The file is sorted by option names.</p>
6094: </div>
6095: <div class="sect1">
6096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6097: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6098: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6099: different dependencies based on the options with which the package was
6100: built. For querying these options, the file
6101: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6102: typical example looks like this:</p>
1.1 dsieger 6103: <pre class="programlisting">
1.184 rillig 6104: pkgbase := libpurple
6105: .include "../../mk/pkg-build-options.mk"
6106:
6107: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6108: ...
6109: .endif
1.117 sevan 6110: </pre>
1.184 rillig 6111: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6112: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6113: options of the libpurple package, which can then be queried like
6114: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6115: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6116: details.</p>
1.1 dsieger 6117: </div>
6118: </div>
1.41 asau 6119: <div class="chapter">
1.1 dsieger 6120: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6121: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6122: <div class="toc">
6123: <p><b>Table of Contents</b></p>
1.100 leot 6124: <dl class="toc">
1.184 rillig 6125: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6126: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6127: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6128: </dl>
6129: </div>
1.184 rillig 6130: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6131: by pkgsrc and also for individual packages to define what commands
6132: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6133: or for later run-time of an installed packaged (such as
6134: <code class="varname">DEPENDS</code>).
6135: If the native system provides an adequate tool, then in many cases, a pkgsrc
6136: package will not be used.</p>
6137: <p>When building a package, the replacement tools are
6138: made available in a directory (as symlinks or wrapper scripts)
6139: that is early in the executable search path. Just like the buildlink
6140: system, this helps with consistent builds.</p>
6141: <p>A tool may be needed to help build a specific package. For example,
6142: perl, GNU make (gmake) or yacc may be needed.</p>
6143: <p>Also a tool may be needed, for example, because the native system's supplied
6144: tool may be inefficient for building a package with pkgsrc.
6145: For example, a package may need GNU awk, bison (instead of
6146: yacc) or a better sed.</p>
6147: <p>The tools used by a package can be listed by running
6148: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6149: <div class="sect1">
1.1 dsieger 6150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6151: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6152: <p>The default set of tools used by pkgsrc is defined in
6153: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6154: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6155: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6156: These can be seen by running:
6157: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6158: <p>If a package needs a specific program to build
6159: then the <code class="varname">USE_TOOLS</code> variable can be used
6160: to define the tools needed.</p>
1.1 dsieger 6161: </div>
1.184 rillig 6162: <div class="sect1">
6163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6164: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6165: <p>In the following examples, the :run means that it is needed at
6166: run-time (and becomes a DEPENDS).
6167: The default is a build dependency which can be set with
6168: :build. (So in this example, it is the same as gmake:build
6169: and pkg-config:build.)</p>
1.1 dsieger 6170: <pre class="programlisting">
1.184 rillig 6171: USE_TOOLS+= gmake perl:run pkg-config
1.1 dsieger 6172: </pre>
1.184 rillig 6173: <p>When using the tools framework, a
6174: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6175: which contains the full path to the appropriate tool. For example,
6176: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6177: on Linux systems.</p>
6178: <p>If you always need a pkgsrc version of the
6179: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6180: </p>
1.1 dsieger 6181: </div>
1.184 rillig 6182: <div class="sect1">
6183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6184: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6185: <p>When improving or porting pkgsrc to a new platform, have a look
6186: at (or create) the corresponding platform specific make file fragment under
6187: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6188: the name of the common tools. For example:</p>
1.1 dsieger 6189: <pre class="programlisting">
1.184 rillig 6190: .if exists(/usr/bin/bzcat)
6191: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6192: .elif exists(/usr/bin/bzip2)
6193: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6194: .endif
6195:
6196: TOOLS_PLATFORM.true?= true # shell builtin
1.1 dsieger 6197: </pre>
6198: </div>
6199: </div>
1.184 rillig 6200: <div class="chapter">
6201: <div class="titlepage"><div><div><h2 class="title">
6202: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6203: <div class="toc">
6204: <p><b>Table of Contents</b></p>
6205: <dl class="toc">
6206: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6207: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6208: <dd><dl>
6209: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6210: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6211: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6212: and
6213: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6214: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6215: </dl></dd>
6216: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.241 rillig 6217: <dd><dl><dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt></dl></dd>
1.184 rillig 6218: </dl>
1.1 dsieger 6219: </div>
1.184 rillig 6220: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6221: are seen by a package's configure and build processes. This is implemented
6222: in a two step process:</p>
6223: <div class="orderedlist"><ol class="orderedlist" type="1">
6224: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6225: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6226: of <code class="varname">WRKDIR</code>.</p></li>
6227: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6228: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6229: <code class="option">-L${LOCALBASE}/lib</code> into references to
6230: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6231: native compiler on some operating systems look like GCC, so that
6232: packages that expect GCC won't require modifications to build with
6233: those native compilers.</p></li>
6234: </ol></div>
6235: <p>This normalizes the environment in which a package is built so that the
6236: package may be built consistently despite what other software may be
6237: installed. Please note that the normal system header and library paths,
6238: e.g. <code class="filename">/usr/include</code>,
6239: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6240: designed to insulate the package build from non-system-supplied
6241: software.</p>
1.41 asau 6242: <div class="sect1">
1.1 dsieger 6243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6244: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6245: <p>The process of converting packages to use the buildlink3
6246: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6247: The things to keep in mind are:</p>
1.23 wiz 6248: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184 rillig 6249: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6250: instead of the actual toolchain. Some packages are tricky,
6251: and the only way to know for sure is the check
6252: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6253: wrappers are being invoked.</p></li>
6254: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6255: the package Makefile, e.g. Java VMs, standalone shells,
6256: etc., because the code to symlink files into
6257: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6258: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6259: </p></li>
6260: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6261: <code class="filename">buildlink3.mk</code> files that you list in a
6262: package's Makefile are added as dependencies for that package.
6263: </p></li>
6264: </ol></div>
6265: <p>If a dependency on a particular package is required for its libraries and
6266: headers, then we replace:</p>
6267: <pre class="programlisting">
6268: DEPENDS+= foo>=1.1.0:../../category/foo
6269: </pre>
6270: <p>with</p>
6271: <pre class="programlisting">
6272: .include "../../category/foo/buildlink3.mk"
6273: </pre>
6274: <p>The buildlink3.mk files usually define the required dependencies.
6275: If you need a newer version of the dependency when using buildlink3.mk
6276: files, then you can define it in your Makefile; for example:</p>
1.1 dsieger 6277: <pre class="programlisting">
1.184 rillig 6278: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6279: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 6280: </pre>
1.184 rillig 6281: <p>There are several <code class="filename">buildlink3.mk</code>
6282: files in <code class="filename">pkgsrc/mk</code>
6283: that handle special package issues:</p>
6284: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6285: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6286: the native or a pkgsrc Berkeley DB implementation based on
6287: the values of <code class="varname">BDB_ACCEPTED</code> and
6288: <code class="varname">BDB_DEFAULT</code>.</p></li>
6289: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6290: comes with neither Curses nor NCurses, this will take care
1.207 leot 6291: to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/index.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.184 rillig 6292: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6293: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6294: adding a dependency on Heimdal or MIT-krb5 for packages that
6295: require a Kerberos 5 implementation.</p></li>
6296: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6297: system-provided Motif installation or adds a dependency on
1.207 leot 6298: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/index.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/index.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.184 rillig 6299: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6300: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6301: to choose which Motif version will be used.</p></li>
6302: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6303: system-provided GNU readline or editline (libedit) installation,
1.207 leot 6304: or adds a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/index.html" target="_top"><code class="filename">devel/readline</code></a>,
6305: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/index.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.184 rillig 6306: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6307: If your package really needs GNU readline library, its Makefile
6308: should include <code class="filename">devel/readline/buildlink3.mk</code>
6309: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6310: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6311: variables that may be used by packages that use the
6312: Open Sound System (OSS) API.</p></li>
6313: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6314: any of the Postgres versions in the variable
6315: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6316: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6317: the file for more information.</p></li>
6318: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6319: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.207 leot 6320: a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/index.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.184 rillig 6321: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6322: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6323: library.</p></li>
6324: </ul></div>
6325: <p>The comments in those <code class="filename">buildlink3.mk</code>
6326: files provide a more complete
6327: description of how to use them properly.</p>
1.1 dsieger 6328: </div>
1.41 asau 6329: <div class="sect1">
1.1 dsieger 6330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6331: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6332: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6333: included by Makefiles to indicate the need to compile and link
6334: against header files and libraries provided by the package. A
6335: <code class="filename">buildlink3.mk</code> file should always provide
6336: enough information to add the correct type of dependency
6337: relationship and include any other
6338: <code class="filename">buildlink3.mk</code> files that it needs to find
6339: headers and libraries that it needs in turn.</p>
6340: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.207 leot 6341: file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/index.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.184 rillig 6342: package is highly recommended. For most packages, the following
6343: command will generate a good starting point for
6344: <code class="filename">buildlink3.mk</code> files:</p>
6345: <pre class="screen">
6346: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6347: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6348: </pre>
1.41 asau 6349: <div class="sect2">
1.1 dsieger 6350: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6351: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6352: <p>The following real-life example
6353: <code class="filename">buildlink3.mk</code> is taken
6354: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1 dsieger 6355: <pre class="programlisting">
1.184 rillig 6356: BUILDLINK_TREE+= tiff
6357:
6358: .if !defined(TIFF_BUILDLINK3_MK)
6359: TIFF_BUILDLINK3_MK:=
6360:
6361: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6362: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6363: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6364:
6365: .include "../../devel/zlib/buildlink3.mk"
6366: .include "../../graphics/jpeg/buildlink3.mk"
6367: .endif # TIFF_BUILDLINK3_MK
6368:
6369: BUILDLINK_TREE+= -tiff
1.1 dsieger 6370: </pre>
1.184 rillig 6371: <p>The header and footer manipulate
6372: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6373: <code class="filename">buildlink3.mk</code> files and is used to track
6374: the dependency tree.</p>
6375: <p>The main section is protected from multiple inclusion
6376: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6377: added. Several important variables are set in the section:</p>
6378: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6379: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6380: is the dependency version recorded in the installed
1.184 rillig 6381: package; this should always be set using
6382: <span class="command"><strong>+=</strong></span> to ensure that
6383: we're appending to any pre-existing list of values. This
1.185 wiz 6384: variable should be set to the last version of the
1.184 rillig 6385: package that had an backwards-incompatible API change.
6386: </p></li>
6387: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6388: is the location of the <em class="replaceable"><code>pkg</code></em>
6389: pkgsrc directory.</p></li>
6390: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6391: (not shown above) controls whether we use
1.236 gutterid 6392: <code class="varname">BUILD_DEPENDS</code> or
1.184 rillig 6393: <code class="varname">DEPENDS</code> to add the dependency on
6394: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6395: selected by setting
6396: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.236 gutterid 6397: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.184 rillig 6398: used.</p></li>
6399: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6400: and
6401: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6402: (not shown above) are lists of subdirectories of
6403: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6404: to add to the header and library search paths. These
6405: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6406: respectively.</p></li>
6407: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6408: (not shown above) is the list of preprocessor flags to add
6409: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6410: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6411: should be avoided and instead be handled using
6412: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6413: above.</p></li>
6414: </ul></div>
6415: <p>The following variables are all optionally defined within
6416: this second section (protected against multiple inclusion) and
6417: control which package files are symlinked into
6418: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6419: transformed during the symlinking:</p>
6420: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6421: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6422: (not shown above) is a shell glob pattern relative to
6423: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6424: to be symlinked into
6425: <code class="filename">${BUILDLINK_DIR}</code>,
6426: e.g. <code class="filename">include/*.h</code>.</p></li>
6427: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6428: (not shown above) is a shell pipeline that
6429: outputs to stdout a list of files relative to
6430: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6431: The resulting files are to be symlinked
6432: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6433: this takes the <code class="filename">+CONTENTS</code> of a
6434: <em class="replaceable"><code>pkg</code></em> and filters it through
6435: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6436: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6437: (not shown above) is a filter command that filters
6438: <code class="filename">+CONTENTS</code> input into a list of files
6439: relative to
6440: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6441: on stdout. By default,
6442: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6443: outputs the contents of the <code class="filename">include</code>
6444: and <code class="filename">lib</code> directories in the package
6445: <code class="filename">+CONTENTS</code>.</p></li>
6446: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6447: (not shown above) is a list of sed arguments used to
6448: transform the name of the source filename into a
6449: destination filename, e.g. <span class="command"><strong>-e
6450: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6451: </ul></div>
6452: <p>This section can additionally include any
6453: <code class="filename">buildlink3.mk</code> needed for
6454: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6455: Including these <code class="filename">buildlink3.mk</code> files
6456: means that the headers and libraries for these
6457: dependencies are also symlinked into
6458: <code class="filename">${BUILDLINK_DIR}</code>
6459: whenever the <em class="replaceable"><code>pkg</code></em>
6460: <code class="filename">buildlink3.mk</code>
6461: file is included. Dependencies are only added for directly
6462: include <code class="filename">buildlink3.mk</code> files.</p>
6463: <p>When providing a <code class="filename">buildlink3.mk</code> and
6464: including other <code class="filename">buildlink3.mk</code> files in it,
6465: please only add necessary ones, i.e., those whose libraries or
6466: header files are automatically exposed when the package is
6467: use.</p>
6468: <p>In particular, if only an executable
6469: (<code class="filename">bin/foo</code>) is linked against a library, that
6470: library does not need to be propagated in the
6471: <code class="filename">buildlink3.mk</code> file.</p>
6472: <p>The following steps should help you decide if a
6473: <code class="filename">buildlink3.mk</code> file needs to be included:
6474: </p>
6475: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6476: <li class="listitem"><p>Look at the installed header files: What
6477: headers do they include? The packages providing these files
6478: must be buildlinked.</p></li>
6479: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6480: libraries and look against what other libraries they link.
6481: Some of the packages providing these probably need to be
6482: buildlinked; however, it's not automatic, since e.g. GTK on
6483: some systems pulls in the X libraries, so they will show up in
6484: the <code class="filename">ldd</code> output, while on others (like OS
6485: X) it won't. <code class="filename">ldd</code> output can thus only be
6486: used as a hint.</p></li>
6487: </ul></div>
6488: <p>
6489: </p>
6490: </div>
1.41 asau 6491: <div class="sect2">
1.1 dsieger 6492: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6493: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6494: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6495: and
6496: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6497: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185 wiz 6498: <p>Both variables set lower bounds for a version of this package.
6499: The two variables differ in that one describes source
1.184 rillig 6500: compatibility (API) and the other binary compatibility (ABI).
6501: The difference is that a change in the API breaks compilation of
6502: programs while changes in the ABI stop compiled programs from
6503: running.</p>
1.185 wiz 6504: <p>The
6505: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6506: variable in a <code class="filename">buildlink3.mk</code> should be
6507: changed very rarely. (One possible scenario: If all packages
6508: using this package need a higher version than defined in the
6509: <code class="filename">buildlink3.mk</code>,
1.184 rillig 6510: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6511: could be updated to that higher version.)</p>
6512: <p>On the other hand, changes to
1.184 rillig 6513: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6514: are more common. The variable will need to be updated every
6515: time the major version of one of its shared libraries is changed,
6516: or any other change where a binary built against the previous
6517: version of the package will not run against the new version any
6518: longer.</p>
6519: <p>In such a case, the package's
1.184 rillig 6520: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6521: must be increased to require the new package version. Then the
6522: <code class="varname">PKGREVISION</code> of all packages
6523: <em class="replaceable"><code>foo</code></em> that depend on this package need
6524: to be increased, and if they have
6525: <code class="filename">buildlink3.mk</code> files,
6526: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6527: in their <code class="filename">buildlink3.mk</code> files must be
6528: increased to the new version as well. This is required so that a
6529: package will pull in the versions of the packages that use the
6530: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6531: uniquely identify the packages built against the new ABI. The
1.207 leot 6532: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/revbump/index.html" target="_top"><code class="filename">pkgtools/revbump</code></a> package can
1.185 wiz 6533: help with these updates.</p>
6534: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6535: about dependencies on other packages, including the
6536: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184 rillig 6537: <p>Please take careful consideration before adjusting
6538: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6539: or
6540: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6541: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6542: cause unneeded package deletions and rebuilds. In many cases,
6543: new versions of packages work just fine with older
6544: dependencies.</p>
1.211 gutterid 6545: <p>Also, it is not needed to set
1.184 rillig 6546: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6547: when it is identical to
1.211 gutterid 6548: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6549: <p>Note there is also the distinction that users are able to disable
6550: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6551: variable, but there is no equivalent option for API dependencies.</p>
1.1 dsieger 6552: </div>
6553: </div>
1.41 asau 6554: <div class="sect1">
1.1 dsieger 6555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6556: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6557: <p>Some packages in pkgsrc install headers and libraries that
6558: coincide with headers and libraries present in the base system.
6559: Aside from a <code class="filename">buildlink3.mk</code> file, these
6560: packages should also include a <code class="filename">builtin.mk</code>
6561: file that includes the necessary checks to decide whether using
6562: the built-in software or the pkgsrc software is
6563: appropriate.</p>
6564: <p>The only requirements of a builtin.mk file for
6565: <em class="replaceable"><code>pkg</code></em> are:</p>
6566: <div class="orderedlist"><ol class="orderedlist" type="1">
6567: <li class="listitem"><p>It should set
6568: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6569: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6570: after it is included.</p></li>
6571: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6572: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6573: which is already set before the
6574: <code class="filename">builtin.mk</code> file is included.</p></li>
6575: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6576: is <span class="emphasis"><em>very</em></span> important and takes careful
6577: attention to <code class="filename">Makefile</code> coding.</p></li>
6578: </ol></div>
6579: <div class="sect2">
6580: <div class="titlepage"><div><div><h3 class="title">
6581: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6582: <p>The following is the recommended template for builtin.mk
6583: files:</p>
1.1 dsieger 6584: <pre class="programlisting">
1.184 rillig 6585: .if !defined(IS_BUILTIN.foo)
6586: #
6587: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6588: # genuinely exists in the system or not.
6589: #
6590: IS_BUILTIN.foo?= no
1.1 dsieger 6591:
1.184 rillig 6592: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6593: # version can be determined.
6594: #
6595: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6596: BUILTIN_PKG.foo?= foo-1.0
6597: . endif
6598: .endif # IS_BUILTIN.foo
1.1 dsieger 6599:
1.184 rillig 6600: .if !defined(USE_BUILTIN.foo)
6601: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6602: . if defined(BUILTIN_PKG.foo)
6603: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6604: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6605: USE_BUILTIN.foo!= \
6606: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6607: && ${ECHO} "yes" || ${ECHO} "no"
6608: . endif
6609: . endfor
6610: . endif
6611: .endif # USE_BUILTIN.foo
1.1 dsieger 6612:
1.184 rillig 6613: CHECK_BUILTIN.foo?= no
6614: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6615: #
6616: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6617: # "yes" or "no".
6618: #
6619: .endif # CHECK_BUILTIN.foo
1.1 dsieger 6620: </pre>
1.184 rillig 6621: <p>The first section sets
6622: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6623: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6624: in the base system. This should not be a base system software
6625: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6626: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6627: included as part of the base system. This variable is only
6628: used internally within the <code class="filename">builtin.mk</code>
6629: file.</p>
6630: <p>The second section sets
6631: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6632: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6633: system if it exists (if
6634: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6635: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6636: within the <code class="filename">builtin.mk</code> file.</p>
6637: <p>The third section sets
6638: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6639: and is <span class="emphasis"><em>required</em></span> in all
6640: <code class="filename">builtin.mk</code> files. The code in this
6641: section must make the determination whether the built-in
6642: software is adequate to satisfy the dependencies listed in
6643: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6644: This is typically done by comparing
6645: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6646: against each of the dependencies in
6647: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6648: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6649: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6650: end of the <code class="filename">builtin.mk</code> file. Note that
6651: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6652: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6653: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6654: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6655: that the built-in version of the software is similar enough to
6656: be used as a replacement.</p>
6657: <p>The last section is guarded by
6658: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6659: and includes code that uses the value of
6660: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6661: set in the previous section. This typically includes, e.g.,
6662: adding additional dependency restrictions and listing additional
6663: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6664: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6665: </div>
1.7 rillig 6666: </div>
1.1 dsieger 6667: </div>
1.41 asau 6668: <div class="chapter">
1.1 dsieger 6669: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6670: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1 dsieger 6671: <div class="toc">
6672: <p><b>Table of Contents</b></p>
1.100 leot 6673: <dl class="toc">
1.184 rillig 6674: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6675: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6676: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
6677: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6678: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6679: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6680: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6681: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6682: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 6683: </dl>
6684: </div>
1.184 rillig 6685: <p>The <code class="filename">PLIST</code> file contains a package's
6686: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6687: the package (relative to the <code class="filename">${PREFIX}</code>
6688: directory it's been installed in) plus some additional statements
1.207 leot 6689: - see the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.184 rillig 6690: This chapter addresses some issues that need attention when
6691: dealing with the <code class="filename">PLIST</code> file (or files, see
6692: below!).</p>
1.41 asau 6693: <div class="sect1">
1.1 dsieger 6694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6695: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6696: <p>Be sure to add a RCS ID line as the first thing in any
6697: <code class="filename">PLIST</code> file you write:</p>
6698: <pre class="programlisting">
6699: @comment $NetBSD $
6700: </pre>
6701: <p>An artificial space has been added between NetBSD and $, this is a
6702: workaround here to prevent CVS expanding to the filename of the guide. When
6703: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6704: </div>
1.41 asau 6705: <div class="sect1">
1.1 dsieger 6706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6707: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6708: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6709: to output a PLIST that matches any new files since the package
6710: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6711: more information on this target.</p>
1.1 dsieger 6712: </div>
1.41 asau 6713: <div class="sect1">
1.1 dsieger 6714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6715: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6716: </h2></div></div></div>
6717: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6718: of AWK patterns and actions that are used to filter the output of
6719: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6720: scripting you like to it, but be careful with quoting.</p>
6721: <p>For example, to get all files inside the
6722: <code class="filename">libdata/foo</code> directory removed from the
6723: resulting PLIST:</p>
1.1 dsieger 6724: <pre class="programlisting">
1.184 rillig 6725: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 6726: </pre>
1.185 wiz 6727: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6728: evaluated after the file list and directory list are sorted.
6729: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6730: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6731: list and directory list are sorted.</p>
1.184 rillig 6732: </div>
6733: <div class="sect1">
6734: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6735: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6736: <p>A number of variables are substituted automatically in
6737: PLISTs when a package is installed on a system. This includes the
6738: following variables:</p>
6739: <div class="variablelist"><dl class="variablelist">
6740: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6741: <dd>
6742: <p>Some packages like emacs and perl embed information
6743: about which architecture they were built on into the
6744: pathnames where they install their files. To handle this
6745: case, PLIST will be preprocessed before actually used, and
6746: the symbol
6747: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6748: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6749: same is done if the string
6750: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6751: PLIST somewhere - use this on packages that have GNU
6752: autoconf-created configure scripts.</p>
6753: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6754: <h3 class="title">Legacy note</h3>
6755: <p>There used to be a symbol
6756: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6757: was replaced by the output of <span class="command"><strong>uname
6758: -m</strong></span>, but that's no longer supported and has
6759: been removed.</p>
6760: </div>
6761: </dd>
6762: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6763: <dd>
6764: <p>Some packages want to embed the OS name and version
6765: into some paths. To do this, use these variables in the
6766: <code class="filename">PLIST</code>:
6767: </p>
6768: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6769: <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>
6770: <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>
6771: <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>
6772: </ul></div>
6773: </dd>
6774: </dl></div>
6775: <p>For a list of values which are replaced by
6776: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6777: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6778: <code class="varname">PLIST_SUBST</code> should help.</p>
6779: <p>If you want to change other variables not listed above, you
6780: can add variables and their expansions to this variable in the
6781: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="12.5. Optional files">Section 12.5, “Optional files”</a>):</p>
1.1 dsieger 6782: <pre class="programlisting">
1.184 rillig 6783: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 6784: </pre>
1.184 rillig 6785: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6786: in the <code class="filename">PLIST</code> with
6787: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6788: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6789: the common case of conditionally including some
6790: <code class="filename">PLIST</code> entries. It can be done by adding
6791: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6792: setting the corresponding <code class="varname">PLIST.foo</code> variable
6793: to <code class="literal">yes</code> if the entry should be included.
6794: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6795: in the <code class="filename">PLIST</code> with either
6796: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6797: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6798: For example, in <code class="filename">Makefile</code>:</p>
1.66 asau 6799: <pre class="programlisting">
1.184 rillig 6800: PLIST_VARS+= foo
6801: .if <em class="replaceable"><code>condition</code></em>
6802: PLIST.foo= yes
6803: .else
1.66 asau 6804: </pre>
1.184 rillig 6805: <p>And then in <code class="filename">PLIST</code>:</p>
1.1 dsieger 6806: <pre class="programlisting">
1.184 rillig 6807: @comment $NetBSD $
6808: bin/bar
6809: man/man1/bar.1
6810: ${PLIST.foo}bin/foo
6811: ${PLIST.foo}man/man1/foo.1
6812: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 6813: </pre>
1.184 rillig 6814: <p>An artificial space has been added between NetBSD and $, this is a
6815: workaround here to prevent CVS expanding to the filename of the guide. When
1.195 gutterid 6816: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6817: </div>
1.184 rillig 6818: <div class="sect1">
6819: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6820: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6821: <p>Man pages should be installed in compressed form if
6822: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6823: and uncompressed otherwise. To handle this in the
6824: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6825: appended/removed automatically for man pages according to
6826: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6827: or not, see above for details. This modification of the
6828: <code class="filename">PLIST</code> file is done on a copy of it, not
6829: <code class="filename">PLIST</code> itself.</p>
1.1 dsieger 6830: </div>
1.41 asau 6831: <div class="sect1">
1.1 dsieger 6832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6833: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6834: </h2></div></div></div>
6835: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6836: in generating the binary package, set the variable
6837: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.207 leot 6838: The files are later concatenated using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.184 rillig 6839: important. The default for <code class="varname">PLIST_SRC</code> is
6840: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1 dsieger 6841: </div>
1.41 asau 6842: <div class="sect1">
1.1 dsieger 6843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6844: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6845: <p>Some packages decide to install a different set of files based on
6846: the operating system being used. These differences can be
6847: automatically handled by using the following files:</p>
6848: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6849: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6850: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6851: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6852: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6853: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6854: </ul></div>
1.1 dsieger 6855: </div>
1.41 asau 6856: <div class="sect1">
1.1 dsieger 6857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6858: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6859: <p>Some packages decide to generate hard-to-guess file names
6860: during installation that are hard to wire down.</p>
6861: <p>In such cases, you can set the
6862: <code class="varname">GENERATE_PLIST</code> variable to shell code
6863: terminated (with a semicolon) that will output PLIST entries which
6864: will be appended to the PLIST</p>
6865: <p>You can find one example in editors/xemacs:</p>
6866: <pre class="programlisting">
6867: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6868: </pre>
6869: <p>which will append something like
6870: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6871: <code class="filename">PLIST</code>.
6872: </p>
1.1 dsieger 6873: </div>
1.41 asau 6874: <div class="sect1">
1.1 dsieger 6875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6876: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6877: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6878: multiple (and unrelated) packages install files. These
6879: directories were problematic because you had to add special
6880: tricks in the PLIST to conditionally remove them, or have some
6881: centralized package handle them.</p>
6882: <p>In pkgsrc, it is now easy: Each package should create
6883: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6884: will remove any directories left empty after uninstalling a
6885: package.</p>
6886: <p>If a package needs an empty directory to work, create
6887: the directory during installation as usual, and also add an
6888: entry to the PLIST:
6889:
6890: </p>
6891: <pre class="programlisting">
6892: @pkgdir path/to/empty/directory
6893: </pre>
6894: <p>
6895:
6896: or take a look at <code class="varname">MAKE_DIRS</code> and
6897: <code class="varname">OWN_DIRS</code>.
1.1 dsieger 6898: </p>
6899: </div>
1.184 rillig 6900: </div>
6901: <div class="chapter">
6902: <div class="titlepage"><div><div><h2 class="title">
6903: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6904: <div class="toc">
6905: <p><b>Table of Contents</b></p>
6906: <dl class="toc">
6907: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6908: <dd><dl>
6909: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6910: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6911: </dl></dd>
6912: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6913: <dd><dl>
6914: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6915: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
1.239 dholland 6916: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
6917: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
6918: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 6919: </dl></dd>
6920: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6921: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
6922: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6923: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6924: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6925: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6926: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
6927: </dl>
6928: </div>
6929: <p>This chapter describes the framework known as
6930: <code class="literal">pkginstall</code>, whose key features are:</p>
6931: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6932: <li class="listitem"><p>Generic installation and manipulation of directories and files
6933: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6934: <li class="listitem"><p>Automatic handling of configuration files during installation,
6935: provided that packages are correctly designed.</p></li>
6936: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6937: <li class="listitem"><p>Registration of system users and groups.</p></li>
6938: <li class="listitem"><p>Registration of system shells.</p></li>
6939: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6940: </ul></div>
6941: <p>The following sections inspect each of the above points in detail.</p>
6942: <p>You may be thinking that many of the things described here could be
6943: easily done with simple code in the package's post-installation target
6944: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6945: as the code in them is only executed when building from source. Machines
6946: using binary packages could not benefit from it at all (as the code itself
6947: could be unavailable). Therefore, the only way to achieve any of the items
6948: described above is by means of the installation scripts, which are
6949: automatically generated by pkginstall.</p>
1.41 asau 6950: <div class="sect1">
1.1 dsieger 6951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6952: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6953: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6954: of files and directories that belong to a package. The names used in it
6955: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6956: which means that it cannot register files outside this directory (absolute
6957: path names are not allowed). Despite this restriction, some packages need
6958: to install files outside this location; e.g., under
6959: <code class="filename">${VARBASE}</code> or
6960: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6961: is to create such files during installation time by using
6962: installation scripts.</p>
6963: <p>The generic installation scripts are shell scripts that can
6964: contain arbitrary code. The list of scripts to execute is taken from
6965: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6966: <code class="filename">INSTALL</code>. A similar variable exists for package
6967: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6968: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6969: commands, so they have the potential to create and manage files
6970: anywhere in the file system.</p>
6971: <p>Using these general installation files is not recommended, but
6972: may be needed in some special cases. One reason for avoiding them is
6973: that the user has to trust the packager that there is no unwanted or
6974: simply erroneous code included in the installation script. Also,
6975: previously there were many similar scripts for the same functionality,
6976: and fixing a common error involved finding and changing all of
6977: them.</p>
6978: <p>The pkginstall framework offers another, standardized way. It
6979: provides generic scripts to abstract the manipulation of such files
6980: and directories based on variables set in the package's
6981: <code class="filename">Makefile</code>. The rest of this section describes
6982: these variables.</p>
6983: <div class="sect2">
6984: <div class="titlepage"><div><div><h3 class="title">
6985: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
6986: <p>The following variables can be set to request the creation of
6987: directories anywhere in the file system:</p>
6988: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6989: <li class="listitem">
6990: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
6991: contain a list of directories that should be created and should attempt
6992: to be destroyed by the installation scripts. The difference between
6993: the two is that the latter prompts the administrator to remove any
6994: directories that may be left after deinstallation (because they were
6995: not empty), while the former does not. Example:</p>
6996: <pre class="programlisting">
6997: MAKE_DIRS+= ${VARBASE}/foo/private
6998: </pre>
6999: </li>
7000: <li class="listitem">
7001: <p><code class="varname">MAKE_DIRS_PERMS</code> and
7002: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
7003: which directories should be created and should attempt to be destroyed
7004: by the installation scripts. Each tuple holds the following values,
7005: separated by spaces: the directory name, its owner, its group and its
7006: numerical mode. For example:</p>
7007: <pre class="programlisting">
7008: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
7009: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
7010: </pre>
7011: <p>The difference between the two is exactly the same as their
7012: non-<code class="varname">PERMS</code> counterparts.</p>
7013: </li>
7014: </ul></div>
1.1 dsieger 7015: </div>
1.184 rillig 7016: <div class="sect2">
7017: <div class="titlepage"><div><div><h3 class="title">
7018: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
7019: <p>Creating non-empty files outside the installation prefix is tricky
7020: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.239 dholland 7021: To overcome this problem, the only solution is to extract the file in a
1.184 rillig 7022: known place (i.e., inside the installation prefix) and copy it to the
7023: appropriate location during installation (done by the installation scripts
1.239 dholland 7024: generated by pkginstall). We will call the former the <span class="emphasis"><em>reference
1.184 rillig 7025: file</em></span> in the following paragraphs, which describe the variables
7026: that can be used to automatically and consistently handle files outside the
7027: installation prefix:</p>
7028: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.239 dholland 7029: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
7030: and target files. At installation time, the reference file is copied
7031: to the target if and only if the latter does not exist. Upon
7032: deinstallation, the reference file is removed provided that it was
7033: not modified by the installation.</p></li>
1.184 rillig 7034: <li class="listitem">
1.239 dholland 7035: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
7036: reference files and targets, including owner, group, and numeric
7037: permissions that should be set. For example:</p>
1.1 dsieger 7038: <pre class="programlisting">
1.184 rillig 7039: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7040: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 7041: </pre>
1.184 rillig 7042: </li>
1.239 dholland 7043: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
7044: <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
7045: <code class="varname">REQD_FILES</code> and
7046: <code class="varname">REQD_FILES_PERMS</code> respectively. The difference
7047: is that these variables are specifically intended for handling
7048: configuration files, for which additional conventions and
7049: constraints apply. See <a class="xref" href="#conf-files" title="20.2. Configuration files">Section 20.2, “Configuration files”</a> for further
7050: discussion. Note in particular that while handling of
7051: configuration files can be disabled by the user (see <a class="xref" href="#conf-files-disable" title="20.2.5. Disabling handling of configuration files">Section 20.2.5, “Disabling handling of configuration files”</a>), this setting does not affect
7052: <code class="varname">REQD_FILES</code> and
7053: <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.184 rillig 7054: </ul></div>
1.239 dholland 7055: <p>To install an empty file, one can use these macros and
7056: <code class="filename">/dev/null</code> as the reference file.</p>
1.184 rillig 7057: </div>
1.1 dsieger 7058: </div>
1.41 asau 7059: <div class="sect1">
1.1 dsieger 7060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7061: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.239 dholland 7062: <p>There are two principles that govern the handling of
7063: configuration files in pkgsrc: first, the user's configuration must
7064: not be lost or overwritten by upgrades or reinstallations; and second,
7065: the default configuration should always be available for reference.
7066: To that end, pkgsrc has a framework specifically for handling
7067: configuration files. In general, configuration files are installed
7068: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
7069: there to the pertinent <code class="filename">etc</code> directory as a
7070: separate step and only as needed.</p>
7071: <p>To make this work, there are three things that need to happen,
7072: any of which may require patching. First, the package must be told to
7073: read its configuration from the correct place at runtime; this place
7074: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
7075: of it) which is often but not always
7076: <code class="filename">${PREFIX}/etc</code>. Second, the package must be
7077: taught to install its default configuration files in
7078: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
7079: point at which patching often becomes required because it is not the
7080: same place as the runtime location. Third, the configuration files
7081: need to be declared in the package makefile; this is the easy part.
7082: </p>
7083: <p>With those elements in place, the right things will happen: the
7084: package install phase and resulting binary package will not touch
7085: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
7086: will be copied into place by the pkgsrc framework only if not already
7087: present. Similarly, upon deinstall the configuration will not be
7088: removed if it has been modified. (This means that in the case of
7089: reinstallation and upgrades, unmodified configuration files are
7090: updated but modifications are never discarded.)</p>
7091: <p>The following sections describe how to make these things happen
7092: and document other relevant knobs available in the pkgsrc
7093: infrastructure.</p>
1.184 rillig 7094: <div class="sect2">
7095: <div class="titlepage"><div><div><h3 class="title">
7096: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7097: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7098: specifies where configuration files shall be installed. Its contents are
7099: set based upon the following variables:</p>
7100: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7101: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7102: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.239 dholland 7103: be overridden by the user to point to their preferred location (e.g.,
1.184 rillig 7104: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7105: Packages must not use it directly.</p></li>
7106: <li class="listitem">
7107: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7108: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7109: for the package being built shall be installed. The definition of this
7110: variable only makes sense in the package's
7111: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7112: <p>As an example, consider the Apache package,
1.207 leot 7113: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/index.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.184 rillig 7114: configuration files under the
7115: <code class="filename">httpd/</code> subdirectory of
7116: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7117: Makefile.</p>
7118: </li>
7119: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7120: variable that holds this package's configuration directory (if
7121: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7122: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7123: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7124: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7125: directory where the configuration files for the package identified by
7126: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7127: </ul></div>
7128: <p>Based on the above variables, pkginstall determines the value of
7129: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.239 dholland 7130: variable that may be used within a package to refer to its configuration
1.184 rillig 7131: directory. The algorithm used to set its value is basically the
7132: following:</p>
7133: <div class="orderedlist"><ol class="orderedlist" type="1">
7134: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7135: its value is used.</p></li>
7136: <li class="listitem"><p>If the previous variable is not defined but
7137: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7138: <code class="filename">Makefile</code>, the resulting value is
7139: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7140: <li class="listitem"><p>Otherwise, it is set to
7141: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7142: </ol></div>
7143: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.239 dholland 7144: automatically added to <code class="filename">OWN_DIRS</code>. This causes it
7145: to be automatically created if needed. See <a class="xref" href="#dirs-outside-prefix" title="20.1.1. Directory manipulation">Section 20.1.1, “Directory manipulation”</a> for further details. This does not apply to
7146: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
7147: created with <code class="varname">OWN_DIRS</code> or
7148: <code class="varname">MAKE_DIRS</code>.</p>
1.184 rillig 7149: </div>
7150: <div class="sect2">
7151: <div class="titlepage"><div><div><h3 class="title">
7152: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7153: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.239 dholland 7154: known place, you need to teach each package where to install its files. In
7155: some cases you will have to patch the package Makefiles to achieve it. If
7156: you are lucky, though, it may be as easy as passing an extra flag to the
7157: configuration script. This is the case for packages using GNU
7158: autoconf:</p>
1.1 dsieger 7159: <pre class="programlisting">
1.184 rillig 7160: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 7161: </pre>
1.184 rillig 7162: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.239 dholland 7163: for</em></span> its configuration files, not where they will be installed.
7164: Fortunately, there is a different way to specify the latter, as seen
1.240 gutterid 7165: in the next section, although the combination is rather confusing at
1.239 dholland 7166: first glance.</p>
1.1 dsieger 7167: </div>
1.184 rillig 7168: <div class="sect2">
7169: <div class="titlepage"><div><div><h3 class="title">
1.239 dholland 7170: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
7171: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.184 rillig 7172: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7173: directly</strong></span>. Bad news is that many software installation scripts
7174: will, out of the box, mess with the contents of that directory. So what is
7175: the correct procedure to fix this issue?</p>
7176: <p>You must teach the package (usually by manually patching it) to
7177: install any configuration files under the examples hierarchy,
7178: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7179: <code class="filename">PLIST</code> registers them and the administrator always
7180: has the original copies available.</p>
1.239 dholland 7181: <p>It turns out that for packages using GNU autoconf it is possible
7182: to create the desired effect by setting <code class="varname">sysconfdir</code>
7183: on the make command line at install time. Consider this example taken
7184: from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a>:</p>
7185: <pre class="programlisting">
7186: EGDIR= ${PREFIX}/share/examples/mutt
7187: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
7188: </pre>
7189: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
7190: used for this purpose, is local to that package and has no meaning
7191: outside it.</p>
7192: </div>
7193: <div class="sect2">
7194: <div class="titlepage"><div><div><h3 class="title">
7195: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.184 rillig 7196: <p>Once the required configuration files are in place (i.e., under the
1.239 dholland 7197: examples hierarchy), the pkginstall framework can use them as reference copies
1.184 rillig 7198: during the package installation to update what is in
7199: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7200: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.239 dholland 7201: used. Check out <a class="xref" href="#files-outside-prefix" title="20.1.2. File manipulation">Section 20.1.2, “File manipulation”</a> for further
7202: information about their syntax and their purpose. Here is an example,
7203: taken from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/index.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
7204: <pre class="programlisting">
7205: EGDIR= ${PREFIX}/share/examples/mutt
7206: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7207: </pre>
7208: <p>Note that (as in the previous section's example) the
7209: <code class="varname">EGDIR</code> variable is specific to the package and has
7210: no meaning outside it.</p>
7211: <p>For reference, the complete example from Mutt is as follows:</p>
1.1 dsieger 7212: <pre class="programlisting">
1.239 dholland 7213: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
7214: EGDIR= ${PREFIX}/share/examples/mutt
7215: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7216: INSTALLATION_DIRS+= ${EGDIR}
7217: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.1 dsieger 7218: </pre>
7219: </div>
1.184 rillig 7220: <div class="sect2">
7221: <div class="titlepage"><div><div><h3 class="title">
1.239 dholland 7222: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.184 rillig 7223: <p>The automatic copying of config files can be toggled by setting the
7224: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7225: installation.</p>
1.1 dsieger 7226: </div>
7227: </div>
1.41 asau 7228: <div class="sect1">
1.1 dsieger 7229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7230: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7231: <p>System startup scripts are special files because they must be
7232: installed in a place known by the underlying OS, usually outside the
7233: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
7234: can be used. However, pkginstall provides a special mechanism to handle
7235: these files.</p>
7236: <p>In order to provide system startup scripts, the package has
7237: to:</p>
7238: <div class="orderedlist"><ol class="orderedlist" type="1">
7239: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7240: the <code class="literal">.sh</code> suffix appended. Considering the
1.223 nia 7241: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups-base/index.html" target="_top"><code class="filename">print/cups-base</code></a> package as an example, it
7242: has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.184 rillig 7243: <li class="listitem">
7244: <p>Tell pkginstall to handle it, appending the name of the script,
7245: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7246: Continuing the previous example:</p>
7247: <pre class="programlisting">
7248: RCD_SCRIPTS+= cupsd
7249: </pre>
7250: </li>
7251: </ol></div>
7252: <p>Once this is done, pkginstall will do the following steps for each
7253: script in an automated fashion:</p>
7254: <div class="orderedlist"><ol class="orderedlist" type="1">
7255: <li class="listitem"><p>Process the file found in the files directory applying all the
7256: substitutions described in the <code class="filename">FILES_SUBST</code>
7257: variable.</p></li>
7258: <li class="listitem"><p>Copy the script from the files directory to the examples
7259: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.239 dholland 7260: that this reference file must be explicitly registered in the
1.184 rillig 7261: <code class="filename">PLIST</code>.</p></li>
7262: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7263: from the examples hierarchy into the system-wide startup scripts
7264: directory.</p></li>
7265: </ol></div>
7266: <div class="sect2">
7267: <div class="titlepage"><div><div><h3 class="title">
7268: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7269: <p>The automatic copying of config files can be toggled by setting the
7270: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7271: installation. Note that the scripts will be always copied inside the
7272: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7273: matter what the value of this variable is.</p>
1.1 dsieger 7274: </div>
7275: </div>
1.184 rillig 7276: <div class="sect1">
7277: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7278: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7279: <p>If a package needs to create special users and/or groups during
7280: installation, it can do so by using the pkginstall framework.</p>
7281: <p>Users can be created by adding entries to the
7282: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7283: syntax:</p>
7284: <pre class="programlisting">
7285: user:group
7286: </pre>
7287: <p>Further specification of user details may be done by setting
7288: per-user variables.
7289: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7290: numeric UID for the user.
7291: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7292: user's description or comment.
7293: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7294: user's home directory, and defaults to
7295: <code class="filename">/nonexistent</code> if not specified.
7296: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7297: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7298: not specified.</p>
7299: <p>Similarly, groups can be created by adding entries to the
7300: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7301: <pre class="programlisting">
7302: group
7303: </pre>
7304: <p>The numeric GID of the group may be set by defining
7305: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7306: <p>If a package needs to create the users and groups at an earlier
7307: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7308: <code class="literal">configure</code>,<code class="literal">build</code>, or
7309: <code class="literal">pre-install</code> to indicate the phase before which the
7310: users and groups are created. In this case, the numeric UIDs and GIDs
7311: of the created users and groups are automatically hardcoded into the
7312: final installation scripts.</p>
1.1 dsieger 7313: </div>
1.41 asau 7314: <div class="sect1">
1.1 dsieger 7315: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7316: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7317: <p>Packages that install system shells should register them in the shell
7318: database, <code class="filename">/etc/shells</code>, to make things easier to the
7319: administrator. This must be done from the installation scripts to keep
7320: binary packages working on any system. pkginstall provides an easy way to
7321: accomplish this task.</p>
7322: <p>When a package provides a shell interpreter, it has to set the
7323: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7324: add some hooks to the installation scripts to handle it. Consider the
1.207 leot 7325: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/index.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.184 rillig 7326: <pre class="programlisting">
7327: PKG_SHELL= ${PREFIX}/bin/zsh
7328: </pre>
7329: <div class="sect2">
7330: <div class="titlepage"><div><div><h3 class="title">
7331: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7332: <p>The automatic registration of shell interpreters can be disabled by
7333: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7334: environment variable to <code class="literal">NO</code>.</p>
7335: </div>
1.1 dsieger 7336: </div>
1.41 asau 7337: <div class="sect1">
1.1 dsieger 7338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7339: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7340: <p>Packages that install X11 fonts should update the database files
7341: that index the fonts within each fonts directory. This can easily be
7342: accomplished within the pkginstall framework.</p>
7343: <p>When a package installs X11 fonts, it must list the directories in
7344: which fonts are installed in the
7345: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7346: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7347: <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
7348: installation scripts to run the appropriate commands to update the fonts
7349: database files within each of those directories. For convenience, if the
7350: directory path is relative, it is taken to be relative to the package's
1.207 leot 7351: installation prefix. Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/index.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.1 dsieger 7352: <pre class="programlisting">
1.184 rillig 7353: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 7354: </pre>
1.184 rillig 7355: <div class="sect2">
7356: <div class="titlepage"><div><div><h3 class="title">
7357: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7358: <p>The automatic update of fonts databases can be disabled by
7359: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7360: environment variable to <code class="literal">NO</code>.</p>
1.1 dsieger 7361: </div>
7362: </div>
7363: </div>
1.41 asau 7364: <div class="chapter">
1.1 dsieger 7365: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 7366: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 7367: <div class="toc">
7368: <p><b>Table of Contents</b></p>
1.100 leot 7369: <dl class="toc">
1.154 rillig 7370: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 7371: <dd><dl>
1.154 rillig 7372: <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>
7373: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7374: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7375: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7376: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7377: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7378: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7379: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7380: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7381: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7382: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7383: </dl></dd>
7384: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7385: <dd><dl>
7386: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7387: <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>
7388: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7389: </dl></dd>
7390: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7391: <dd><dl>
7392: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7393: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7394: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 7395: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 7396: </dl></dd>
7397: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7398: <dd><dl>
7399: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7400: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 7401: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 7402: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
7403: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
7404: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
7405: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 7406: </dl></dd>
7407: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7408: <dd><dl>
7409: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7410: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 7411: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7412: <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>
7413: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 7414: </dl></dd>
7415: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7416: <dd><dl>
7417: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7418: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7419: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7420: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7421: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 7422: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154 rillig 7423: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
7424: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203 nia 7425: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
7426: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
7427: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
7428: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
7429: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
7430: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
7431: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1 dsieger 7432: emulation</a></span></dt>
1.203 nia 7433: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
7434: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1 dsieger 7435: </dl></dd>
1.154 rillig 7436: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7437: </dl>
7438: </div>
1.41 asau 7439: <div class="sect1">
1.1 dsieger 7440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7441: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 7442: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7443: different platforms. As a result, it is important to ensure,
7444: where possible, that packages in pkgsrc are portable. This
7445: chapter mentions some particular details you should pay
7446: attention to while working on pkgsrc.</p>
1.41 asau 7447: <div class="sect2">
1.1 dsieger 7448: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7449: <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 7450: </h3></div></div></div>
7451: <p>The pkgsrc user can configure pkgsrc by overriding several
7452: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7453: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7454: want to use those variables in the preprocessor directives of
1.207 leot 7455: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 7456: <code class="literal">.for</code>), you need to include the file
7457: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7458: loads the user preferences.</p>
7459: <p>But note that some variables may not be completely defined
7460: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7461: included, as they may contain references to variables that are
1.108 rillig 7462: not yet defined. In shell commands (the lines in
7463: <code class="filename">Makefile</code> that are indented with a tab) this
7464: is no problem, since variables are only expanded when they are
7465: used. But in the preprocessor directives mentioned above and in
7466: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7467: dependencies</code>) the variables are expanded at load
7468: time.</p>
1.41 asau 7469: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7470: <h3 class="title">Note</h3>
1.108 rillig 7471: <p>To check whether a variable can be used at load time,
7472: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7473: </div>
7474: </div>
1.41 asau 7475: <div class="sect2">
1.1 dsieger 7476: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7477: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7478: <p>Occasionally, packages require interaction from the user,
7479: and this can be in a number of ways:</p>
1.41 asau 7480: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7481: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7482: interaction such as entering username/password or accepting a
7483: license on a web page.</p></li>
1.23 wiz 7484: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7485: passwords.</p></li>
1.23 wiz 7486: <li class="listitem"><p>help to configure the package before it is built</p></li>
7487: <li class="listitem"><p>help during the build process</p></li>
7488: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7489: </ul></div>
1.108 rillig 7490: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7491: variable to define which stages need interaction. This should be
7492: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7493: <pre class="programlisting">
7494: INTERACTIVE_STAGE= configure install
1.111 sevan 7495: </pre>
1.1 dsieger 7496: <p>The user can then decide to skip this package by setting the
1.108 rillig 7497: <code class="varname">BATCH</code> variable. Packages that require interaction
7498: are also excluded from bulk builds.</p>
1.1 dsieger 7499: </div>
1.41 asau 7500: <div class="sect2">
1.1 dsieger 7501: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7502: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7503: <p>Authors of software can choose the licence under which software
7504: can be copied. The Free Software Foundation has declared some
7505: licenses "Free", and the Open Source Initiative has a definition of
7506: "Open Source".</p>
7507: <p>By default, pkgsrc allows packages with Free or Open Source
7508: licenses to be built. To allow packages with other licenses to be
7509: built as well, the pkgsrc user needs to add these licenses to the
7510: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7511: that this variable only affects which packages may be
7512: <span class="emphasis"><em>built</em></span>, while the license terms often also
7513: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7514: <p>One might want to only install packages with a BSD license,
1.108 rillig 7515: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7516: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7517: user can override the default by setting the
7518: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7519: of "+=". The licenses accepted by default are defined in the
7520: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7521: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7522: <p>The license tag mechanism is intended to address
7523: copyright-related issues surrounding building, installing and
7524: using a package, and not to address redistribution issues (see
7525: <code class="varname">RESTRICTED</code> and
1.111 sevan 7526: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7527: Packages with redistribution restrictions should set these
7528: tags.</p>
1.1 dsieger 7529: <p>Denoting that a package may be copied according to a
7530: particular license is done by placing the license in
7531: <code class="filename">pkgsrc/licenses</code> and setting the
7532: <code class="varname">LICENSE</code> variable to a string identifying the
1.207 leot 7533: license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/index.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.1 dsieger 7534: <pre class="programlisting">
7535: LICENSE= xv-license
1.111 sevan 7536: </pre>
1.1 dsieger 7537: <p>When trying to build, the user will get a notice that the
7538: package is covered by a license which has not been placed in the
7539: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7540: <pre class="programlisting">
7541: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7542: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7543: ===> To view the license, enter "/usr/bin/make show-license".
7544: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7545: ===> ACCEPTABLE_LICENSES+=xv-license
7546: *** Error code 1
1.111 sevan 7547: </pre>
1.10 hubertf 7548: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7549: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7550: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7551: convey to pkgsrc that it should not in the future fail because of
7552: that license:</p>
7553: <pre class="programlisting">
7554: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7555: </pre>
7556: <p>The use of <code class="varname">LICENSE=shareware</code>,
7557: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7558: is deprecated because it does not crisply refer to a particular
7559: license text. Another problem with such usage is that it does not
7560: enable a user to tell pkgsrc to proceed for a single package
7561: without also telling pkgsrc to proceed for all packages with that
7562: tag.</p>
7563: <div class="sect3">
7564: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7565: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7566: <p>When adding a package with a new license, the following steps
7567: are required:</p>
7568: <div class="orderedlist"><ol class="orderedlist" type="1">
7569: <li class="listitem">
1.169 rillig 7570: <p>Check whether the license qualifies as Free or Open Source by
7571: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7572: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7573: Open Source Initiative</a>. If this is the case, the filename in
7574: <code class="filename">pkgsrc/licenses/</code> does not need the
7575: <code class="filename">-license</code> suffix, and the license name should be
7576: added to:</p>
1.48 rodent 7577: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7578: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7579: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7580: <li class="listitem"><p>default_acceptable_licenses in
7581: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7582: </ul></div>
7583: </li>
1.169 rillig 7584: <li class="listitem"><p>The license text should be added to
7585: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7586: licenses can be seen in this directory.</p></li>
1.48 rodent 7587: </ol></div>
1.111 sevan 7588: </div>
7589: <div class="sect3">
7590: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7591: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7592: <p>When the license changes (in a way other than formatting),
1.111 sevan 7593: make sure that the new license has a different name (e.g.,
1.1 dsieger 7594: append the version number if it exists, or the date). Just
7595: because a user told pkgsrc to build programs under a previous
7596: version of a license does not mean that pkgsrc should build
7597: programs under the new licenses. The higher-level point is that
7598: pkgsrc does not evaluate licenses for reasonableness; the only
7599: test is a mechanistic test of whether a particular text has been
1.111 sevan 7600: approved by either of two bodies (FSF or OSI).</p>
7601: </div>
1.1 dsieger 7602: </div>
1.41 asau 7603: <div class="sect2">
1.1 dsieger 7604: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7605: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7606: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7607: By declaring the restrictions, package tools can
1.1 dsieger 7608: automatically refrain from e.g. placing binary packages on FTP
7609: sites.</p>
1.111 sevan 7610: <p>There are four possible restrictions, which are
1.1 dsieger 7611: the cross product of sources (distfiles) and binaries not being
7612: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7613: language in any license, and because non-Free licenses tend to be
7614: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7615: CD-ROM.
7616:
7617: "FTP" means making the source or binary file available over the
7618: Internet at no charge.
7619:
7620: "CD-ROM" means making the source or binary available on some kind of
7621: media, together with other source and binary packages, which is sold
7622: for a distribution charge.
1.1 dsieger 7623: </p>
7624: <p>In order to encode these restrictions, the package system
7625: defines five make variables that can be set to note these
7626: restrictions:</p>
1.41 asau 7627: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7628: <li class="listitem">
1.1 dsieger 7629: <p><code class="varname">RESTRICTED</code></p>
7630: <p>This variable should be set whenever a restriction
7631: exists (regardless of its kind). Set this variable to a
7632: string containing the reason for the restriction. It should
7633: be understood that those wanting to understand the restriction
7634: will have to read the license, and perhaps seek advice of
7635: counsel.</p>
7636: </li>
1.23 wiz 7637: <li class="listitem">
1.1 dsieger 7638: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7639: <p>Binaries may not be placed on CD-ROM containing other
7640: binary packages, for which a distribution charge may be made.
7641: In this case, set this variable to
7642: <code class="varname">${RESTRICTED}</code>.</p>
7643: </li>
1.23 wiz 7644: <li class="listitem">
1.1 dsieger 7645: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7646: <p>Binaries may not made available on the Internet without
7647: charge. In this case, set this variable to
7648: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7649: binary packages will not be included on ftp.NetBSD.org.</p>
7650: </li>
1.23 wiz 7651: <li class="listitem">
1.1 dsieger 7652: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7653: <p>Distfiles may not be placed on CD-ROM, together with
7654: other distfiles, for which a fee may be charged. In this
7655: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7656: </p>
7657: </li>
1.23 wiz 7658: <li class="listitem">
1.1 dsieger 7659: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7660: <p>Distfiles may not made available via FTP at no charge.
7661: In this case, set this variable to
7662: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7663: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7664: </li>
7665: </ul></div>
1.111 sevan 7666: <p>Please note that packages will be removed from pkgsrc when the
7667: distfiles are not distributable and cannot be obtained for a period
7668: of one full quarter branch. Packages with manual/interactive fetch
7669: must have a maintainer and it is his/her responsibility to ensure
7670: this.</p>
1.1 dsieger 7671: </div>
1.41 asau 7672: <div class="sect2">
1.1 dsieger 7673: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7674: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175 gutterid 7675: <p>Your package may depend on some other package being present,
7676: and there are various ways of expressing this dependency.
7677: pkgsrc supports the <code class="varname">DEPENDS</code>,
7678: <code class="varname">BUILD_DEPENDS</code>,
7679: <code class="varname">TOOL_DEPENDS</code>, and
7680: <code class="varname">TEST_DEPENDS</code> definitions, the
1.1 dsieger 7681: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7682: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7683: to handle dependencies, and which uses the variables named above.
1.184 rillig 7684: See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.175 gutterid 7685: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7686: definition registers that pre-requisite in the binary package so it
7687: will be pulled in when the binary package is later installed, whilst
7688: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7689: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7690: dependency that is only needed for building or testing the resulting
1.184 rillig 7691: package. See also <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> for more information.</p>
1.1 dsieger 7692: <p>This means that if you only need a package present whilst
1.175 gutterid 7693: you are building or testing, it should be noted as a
7694: <code class="varname">TOOL_DEPENDS</code>,
7695: <code class="varname">BUILD_DEPENDS</code>, or
7696: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.156 leot 7697: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7698: packages, i.e. packages for the architecture where the package
7699: is built;
7700: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175 gutterid 7701: packages, i.e., packages for the architecture for which the package
1.156 leot 7702: is built.</p>
1.175 gutterid 7703: <p>The format for a <code class="varname">DEPENDS</code>,
7704: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7705: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1 dsieger 7706: <pre class="programlisting">
7707: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7708: </pre>
1.23 wiz 7709: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7710: may include any of the wildcard version numbers recognized by
1.207 leot 7711: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7712: <div class="orderedlist"><ol class="orderedlist" type="1">
7713: <li class="listitem">
1.1 dsieger 7714: <p>If your package needs another package's binaries or
1.54 wiz 7715: libraries to build and run, and if that package has a
1.1 dsieger 7716: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7717: <pre class="programlisting">
7718: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7719: </pre>
1.1 dsieger 7720: </li>
1.23 wiz 7721: <li class="listitem">
1.54 wiz 7722: <p>If your package needs another package's binaries or
7723: libraries only for building, and if that package has a
7724: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7725: <pre class="programlisting">
7726: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7727: </pre>
1.54 wiz 7728: <p>but set
7729: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7730: to make it a build dependency only. This case is rather
7731: rare.</p>
7732: </li>
7733: <li class="listitem">
1.25 spz 7734: <p>If your package needs binaries from another package to build,
1.156 leot 7735: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7736: <pre class="programlisting">
1.156 leot 7737: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7738: </pre>
1.1 dsieger 7739: </li>
1.156 leot 7740: <li class="listitem"><p>If your package needs static libraries to link against, header
7741: files to include, etc. from another package to build,
7742: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7743: <li class="listitem"><p>If your package needs a library with which to link and
7744: there is no <code class="filename">buildlink3.mk</code> file
7745: available, create one. Using
7746: <code class="varname">DEPENDS</code> won't be sufficient because the
7747: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7748: <li class="listitem">
1.25 spz 7749: <p>If your package needs some executable to be able to run
7750: correctly and if there's no
7751: <code class="filename">buildlink3.mk</code> file, this is specified
7752: using the <code class="varname">DEPENDS</code> variable. The
1.207 leot 7753: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/index.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.129 wiz 7754: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7755: when it runs, and that is specified:</p>
1.1 dsieger 7756: <pre class="programlisting">
1.129 wiz 7757: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7758: </pre>
1.25 spz 7759: </li>
1.175 gutterid 7760: <li class="listitem"><p>If your package includes a test suite that has extra
7761: dependencies only required for this purpose (frequently this
7762: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7763: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25 spz 7764: <li class="listitem">
7765: <p>You can use wildcards in package dependencies. Note that
7766: such wildcard dependencies are retained when creating binary
7767: packages. The dependency is checked when installing the binary
7768: package and any package which matches the pattern will be
7769: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7770: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7771: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7772: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7773: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7774: <p>Wildcards can also be used to specify that a package
7775: will only build against a certain minimum version of a
7776: pre-requisite:</p>
7777: <pre class="programlisting">
1.25 spz 7778: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7779: </pre>
1.25 spz 7780: <p>This means that the package will build using version 6.0
7781: of ImageMagick or newer. Such a dependency may be warranted
7782: if, for example, the command line options of an executable
7783: have changed.</p>
7784: <p>If you need to depend on minimum versions of libraries,
1.183 wiz 7785: set
7786: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7787: to the appropriate pattern before including its
7788: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7789: <pre class="programlisting">
7790: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7791: .include "../../graphics/jpeg/buildlink3.mk"
7792: </pre>
1.1 dsieger 7793: <p>For security fixes, please update the package
1.154 rillig 7794: 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 7795: information.</p>
7796: </li>
7797: </ol></div>
7798: <p>If your package needs files from another package to build,
7799: add the relevant distribution files to
7800: <code class="varname">DISTFILES</code>, so they will be extracted
1.207 leot 7801: automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/index.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.1 dsieger 7802: (It relies on the jpeg sources being present in source form
7803: during the build.)</p>
7804: </div>
1.41 asau 7805: <div class="sect2">
1.1 dsieger 7806: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7807: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.226 gutterid 7808: <p>Your package may conflict with other packages users might
7809: already have installed on their system, e.g., if your package
1.1 dsieger 7810: installs the same set of files as another package in the pkgsrc
1.227 wiz 7811: tree.</p>
1.207 leot 7812: <p>For example, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/libXaw3d/index.html" target="_top"><code class="filename">x11/libXaw3d</code></a>
7813: and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/index.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.142 leot 7814: install the same shared library, thus you set in
7815: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7816: <pre class="programlisting">
7817: CONFLICTS= Xaw-Xpm-[0-9]*
1.238 wiz 7818: </pre>
1.142 leot 7819: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7820: <pre class="programlisting">
7821: CONFLICTS= libXaw3d-[0-9]*
1.238 wiz 7822: </pre>
1.207 leot 7823: <p><a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.142 leot 7824: that conflict with existing packages and abort. However, in many
7825: situations this is too late in the process. Binary package managers
7826: will not know about the conflict until they attempt to install the
7827: package after already downloading it and all its dependencies.
7828: Users may also waste time building a package and its dependencies
7829: only to find out at the end that it conflicts with another package
7830: they have installed.</p>
7831: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7832: should be added in all cases where it is known that packages conflict
7833: with each other. These <code class="varname">CONFLICTS</code> entries are
1.207 leot 7834: exported in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.142 leot 7835: managers to inform users that packages cannot be installed onto
7836: the target system.</p>
1.1 dsieger 7837: </div>
1.41 asau 7838: <div class="sect2">
1.1 dsieger 7839: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7840: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7841: <p>There are several reasons why a package might be
7842: instructed to not build under certain circumstances. If the
7843: package builds and runs on most platforms, the exceptions
1.83 dholland 7844: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7845: the package builds and runs on a small handful of platforms,
7846: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7847: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7848: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7849: (OS-version-platform) that can use glob-style
7850: wildcards.</p>
7851: <p>If a package is not appropriate for some platforms (as
1.114 maya 7852: opposed to merely broken), a different set of variables should be
1.83 dholland 7853: used as this affects failure reporting and statistics.
7854: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7855: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7856: the package is appropriate for only a small handful of platforms
7857: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7858: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7859: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7860: (OS-version-platform) that can use glob-style
7861: wildcards.</p>
7862: <p>Some packages are tightly bound to a specific version of an
1.207 leot 7863: operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/index.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
1.1 dsieger 7864: backwards compatible with other versions of the OS, and should be
7865: uploaded to a version specific directory on the FTP server. Mark
7866: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7867: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7868: the package system internals, but may be used in the
7869: future.</p>
7870: <p>If the package should be skipped (for example, because it
7871: provides functionality already provided by the system), set
7872: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7873: the package should fail because some preconditions are not met,
7874: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7875: message.</p>
7876: </div>
1.41 asau 7877: <div class="sect2">
1.1 dsieger 7878: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7879: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7880: <p>To ensure that a package may not be deleted, once it has been
7881: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7882: be set in the package Makefile. This will be carried into any
7883: binary package that is made from this pkgsrc entry. A
1.23 wiz 7884: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.207 leot 7885: not be deleted using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 7886: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7887: </div>
1.41 asau 7888: <div class="sect2">
1.1 dsieger 7889: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7890: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7891: <p>When a vulnerability is found, this should be noted in
1.205 wiz 7892: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
7893: Entries in that file consist of three parts:</p>
7894: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7895: <li class="listitem"><p>package version pattern</p></li>
7896: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7897: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7898: </ul></div>
7899: <p>For the package version pattern please always use `<' to
7900: mark an upper bound (not `<='!). This will avoid possible
7901: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7902: related to security fixes. Lower bounds can be added too, using
7903: '>' or '>='. For example,
1.206 wiz 7904: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.205 wiz 7905: versions 1.0 (included) to 1.2 (excluded) of
7906: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7907: issue.</p>
7908: <p>Entries should always be added at the bottom of the file.</p>
7909: <p>When fixing packages, please modify the upper bound of the
7910: corresponding entry. To continue the previous example, if a fix
7911: was backported to version 1.1nb2, change the previous pattern to
1.206 wiz 7912: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.205 wiz 7913: <p>To locally test a package version pattern against a
7914: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7915: pmatch</strong></span> command.</p>
7916: <p>The URL should be as permanent as possible and provide as
7917: much information about the issue as possible. CVE entries are
7918: preferred.</p>
7919: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.31 wiz 7920: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7921: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7922: <code class="varname">PKGREVISION</code> should be increased (this is of
7923: course not necessary if the problem is fixed by using a newer
7924: release of the software), and the pattern in the
7925: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7926: <p>Also, if the fix should be applied to the stable pkgsrc
7927: branch, be sure to submit a pullup request!</p>
7928: <p>Binary packages already on ftp.NetBSD.org will be handled
7929: semi-automatically by a weekly cron job.</p>
1.205 wiz 7930: <p>In case a security issue is disputed, please contact
7931: pkgsrc-security@NetBSD.org.</p>
1.1 dsieger 7932: </div>
1.41 asau 7933: <div class="sect2">
1.1 dsieger 7934: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7935: <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 7936: <p>When making fixes to an existing package it can be useful
7937: to change the version number in <code class="varname">PKGNAME</code>. To
7938: avoid conflicting with future versions by the original author, a
1.23 wiz 7939: <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 7940: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7941: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7942: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7943: <pre class="programlisting">
7944: DISTNAME= foo-17.42
7945: PKGREVISION= 9
1.111 sevan 7946: </pre>
1.1 dsieger 7947: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7948: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7949: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7950: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7951: <code class="varname">PKGNAME_NOREV</code>.</p>
7952: <p>When a new release of the package is released, the
7953: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7954: minor release of the above package, things should be like:</p>
7955: <pre class="programlisting">
7956: DISTNAME= foo-17.43
1.111 sevan 7957: </pre>
1.1 dsieger 7958: <p><code class="varname">PKGREVISION</code> should be incremented for any
7959: non-trivial change in the resulting binary package. Without a
7960: <code class="varname">PKGREVISION</code> bump, someone with the previous
7961: version installed has no way of knowing that their package is out
7962: of date. Thus, changes without increasing
7963: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7964: trivial that no reasonable person would want to upgrade", and this
7965: is the rough test for when increasing
7966: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7967: changes that do not merit increasing
7968: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7969: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7970: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 7971: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7972: comments in Makefile.</p></li>
7973: <li class="listitem"><p>Changing build variables if the resulting binary
7974: package is the same.</p></li>
7975: <li class="listitem"><p>Changing
7976: <code class="filename">DESCR</code>.</p></li>
7977: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
7978: default options don't change.</p></li>
1.1 dsieger 7979: </ul></div>
7980: <p>Examples of changes that do merit an increase to
7981: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 7982: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7983: <li class="listitem"><p>Security fixes</p></li>
7984: <li class="listitem"><p>Changes or additions to a patch
7985: file</p></li>
7986: <li class="listitem"><p>Changes to the
7987: <code class="filename">PLIST</code></p></li>
7988: <li class="listitem"><p>A dependency is changed or
7989: renamed.</p></li>
1.1 dsieger 7990: </ul></div>
7991: <p>PKGREVISION must also be incremented when dependencies have ABI
7992: changes.</p>
7993: </div>
1.41 asau 7994: <div class="sect2">
1.1 dsieger 7995: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7996: <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 7997: <p>When you want to replace the same text in multiple files, or
7998: multiple times in the same file, it is cumbersome to maintain a patch
7999: file for this. This is where the SUBST framework steps in. It provides an
8000: easy-to-use interface for replacing text in files. It just needs the
8001: following information:</p>
8002: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8003: <li class="listitem"><p>In which phase of the package build cycle should the
8004: replacement happen?</p></li>
8005: <li class="listitem"><p>In which files should the replacement
1.172 rillig 8006: happen?</p></li>
1.180 rillig 8007: <li class="listitem"><p>Which text should be replaced with
8008: what?</p></li>
1.172 rillig 8009: </ul></div>
8010: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180 rillig 8011: variables. A minimal example is:</p>
8012: <pre class="programlisting">
8013: SUBST_CLASSES+= paths
8014: SUBST_STAGE.paths= pre-configure
8015: SUBST_FILES.paths= src/*.c
8016: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
8017: </pre>
8018: <p>Translated into English, it means: In the pre-configure stage (that
8019: is, after applying the patches from the patches/ directory and before
8020: running the configure script and the portability check), replace the text
8021: <code class="literal">/usr/local</code> with the content of the variable
8022: <code class="varname">PREFIX</code>.</p>
8023: <p>Each SUBST block starts by appending an identifier to
8024: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
8025: identifier can be chosen freely by the package. If there should ever be
8026: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
8027: early, so don't worry about name collisions.</p>
8028: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
8029: SUBST block are parameterized using this identifier. In the remainder of
8030: this section, these parameterized variables are written as
8031: <code class="varname">SUBST_STAGE.*</code>.</p>
8032: <pre class="programlisting">
8033: SUBST_CLASSES+= paths
8034: SUBST_STAGE.paths= pre-configure
8035: SUBST_MESSAGE.paths= Fixing absolute paths.
8036: SUBST_FILES.paths= src/*.c
8037: SUBST_FILES.paths+= scripts/*.sh
8038: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
8039: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8040: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
8041: </pre>
8042: <p>To get a complete picture about the SUBST substitutions, run
8043: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
8044: expected, run pkglint on the package, which detects several typical
8045: mistakes surrounding the SUBST blocks. For any questions that might
8046: remain after this, have a look at
8047: <code class="filename">mk/subst.mk</code>.</p>
8048: <div class="sect3">
8049: <div class="titlepage"><div><div><h4 class="title">
8050: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
8051: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
8052: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
8053: <code class="literal">pre-configure</code> is used most often, by far. The most
8054: popular stages are, in chronological order:</p>
8055: <div class="variablelist"><dl class="variablelist">
8056: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
8057: <dd>
8058: <p>The substitutions are applied immediately after the
8059: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
8060: package will leave no traces of the original files.</p>
8061: <p>When the substitution applies to files for which there is also a
8062: patch in the <code class="filename">patches/</code> directory, this means that the
8063: patches will be computed based on the result of the substitution. When
8064: these patches are sent to the upstream maintainer later, to be fixed in
8065: the upstream package, these patches may no longer match what the upstream
8066: author is used to. Because of this, <code class="literal">pre-configure</code> is
8067: often a better choice.</p>
8068: </dd>
8069: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
8070: <dd>
8071: <p>The substitutions are applied after the patches from the
8072: <code class="filename">patches/</code> directory. This makes it possible to run
8073: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.207 leot 8074: can be edited using the tools pkgvi and mkpatches from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/index.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package.</p>
1.180 rillig 8075: <p>When updating the patches, it is helpful to explicitly separate the
8076: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
8077: configure</strong></span>, and to only edit the patches between these commands.
8078: Otherwise the substitutions from the SUBST block will end up in the patch
8079: file. When this happens in really obvious ways, pkglint will complain
8080: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
8081: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
8082: can only detect these really obvious
8083: cases.</p>
8084: </dd>
8085: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
8086: <dd><p>This stage should only be used if the package defines a
8087: <code class="literal">pre-configure</code> action itself, and the substitution must
8088: happen after that. Typical examples are packages that use the
8089: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
8090: script from
8091: <code class="filename">configure.ac</code>.</p></dd>
8092: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8093: <dd><p>This stage is used to fix up any mistakes by the
8094: configure stage.</p></dd>
8095: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8096: <dd><p>This stage should only be used for substitutions that are
8097: clearly related to building the package, not for fixing the
8098: configuration. Substitutions for pathnames (such as replacing
8099: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8100: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8101: actual username) belong in pre-configure or post-configure
8102: instead.</p></dd>
8103: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8104: <dd>
8105: <p>Just as with pre-build, this stage should only be used
8106: for substitutions that are clearly related to building the package, not
8107: for fixing the configuration. Substitutions for pathnames (such as
8108: replacing <code class="filename">/usr/local</code> with
8109: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8110: <code class="literal">@MY_USER@</code> with the actual username) belong in
8111: pre-configure or post-configure instead.</p>
8112: <p>A typical use is to update pkg-config files to include the rpath
8113: compiler options.</p>
8114: </dd>
8115: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8116: <dd><p>In general, the install phase should be as simple as
8117: possible. As with the pre-build and post-build stages, it should not be
8118: used to fix pathnames or user names, these belong in pre-configure
8119: instead. There are only few legitimate use cases for applying
8120: substitutions in this stage.</p></dd>
8121: </dl></div>
8122: </div>
8123: <div class="sect3">
8124: <div class="titlepage"><div><div><h4 class="title">
1.181 rillig 8125: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180 rillig 8126: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8127: filename patterns. These patterns are relative to
8128: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8129: A typical example is:</p>
8130: <pre class="programlisting">
8131: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8132: </pre>
8133: <p>The above patterns, especially the last, are quite broad. The SUBST
8134: implementation checks that each filename pattern that is mentioned here
8135: has an effect. For example, if none of the
8136: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8137: and substituted, that filename pattern is redundant and should be left
1.181 rillig 8138: out. By default, the SUBST framework will complain with an error message.
8139: If the text to be substituted occurs in some of the files from a single
8140: pattern, but not in all of them, that is totally ok, and the SUBST
1.180 rillig 8141: framework will only print an INFO message for those files.</p>
8142: <p>If there is a good reason for having redundant filename patterns,
1.181 rillig 8143: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180 rillig 8144: <p>Another popular way of choosing the files for the substitutions is
8145: via a shell command, like this:</p>
8146: <pre class="programlisting">
1.181 rillig 8147: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 8148: SUBST_FILES.path= ${C_FILES_CMD:sh}
8149: </pre>
8150: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8151: freely chosen and independent of the SUBST framework.</p>
8152: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8153: lists each file individually. Thereby chances are higher that there are
8154: filename patterns in which no substitution happens. Since the SUBST
8155: framework cannot know whether the filename patterns in
8156: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8157: Makefile (where any redundant filename pattern would be suspicious) or
8158: been generated by a shell command (in which redundant filename patterns
8159: are more likely and to be expected), it will complain about these
8160: redundant filename patterns. Therefore, SUBST blocks that use a shell
8161: command to generate the list of filename patterns often need to set
8162: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8163: </div>
8164: <div class="sect3">
8165: <div class="titlepage"><div><div><h4 class="title">
8166: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8167: <p>In most cases, the substitutions are given using one or more
1.207 leot 8168: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.180 rillig 8169: <pre class="programlisting">
8170: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8171: </pre>
8172: <p>Each of the sed commands needs to be preceded by the
8173: <code class="literal">-e</code> option and should be specified on a line of its
8174: own, to avoid hiding short sed commands at the end of a line.</p>
8175: <p>Since the sed commands often contain shell metacharacters as the
8176: separator (the <code class="literal">|</code> in the above example), it is common
8177: to enclose them in single quotes.</p>
8178: <p>A common substitution is to replace placeholders of the form
8179: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8180: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8181: <pre class="programlisting">
8182: SUBST_VARS.path= PREFIX
8183: </pre>
8184: <p>This type of substitutions is typically done by the GNU configure
1.181 rillig 8185: scripts during the do-configure stage, but in some cases these need to be
8186: overridden. The same pattern is also used when a package defines patches
8187: that replace previously hard-coded paths like
8188: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8189: placeholder first, which then gets substituted by the actual
8190: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8191: cases, it works equally well to just use the SUBST framework to directly
8192: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8193: thereby omitting the intermediate patch file.</p>
1.180 rillig 8194: <p>If the above is not flexible enough, it is possible to not use sed
8195: at all for the substitution but to specify an entirely different command,
8196: like this:</p>
1.1 dsieger 8197: <pre class="programlisting">
1.180 rillig 8198: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8199: </pre>
8200: <p>This is used for the few remaining packages in which the
8201: distributed files use Windows-style line endings that need to be
8202: converted to UNIX-style line endings.</p>
8203: </div>
8204: <div class="sect3">
8205: <div class="titlepage"><div><div><h4 class="title">
8206: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8207: <p>When a SUBST block is applied during a package build, a message is
8208: logged. The default message is fine for most purposes but can be
8209: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8210: message.</p>
8211: </div>
1.1 dsieger 8212: </div>
8213: </div>
1.41 asau 8214: <div class="sect1">
1.1 dsieger 8215: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8216: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8217: <div class="sect2">
1.1 dsieger 8218: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8219: <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 8220: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8221: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8222: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8223: with the name of each file to download as an argument, expecting
8224: it to output the URL of the directory from which to download
1.207 leot 8225: it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/index.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.1 dsieger 8226: example of this usage.</p>
8227: <p>If the download can't be automated, because the user must
8228: submit personal information to apply for a password, or must pay
8229: for the source, or whatever, you can set
8230: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8231: displayed to the user before aborting the build. Example:</p>
8232: <pre class="programlisting">
8233: FETCH_MESSAGE= "Please download the files"
8234: FETCH_MESSAGE+= " "${DISTFILES:Q}
8235: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 8236: </pre>
1.1 dsieger 8237: </div>
1.41 asau 8238: <div class="sect2">
1.1 dsieger 8239: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8240: <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 8241: <p>Sometimes authors of a software package make some
8242: modifications after the software was released, and they put up a
8243: new distfile without changing the package's version number. If a
8244: package is already in pkgsrc at that time, the checksum will
8245: no longer match. The contents of the new distfile should be
8246: compared against the old one before changing anything, to make
8247: sure the distfile was really updated on purpose, and that
8248: no trojan horse or so crept in.
8249: Please mention that the distfiles were compared and what was found
1.53 rodent 8250: in your commit message.</p>
1.109 wiz 8251: <p>Then, the correct way to work around this is to set
8252: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8253: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8254: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8255: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 8256: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 8257: 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 8258: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 8259: including the <code class="filename">nbX</code> suffix) or a date stamp can
8260: be appended, like
8261: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 8262: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8263: name does not contain a version and the distfile is apt to change. In
8264: cases where the likelihood of this is very small,
8265: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8266: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8267: distfile name changes, even if a package is being moved or
8268: renamed.</p>
1.53 rodent 8269: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8270: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8271: path in the filenames.
1.53 rodent 8272: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8273: Furthermore, a mail to the package's authors seems appropriate
8274: telling them that changing distfiles after releases without
8275: changing the file names is not good practice.</p>
8276: </div>
1.88 tnn 8277: <div class="sect2">
8278: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8279: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 8280: <p>Helper methods exist for packages hosted on github.com which
8281: will often have distfile names that clash with other packages, for
8282: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8283: from below:</p>
1.88 tnn 8284: <div class="sect3">
8285: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8286: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 8287: <p>If your distfile URL looks similar to
1.189 bacon 8288: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169 rillig 8289: then you are packaging a tagged release.</p>
1.88 tnn 8290: <pre class="programlisting">
1.189 bacon 8291: DISTNAME= example-1.0
1.90 tnn 8292: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8293: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8294: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8295: EXTRACT_SUFX= .zip
8296: </pre>
1.230 gutterid 8297: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
8298: file fetching infrastructure to save the resulting file locally as
8299: <code class="literal">example-1.0.zip</code>.</p>
1.88 tnn 8300: </div>
8301: <div class="sect3">
8302: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8303: <a name="build.fetch.github.commit.prerelease"></a>21.2.3.2. Fetch based on a specific commit before the first release</h4></div></div></div>
8304: <p>If your distfile looks similar to
8305: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8306: release, then set the package version to 0.0.0.N, where N is the number
8307: of commits to the repository, and set GITHUB_TAG to the commit hash.
8308: This will (almost) ensure that the first tagged release will have a
8309: version greater than this one so that package upgrades will function
8310: properly.</p>
8311: <pre class="programlisting">
8312: DISTNAME= example-0.0.0.347
8313: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8314: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8315: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8316: </pre>
8317: </div>
8318: <div class="sect3">
8319: <div class="titlepage"><div><div><h4 class="title">
8320: <a name="build.fetch.github.commit.postrelease"></a>21.2.3.3. Fetch based on a specific commit after a release</h4></div></div></div>
8321: <p>If your distfile looks similar to
8322: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8323: then include the last release version and the commit count since that
8324: release in the package version and set GITHUB_TAG to the commit hash.
8325: The latest release and commit count are shown in the output of
8326: "git describe --tags":
8327: </p>
8328: <pre class="screen">
8329: # git clone https://github.com/username/example
8330: # cd example
8331: # git describe --tags
8332: 1.2.3-5-g988881a
8333: </pre>
1.88 tnn 8334: <pre class="programlisting">
1.189 bacon 8335: DISTNAME= example-1.2.3.5
8336: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8337: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8338: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 8339: </pre>
1.88 tnn 8340: </div>
8341: <div class="sect3">
8342: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8343: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169 rillig 8344: <p>If your distfile URL looks similar to
1.189 bacon 8345: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169 rillig 8346: then you are packaging a release.</p>
1.88 tnn 8347: <pre class="programlisting">
8348: DISTNAME= offensive-1.6
1.90 tnn 8349: PKGNAME= ${DISTNAME:S/offensive/proper/}
8350: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8351: GITHUB_PROJECT= example
1.90 tnn 8352: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8353: EXTRACT_SUFX= .zip
1.111 sevan 8354: </pre>
1.88 tnn 8355: </div>
8356: </div>
1.1 dsieger 8357: </div>
1.41 asau 8358: <div class="sect1">
1.1 dsieger 8359: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8360: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8361: <div class="sect2">
1.1 dsieger 8362: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8363: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8364: <p>pkgsrc supports many different machines, with different
8365: object formats like a.out and ELF, and varying abilities to do
8366: shared library and dynamic loading at all. To accompany this,
8367: varying commands and options have to be passed to the
8368: compiler, linker, etc. to get the Right Thing, which can be
8369: pretty annoying especially if you don't have all the machines
8370: at your hand to test things. The
1.207 leot 8371: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/index.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23 wiz 8372: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8373: both static and dynamic libraries from a set of source files,
8374: thus being platform-independent.</p>
8375: <p>Here's how to use libtool in a package in seven simple
8376: steps:</p>
1.23 wiz 8377: <div class="orderedlist"><ol class="orderedlist" type="1">
8378: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8379: Makefile.</p></li>
1.23 wiz 8380: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8381: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8382: add it to the definition of <code class="varname">CC</code>, if only
8383: libraries are being built in a given Makefile. This one command
8384: will build both PIC and non-PIC library objects, so you need not
8385: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8386: <li class="listitem">
1.1 dsieger 8387: <p>For the linking of the library, remove any
1.23 wiz 8388: <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
8389: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8390: <pre class="programlisting">
8391: ${LIBTOOL} --mode=link \
8392: ${CC} -o ${.TARGET:.a=.la} \
8393: ${OBJS:.o=.lo} \
8394: -rpath ${PREFIX}/lib \
8395: -version-info major:minor
1.111 sevan 8396: </pre>
1.1 dsieger 8397: <p>Note that the library is changed to have a
8398: <code class="filename">.la</code> extension, and the objects are
8399: changed to have a <code class="filename">.lo</code>
8400: extension. Change <code class="varname">OBJS</code> as
8401: necessary. This automatically creates all of the
8402: <code class="filename">.a</code>,
8403: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8404: necessary) in the build directory. Be sure to include
1.23 wiz 8405: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8406: minor are zero, as libtool will otherwise strip off the
8407: shared library version.</p>
8408: <p>From the libtool manual:</p>
8409: <pre class="programlisting">
8410: So, libtool library versions are described by three integers:
8411:
8412: CURRENT
8413: The most recent interface number that this library implements.
8414:
8415: REVISION
8416: The implementation number of the CURRENT interface.
8417:
8418: AGE
8419: The difference between the newest and oldest interfaces that
8420: this library implements. In other words, the library implements
8421: all the interface numbers in the range from number `CURRENT -
8422: AGE' to `CURRENT'.
8423:
8424: If two libraries have identical CURRENT and AGE numbers, then the
8425: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 8426: </pre>
1.23 wiz 8427: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8428: different results for a.out and ELF (excluding symlinks)
8429: in only one case. An ELF library of the form
1.23 wiz 8430: <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 8431: will have a symlink of
1.23 wiz 8432: <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 8433: on an a.out platform. This is handled
8434: automatically.</p>
1.23 wiz 8435: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8436: directory of the library being built.</p>
8437: <p>In the <code class="filename">PLIST</code>, include only the
8438: <code class="filename">.la</code> file, the other files will be
8439: added automatically.</p>
8440: </li>
1.23 wiz 8441: <li class="listitem">
1.1 dsieger 8442: <p>When linking shared object (<code class="filename">.so</code>)
1.207 leot 8443: files, i.e. files that are loaded via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 8444: shared libraries, use <span class="quote">“<span class="quote">-module
8445: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8446: tacked on.</p>
8447: <p>The <code class="filename">PLIST</code> file gets the
8448: <code class="filename">foo.so</code> entry.</p>
8449: </li>
1.23 wiz 8450: <li class="listitem">
1.1 dsieger 8451: <p>When linking programs that depend on these libraries
8452: <span class="emphasis"><em>before</em></span> they are installed, preface
1.207 leot 8453: the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ld.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8454: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8455: libraries (static or shared), but please be aware that
8456: libtool will not allow you to specify a relative path in
1.23 wiz 8457: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8458: expects you to change that argument to be the
8459: <code class="filename">.la</code> file. e.g.</p>
8460: <pre class="programlisting">
8461: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 8462: </pre>
1.1 dsieger 8463: <p>should be changed to:</p>
8464: <pre class="programlisting">
8465: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 8466: </pre>
1.1 dsieger 8467: <p>and it will do the right thing with the libraries.</p>
8468: </li>
1.23 wiz 8469: <li class="listitem">
1.207 leot 8470: <p>When installing libraries, preface the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8471: or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/cp.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8472: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8473: <code class="filename">.la</code>. e.g.</p>
8474: <pre class="programlisting">
1.22 jakllsch 8475: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 8476: </pre>
1.1 dsieger 8477: <p>This will install the static <code class="filename">.a</code>,
8478: shared library, any needed symlinks, and run
1.207 leot 8479: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 8480: </li>
1.23 wiz 8481: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8482: the <code class="filename">.la</code>
8483: file (this is a change from previous behaviour).</p></li>
8484: </ol></div>
8485: </div>
1.41 asau 8486: <div class="sect2">
1.1 dsieger 8487: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8488: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8489: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8490: package Makefile. This will override the package's own libtool
8491: in most cases. For older libtool using packages, libtool is
8492: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8493: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8494: configure; find work*/ -name libtool</strong></span>.</p>
8495: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8496: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8497: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8498: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8499: package's libtool script(s), set it as appropriate.</p>
8500: <p>If you do not need <code class="filename">*.a</code> static
8501: libraries built and installed, then use
8502: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8503: <p>If your package makes use of the platform-independent library
8504: for loading dynamic shared objects, that comes with libtool
8505: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8506: <p>Some packages use libtool incorrectly so that the package
8507: may not work or build in some circumstances. Some of the more
8508: common errors are:</p>
1.41 asau 8509: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8510: <li class="listitem">
1.1 dsieger 8511: <p>The inclusion of a shared object (-module) as a dependent library in an
8512: executable or library. This in itself isn't a problem if one of two things
8513: has been done:</p>
1.23 wiz 8514: <div class="orderedlist"><ol class="orderedlist" type="1">
8515: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8516: <code class="filename">libfoo.la</code>, not
8517: <code class="filename">foo.la</code></p></li>
1.23 wiz 8518: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8519: </ol></div>
8520: </li>
1.23 wiz 8521: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8522: The function lt_dlinit() should be called and the macro
8523: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8524: executables.</p></li>
8525: </ul></div>
8526: </div>
1.41 asau 8527: <div class="sect2">
1.1 dsieger 8528: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8529: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8530: <p>If a package needs GNU autoconf or automake to be executed
1.223 nia 8531: to regenerate the
8532: <code class="filename">configure</code>
8533: script and <code class="filename">Makefile.in</code> makefile
8534: templates from <code class="filename">configure.ac</code> and
8535: <code class="filename">Makefile.am</code>,
8536: then they should be executed in a pre-configure target:</p>
1.1 dsieger 8537: <pre class="programlisting">
1.223 nia 8538: USE_TOOLS+= autoconf automake autoreconf
8539: GNU_CONFIGURE= yes
1.1 dsieger 8540: ...
8541:
8542: pre-configure:
1.223 nia 8543: set -e; cd ${WRKSRC} && autoreconf -fi
1.1 dsieger 8544: ...
1.111 sevan 8545: </pre>
1.223 nia 8546: <p>Packages which use GNU Automake will sometimes
8547: require GNU Make (<code class="literal">gmake</code> in
8548: <code class="varname">USE_TOOLS</code>),
8549: but not always. Note that autoreconf
8550: only needs to be executed if <code class="filename">configure.ac</code>
8551: or Makefiles are modified, or <code class="filename">configure</code>
8552: is not present.</p>
1.1 dsieger 8553: <p>There are times when the configure process makes
8554: additional changes to the generated files, which then causes
8555: the build process to try to re-execute the automake sequence.
8556: This is prevented by touching various files in the configure
8557: stage. If this causes problems with your package you can set
8558: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8559: Makefile.</p>
8560: </div>
1.223 nia 8561: <div class="sect2">
8562: <div class="titlepage"><div><div><h3 class="title">
8563: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
8564: <p>Packages using Meson to configure need to include:
8565:
8566: </p>
8567: <pre class="programlisting">
8568: .include "../../devel/meson/build.mk"
8569: </pre>
8570: <p>In nearly all cases (any program with dependencies),
8571: pkg-config needs to be added to
8572: <code class="varname">USE_TOOLS</code>. If the package installs
8573: translation files for non-English languages, also
8574: add msgfmt and xgettext:
8575:
8576: </p>
8577: <pre class="programlisting">
8578: USE_TOOLS+= pkg-config msgfmt xgettext
8579: </pre>
8580: <p>If any options need to be passed to Meson, use
8581: <code class="varname">MESON_ARGS</code> instead of
8582: <code class="varname">CONFIGURE_ARGS</code>:
8583:
8584: </p>
8585: <pre class="programlisting">
8586: MESON_ARGS+= -Dx11=false
8587: </pre>
8588: </div>
1.1 dsieger 8589: </div>
1.41 asau 8590: <div class="sect1">
1.1 dsieger 8591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8592: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 8593: <div class="sect2">
1.1 dsieger 8594: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8595: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.244 gutterid 8596: <p>Compilers for the C and C++ languages come with
1.1 dsieger 8597: the NetBSD base system. By default, pkgsrc assumes that a package
8598: is written in C and will hide all other compilers (via the wrapper
1.184 rillig 8599: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.243 gutterid 8600: <p>To declare which languages should be made available through
8601: pkgsrc's compiler wrappers, use
1.1 dsieger 8602: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.212 wiz 8603: currently are:
1.238 wiz 8604: </p>
1.212 wiz 8605: <pre class="programlisting">
1.244 gutterid 8606: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.238 wiz 8607: </pre>
1.212 wiz 8608: <p>
8609: (and any combination). The default is
1.23 wiz 8610: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8611: written in C++, usually need a C compiler for the configure
1.244 gutterid 8612: phase.</p>
1.243 gutterid 8613: <p>To declare which features a package requies from the
8614: compiler, set either <code class="varname">USE_CC_FEATURES</code>
8615: or <code class="varname">USE_CXX_FEATURES</code>. Allowed values for
8616: <code class="varname">USE_CC_FEATURES</code> are currently:
8617: </p>
8618: <pre class="programlisting">
8619: c11, c99, has_include
8620: </pre>
8621: <p>
8622: Allowed values for <code class="varname">USE_CXX_FEATURES</code> are
8623: currently:
8624: </p>
8625: <pre class="programlisting">
8626: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
8627: charconv, parallelism_ts, unique_ptr, put_time,
8628: is_trivially_copy_constructible
8629: </pre>
8630: <p>
8631: </p>
1.244 gutterid 8632: <p>Language variants like <code class="literal">gnu99</code> and
8633: <code class="literal">c++11</code> can be specified in <code class="varname">FORCE_C_STD</code>
8634: and <code class="varname">FORCE_CXX_STD</code> if the package does not explicitly set
8635: <code class="literal">-std=...</code> when compiling (i.e. the package
8636: assumes the compiler defaults to C++11 or some other standard).
8637: This is a common bug in upstream build systems.</p>
8638: <p>Allowed values for <code class="varname">FORCE_C_STD</code> are
8639: currently:
8640: </p>
8641: <pre class="programlisting">
8642: c90, c99, c11, gnu90, gnu99, gnu11
8643: </pre>
8644: <p>
8645: </p>
8646: <p>Allowed values for <code class="varname">FORCE_CXX_STD</code> are
8647: currently:
8648: </p>
8649: <pre class="programlisting">
8650: c++03, c++11, c++14, c++17, c++20,
8651: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
8652: </pre>
8653: <p>
8654: </p>
1.1 dsieger 8655: </div>
1.41 asau 8656: <div class="sect2">
1.1 dsieger 8657: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8658: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 8659: <p>If a program is written in Java, use the Java framework in
8660: pkgsrc. The package must include
8661: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8662: provides the following variables:</p>
1.41 asau 8663: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8664: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8665: dependency on the JDK is added. If
1.23 wiz 8666: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8667: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8668: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8669: JDK.</p></li>
1.23 wiz 8670: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8671: a package needs a Java2 implementation. The supported values
1.23 wiz 8672: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8673: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8674: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8675: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8676: above. This variable is not set by default.</p></li>
1.24 wiz 8677: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8678: automatically set to the runtime location of the used Java
8679: implementation dependency. It may be used to set
8680: <code class="varname">JAVA_HOME</code> to a good value if the program
8681: needs this variable to be defined.
8682: </p></li>
1.1 dsieger 8683: </ul></div>
8684: </div>
1.41 asau 8685: <div class="sect2">
1.1 dsieger 8686: <div class="titlepage"><div><div><h3 class="title">
1.205 wiz 8687: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8688: <p>If a program is written in Go and has any dependencies on
8689: other Go modules, have the package include
8690: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8691: <div class="orderedlist"><ol class="orderedlist" type="1">
8692: <li class="listitem"><p>Generate a list of those dependencies with
8693: <span class="command"><strong>make clean && make patch && make show-go-modules >
8694: go-modules.mk</strong></span>.</p></li>
1.223 nia 8695: <li class="listitem"><p>Prepend
8696: <code class="literal">.include "go-modules.mk"</code> to any other
8697: <code class="literal">.include</code>s.</p></li>
8698: <li class="listitem"><p>Incorporate these modules in
8699: <code class="filename">distinfo</code> with <span class="command"><strong>make
8700: makesum</strong></span>.</p></li>
8701: </ol></div>
8702: </div>
8703: <div class="sect2">
8704: <div class="titlepage"><div><div><h3 class="title">
8705: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
8706: <p>If a program is written in Rust and uses Cargo to build,
8707: have the package include
8708: <code class="filename">../../lang/rust/cargo.mk</code>.</p>
8709: <div class="orderedlist"><ol class="orderedlist" type="1">
8710: <li class="listitem"><p>Generate a list of those dependencies with
8711: <span class="command"><strong>make CARGO_ARGS="build --release" build &&
8712: make print-cargo-depends > cargo-depends.mk</strong></span>.</p></li>
8713: <li class="listitem"><p>Prepend
8714: <code class="literal">.include "cargo-depends.mk"</code> to any other
8715: <code class="literal">.include</code>s.</p></li>
1.205 wiz 8716: <li class="listitem"><p>Incorporate these modules in
8717: <code class="filename">distinfo</code> with <span class="command"><strong>make
8718: makesum</strong></span>.</p></li>
8719: </ol></div>
8720: </div>
8721: <div class="sect2">
8722: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8723: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.203 nia 8724: <p>If your package contains interpreted Perl scripts, add
1.23 wiz 8725: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8726: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8727: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8728: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8729: that you want adjusted. Every occurrence of
8730: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.210 gutterid 8731: replaced with the full path to the Perl executable.</p>
8732: <p>If a particular version of Perl is needed, set the
1.1 dsieger 8733: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8734: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.203 nia 8735: <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.210 gutterid 8736: about handling Perl modules.</p>
8737: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8738: for the language now known as Raku.</p>
1.1 dsieger 8739: </div>
1.41 asau 8740: <div class="sect2">
1.1 dsieger 8741: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8742: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 8743: <p><code class="varname">REPLACE_SH</code>,
8744: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8745: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.225 gutterid 8746: she-bangs in files. Please use the appropriate one, preferring
8747: <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.74 wiz 8748: Each should contain a list of scripts, relative to
8749: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8750: occurrence of the matching shell in a she-bang line will be
8751: replaced with the full path to the shell executable.
1.40 wiz 8752: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8753: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8754: </div>
1.41 asau 8755: <div class="sect2">
1.40 wiz 8756: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8757: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.210 gutterid 8758: <p>There are further similar REPLACE variables available, e.g.,
8759: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8760: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.211 gutterid 8761: noted above, have their actions defined centrally in
1.210 gutterid 8762: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.211 gutterid 8763: languages define the actions of these variables within their own
8764: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
1.245 ! gutterid 8765: actioned in <code class="filename">lang/php/replace.mk</code>, and
1.211 gutterid 8766: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.210 gutterid 8767: <code class="filename">lang/python/application.mk</code>. For other languages,
8768: consult the mk files found within their specific directories (the
1.216 gutterid 8769: naming convention varies), or check the list found in
8770: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.210 gutterid 8771: <p>Currently, special handling for other languages varies
1.1 dsieger 8772: in pkgsrc. If a compiler package provides a
8773: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8774: just add a (build) dependency on the appropriate compiler
8775: package.</p>
8776: </div>
8777: </div>
1.41 asau 8778: <div class="sect1">
1.1 dsieger 8779: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8780: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8781: <p>The most common failures when building a package are that
8782: some platforms do not provide certain header files, functions or
8783: libraries, or they provide the functions in a library that the
8784: original package author didn't know. To work around this, you
8785: can rewrite the source code in most cases so that it does not
8786: use the missing functions or provides a replacement function.</p>
1.41 asau 8787: <div class="sect2">
1.1 dsieger 8788: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8789: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8790: <p>If a package already comes with a GNU configure script, the
8791: preferred way to fix the build failure is to change the
8792: configure script, not the code. In the other cases, you can
8793: utilize the C preprocessor, which defines certain macros
8794: depending on the operating system and hardware architecture it
8795: compiles for. These macros can be queried using for example
8796: <code class="varname">#if defined(__i386)</code>. Almost every operating
8797: system, hardware architecture and compiler has its own macro.
8798: For example, if the macros <code class="varname">__GNUC__</code>,
8799: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8800: are all defined, you know that you are using NetBSD on an i386
8801: compatible CPU, and your compiler is GCC.</p>
8802: <p>The list of the following macros for hardware and
8803: operating system depends on the compiler that is used. For
8804: example, if you want to conditionally compile code on Solaris,
8805: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8806: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8807: <div class="sect3">
1.1 dsieger 8808: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8809: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.223 nia 8810: <p>To distinguish between specific NetBSD versions,
8811: you should use the following code.</p>
8812: <pre class="programlisting">
8813: #ifdef __NetBSD__
8814: #include <sys/param.h>
8815: #if __NetBSD_Prereq__(9,99,17)
8816: /* use a newer feature */
8817: #else
8818: /* older code */
8819: #endif
8820: #endif
8821:
8822: #ifndef _WIN32
8823: /* Unix-like specific code */
8824: #endif
8825: </pre>
1.1 dsieger 8826: <p>To distinguish between 4.4 BSD-derived systems and the
8827: rest of the world, you should use the following code.</p>
8828: <pre class="programlisting">
8829: #include <sys/param.h>
8830: #if (defined(BSD) && BSD >= 199306)
8831: /* BSD-specific code goes here */
8832: #else
8833: /* non-BSD-specific code goes here */
8834: #endif
8835: </pre>
1.223 nia 8836: <p>You can also test for the following macros:</p>
1.1 dsieger 8837: <pre class="programlisting">
1.45 obache 8838: Cygwin __CYGWIN__
8839: DragonFly __DragonFly__
1.1 dsieger 8840: FreeBSD __FreeBSD__
1.45 obache 8841: Haiku __HAIKU__
1.1 dsieger 8842: Interix __INTERIX
8843: IRIX __sgi (TODO: get a definite source for this)
1.223 nia 8844: Linux __linux
1.83 dholland 8845: Mac OS X __APPLE__
1.45 obache 8846: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8847: Minix3 __minix
1.1 dsieger 8848: NetBSD __NetBSD__
8849: OpenBSD __OpenBSD__
8850: Solaris sun, __sun
8851: </pre>
8852: </div>
1.41 asau 8853: <div class="sect3">
1.1 dsieger 8854: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8855: <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 8856: <pre class="programlisting">
8857: i386 i386, __i386, __i386__
1.223 nia 8858: x86-64 __amd64__, __x86_64__
8859: ARM __arm__
1.1 dsieger 8860: MIPS __mips
8861: SPARC sparc, __sparc
1.223 nia 8862: PowerPC __powerpc
1.1 dsieger 8863: </pre>
8864: </div>
1.41 asau 8865: <div class="sect3">
1.1 dsieger 8866: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8867: <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 8868: <pre class="programlisting">
8869: GCC __GNUC__ (major version), __GNUC_MINOR__
8870: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8871: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8872: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8873: </pre>
8874: </div>
8875: </div>
1.41 asau 8876: <div class="sect2">
1.1 dsieger 8877: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8878: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8879: <p>Some source files trigger bugs in the compiler, based on
8880: combinations of compiler version and architecture and almost
8881: always relation to optimisation being enabled. Common symptoms
8882: are gcc internal errors or never finishing compiling a
8883: file.</p>
8884: <p>Typically, a workaround involves testing the
8885: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8886: optimisation for that combination of file,
1.87 tnn 8887: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8888: <p>This used to be a big problem in the past, but is rarely
8889: needed now as compiler technology has matured. If you still need
8890: to add a compiler specific workaround, please do so in the file
8891: <code class="filename">hacks.mk</code> and describe the symptom and
8892: compiler version as detailed as possible.</p>
1.1 dsieger 8893: </div>
1.41 asau 8894: <div class="sect2">
1.1 dsieger 8895: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8896: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8897: <p>Compilation sometimes fails with an error message like this:</p>
8898: <pre class="programlisting">
8899: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8900: fatal error: pango/pango.h: No such file or directory
8901: </pre>
8902: <p>The proper way to fix this problem depends on the type of the
8903: header, which is described in the following sections.</p>
8904: <div class="sect3">
8905: <div class="titlepage"><div><div><h4 class="title">
8906: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8907: <p>If the header name looks like it comes from a different package,
8908: that other package should be included via the buildlink3
8909: framework.</p>
8910: <p>First, look whether the header is somewhere in the buildlink3
8911: directory below <code class="varname">WRKDIR</code>. In the above case of
8912: the missing Pango header:</p>
8913: <pre class="programlisting">
8914: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8915: </pre>
8916: <p>In the case of Pango, the output is:</p>
8917: <pre class="programlisting">
8918: work/.buildlink/include/pango-1.0/pango/pango.h
8919: </pre>
8920: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8921: in the <code class="filename">.buildlink</code> directory, it would have been
8922: found automatically. There is an extra <code class="filename">pango-1.0</code>
8923: path component though, which means that the compiler command line must
8924: contain an option of the form
8925: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8926: most cases this option is generated by the configure script, which can be examined using:</p>
8927: <pre class="programlisting">
8928: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8929: -I/usr/pkg/include/pango-1.0
8930: -I/usr/pkg/include/pango-1.0
8931: -I/usr/pkg/include/pango-1.0
8932: -I/usr/pkg/include/pango-1.0
8933: -I/usr/pkg/include/pango-1.0
8934: </pre>
8935: <p>This looks good. These options are transformed by the buildlink
8936: wrapper to refer to the correct path inside
8937: <code class="filename">work/.buildlink</code>.</p>
8938: <p>Since the compilation fails though, examine the compiler command
8939: lines in <code class="filename">work/.work.log</code> to see whether the
8940: <code class="literal">-I</code> option is included in the particular command
8941: line.</p>
8942: <p>To further analyze the situation, run <span class="command"><strong>bmake
8943: build-env</strong></span>, which sets up an interactive, realistic environment
8944: including all the pkgsrc wrapper commands and environment variables. From
8945: there, try to compile some simple example programs that use the
8946: header.</p>
8947: </div>
8948: <div class="sect3">
8949: <div class="titlepage"><div><div><h4 class="title">
8950: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8951: <p>If the name of the header seems to come from the package itself,
8952: and if the build is run with parallel jobs, the package may have some
8953: undeclared dependencies between the <code class="filename">.c</code> and the
8954: <code class="filename">.h</code> files, and a C file is compiled before its
8955: required header is generated.</p>
8956: <p>To see whether the build runs with parallel jobs, run
8957: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8958: like this:</p>
8959: <pre class="programlisting">
8960: usr MAKE_JOBS= 7
8961: pkg MAKE_JOBS_SAFE # undefined
8962: def _MAKE_JOBS_N= 7
8963: </pre>
8964: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8965: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8966: package could have disabled parallel builds by setting
8967: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8968: in this case it hasn't.</p>
8969: <p>To see whether the build failure is caused by parallel builds,
8970: first save the exact error message and a bit of context, maybe you need
8971: it later for reporting a bug. Next, run:</p>
8972: <pre class="programlisting">
8973: MAKE_JOBS_SAFE=no bmake clean build
8974: </pre>
8975: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
8976: report</a> against the pkgsrc package, including the exact error
8977: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
8978: </div>
1.173 rillig 8979: <div class="sect3">
8980: <div class="titlepage"><div><div><h4 class="title">
8981: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
8982: <p>Pkgsrc does not work reliably if any of
8983: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
8984: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
8985: bootstrap program prevents installing pkgsrc in symlink-based
8986: directories. Existing pkgsrc installations are not checked for symlinks
8987: though.</p>
8988: <p>The "No such file or directory" error messages are a typical
8989: symptom of symlinks, and it's quite difficult to find out that this is
8990: the actual cause.</p>
8991: </div>
8992: <div class="sect3">
8993: <div class="titlepage"><div><div><h4 class="title">
8994: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
8995: <p>When building a hierarchy of packages, it may happen that one
8996: package is built and then pkgsrc is updated. This situation can provoke
8997: various hard to diagnose build errors. To clean up the situation:</p>
8998: <pre class="programlisting">
1.223 nia 8999: <code class="prompt">$</code> (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.173 rillig 9000: </pre>
1.223 nia 9001: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
9002: prevent running this command in the wrong directory.)</p>
1.173 rillig 9003: <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
9004: that directory as well.</p>
9005: </div>
9006: <div class="sect3">
9007: <div class="titlepage"><div><div><h4 class="title">
9008: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
9009: <p>On platforms other than BSD, third-party packages are installed in
9010: <code class="filename">/usr/include</code>, together with the base system. This
9011: means that pkgsrc cannot distinguish between headers provided by the base
9012: system (which it needs) and headers from third-party packages (which are
9013: often included in pkgsrc as well). This can lead to subtle version
9014: mismatches.</p>
9015: <p>In pkgsrc installations that have been active for several years, it
9016: may happen that some files are manually deleted. To exclude this unlikely
9017: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
9018: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
9019: check/fix dependencies.</p>
9020: <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>
9021: for contact information. Be prepared to describe what you have tried so
9022: far and what any error messages were.</p>
9023: </div>
1.172 rillig 9024: </div>
9025: <div class="sect2">
9026: <div class="titlepage"><div><div><h3 class="title">
9027: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 9028: </h3></div></div></div>
1.1 dsieger 9029: <p>This error message often means that a package did not
9030: link to a shared library it needs. The following functions are
9031: known to cause this error message over and over.</p>
9032: <div class="informaltable">
1.106 tnn 9033: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 9034: <colgroup>
9035: <col>
9036: <col>
9037: <col>
9038: </colgroup>
9039: <thead><tr>
9040: <th>Function</th>
9041: <th>Library</th>
9042: <th>Affected platforms</th>
9043: </tr></thead>
9044: <tbody>
9045: <tr>
9046: <td>accept, bind, connect</td>
9047: <td>-lsocket</td>
9048: <td>Solaris</td>
9049: </tr>
9050: <tr>
9051: <td>crypt</td>
9052: <td>-lcrypt</td>
9053: <td>DragonFly, NetBSD</td>
9054: </tr>
9055: <tr>
9056: <td>dlopen, dlsym</td>
9057: <td>-ldl</td>
9058: <td>Linux</td>
9059: </tr>
9060: <tr>
9061: <td>gethost*</td>
9062: <td>-lnsl</td>
9063: <td>Solaris</td>
9064: </tr>
9065: <tr>
9066: <td>inet_aton</td>
9067: <td>-lresolv</td>
9068: <td>Solaris</td>
9069: </tr>
9070: <tr>
9071: <td>nanosleep, sem_*, timer_*</td>
9072: <td>-lrt</td>
9073: <td>Solaris</td>
9074: </tr>
9075: <tr>
9076: <td>openpty</td>
9077: <td>-lutil</td>
9078: <td>Linux</td>
9079: </tr>
9080: </tbody>
9081: </table>
9082: </div>
1.223 nia 9083: <p>To fix these linker errors, it is often sufficient to add
1.1 dsieger 9084: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
9085: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.223 nia 9086: <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.1 dsieger 9087: bmake</strong></span>.</p>
1.41 asau 9088: <div class="sect3">
1.1 dsieger 9089: <div class="titlepage"><div><div><h4 class="title">
1.223 nia 9090: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.1 dsieger 9091: <p>When you are using the SunPro compiler, there is another
9092: possibility. That compiler cannot handle the following code:</p>
9093: <pre class="programlisting">
9094: extern int extern_func(int);
9095:
9096: static inline int
9097: inline_func(int x)
9098: {
9099: return extern_func(x);
9100: }
9101:
9102: int main(void)
9103: {
9104: return 0;
9105: }
9106: </pre>
9107: <p>It generates the code for <code class="function">inline_func</code> even if
9108: that function is never used. This code then refers to
9109: <code class="function">extern_func</code>, which can usually not be resolved. To
9110: solve this problem you can try to tell the package to disable inlining
9111: of functions.</p>
9112: </div>
1.228 gutterid 9113: <div class="sect3">
9114: <div class="titlepage"><div><div><h4 class="title">
9115: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
9116: <p>When building for older machine architectures (e.g., i386, PowerPC),
9117: builds may fail because the package expects modern 64-bit atomic functions
9118: which the underlying hardware either doesn't support, or will only support
9119: with specific compiler flags. This is generally handled via inclusion of
9120: mk/atomic64.mk.</p>
9121: </div>
1.1 dsieger 9122: </div>
1.41 asau 9123: <div class="sect2">
1.1 dsieger 9124: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 9125: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 9126: <p>Sometimes packages fail to build because the compiler runs
9127: into an operating system specific soft limit. With the
9128: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.223 nia 9129: to unlimit the resources. The allowed values are any combination of
9130: <span class="quote">“<span class="quote">cputime</span>”</span>,
9131: <span class="quote">“<span class="quote">datasize</span>”</span>,
9132: <span class="quote">“<span class="quote">memorysize</span>”</span>,
9133: <span class="quote">“<span class="quote">stacksize</span>”</span> and
9134: <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.1 dsieger 9135: Setting this variable is similar to running the shell builtin
1.10 hubertf 9136: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 9137: segment size or maximum stack size of a process, respectively, to
9138: their hard limits.</p>
9139: </div>
9140: </div>
1.41 asau 9141: <div class="sect1">
1.1 dsieger 9142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9143: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 9144: <div class="sect2">
1.1 dsieger 9145: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9146: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 9147: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 9148: with some operating systems cannot create more than one
9149: directory at a time. As such, you should call
9150: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9151: <pre class="programlisting">
9152: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9153: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 9154: </pre>
1.223 nia 9155: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
9156: directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
9157: dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
9158: variable, which will automatically do the right thing.</p>
1.1 dsieger 9159: </div>
1.41 asau 9160: <div class="sect2">
1.1 dsieger 9161: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9162: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 9163: <p>In general, documentation should be installed into
9164: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.223 nia 9165: <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.1 dsieger 9166: includes the version number of the package).</p>
9167: <p>Many modern packages using GNU autoconf allow to set the
9168: directory where HTML documentation is installed with the
1.223 nia 9169: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
9170: needed because otherwise the documentation ends up in
9171: <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
9172: pkgsrc, the HTML documentation should go into the package-specific
9173: directory, just like any other documentation.</p>
1.1 dsieger 9174: <p>An exception to the above is that library API documentation
1.207 leot 9175: generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/index.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.1 dsieger 9176: browsers (devhelp) should be left at their default location, which
9177: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9178: documentation can be recognized from files ending in
9179: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9180: (It is also acceptable to install such files in
9181: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9182: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9183: <code class="filename">.devhelp*</code> file must be directly in that
9184: directory then, no additional subdirectory level is allowed in
9185: this case. This is usually achieved by using
1.23 wiz 9186: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 9187: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9188: though.)</p>
9189: </div>
1.41 asau 9190: <div class="sect2">
1.1 dsieger 9191: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9192: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 9193: <p>Certain packages, most of them in the games category, install
9194: a score file that allows all users on the system to record their
9195: highscores. In order for this to work, the binaries need to be
9196: installed setgid and the score files owned by the appropriate
1.35 wiz 9197: group and/or owner (traditionally the "games" user/group). Set
9198: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 9199: following variables, documented in more detail in
9200: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 9201: behaviour: <code class="varname">GAMEDATAMODE</code>,
9202: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 9203: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9204: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9205: <code class="varname">GAMEDATA_PERMS</code> and
9206: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9207: <p>An example that illustrates some of the variables described above is
9208: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9209: used to properly set directory permissions of the directory where the
9210: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9211: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9212: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9213: binary:</p>
9214: <pre class="programlisting">
1.112 rillig 9215: USE_GAMESGROUP= yes
1.100 leot 9216:
1.112 rillig 9217: BUILD_DEFS+= VARBASE
1.100 leot 9218:
1.112 rillig 9219: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9220: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9221: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 9222: </pre>
1.100 leot 9223: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9224: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9225: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9226: needed to be accessed by setgid games and
9227: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 9228: <p>A package should therefore never hard code file ownership or
1.100 leot 9229: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9230: or alternatively on <code class="varname">INSTALL_GAME</code>,
9231: <code class="varname">INSTALL_GAME_DATA</code> and
9232: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 9233: </div>
1.41 asau 9234: <div class="sect2">
1.1 dsieger 9235: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9236: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 9237: <p><code class="varname">DESTDIR</code> support means that a package
9238: installs into a staging directory, not the final location of the
9239: files. Then a binary package is created which can be used for
9240: installation as usual. There are two ways: Either the package must
1.23 wiz 9241: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9242: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 9243: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9244: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 9245: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
9246: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 9247: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9248: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 9249: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9250: the inclusion.</p></li>
1.23 wiz 9251: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 9252: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 9253: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 9254: automatically. Many manual rules and pre/post-install often are
9255: incorrect; fix them.</p></li>
1.23 wiz 9256: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 9257: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 9258: <li class="listitem"><p>In general, packages should support
1.4 rillig 9259: <code class="varname">UNPRIVILEGED</code> to be able to use
9260: DESTDIR.</p></li>
9261: </ul></div>
9262: </div>
1.41 asau 9263: <div class="sect2">
1.4 rillig 9264: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9265: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 9266: <p>Your package may also contain scripts with hardcoded paths to
1.203 nia 9267: other interpreters besides (or as well as) Perl. To correct the
1.1 dsieger 9268: full pathname to the script interpreter, you need to set the
9269: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 9270: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 9271: <pre class="programlisting">
9272: REPLACE_INTERPRETER+= tcl
9273: REPLACE.tcl.old= .*/bin/tclsh
9274: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9275: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9276: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 9277: </pre>
1.1 dsieger 9278: </div>
1.41 asau 9279: <div class="sect2">
1.1 dsieger 9280: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9281: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.1 dsieger 9282: <p>Makefiles of packages providing perl5 modules should include
9283: the Makefile fragment
9284: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 9285: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 9286: configuration for such modules as well as various hooks to tune
9287: this configuration. See comments in this file for
9288: details.</p>
9289: <p>Perl5 modules will install into different places depending
9290: on the version of perl used during the build process. To
9291: address this, pkgsrc will append lines to the
9292: <code class="filename">PLIST</code> corresponding to the files listed in
9293: the installed <code class="filename">.packlist</code> file generated by
9294: most perl5 modules. This is invoked by defining
9295: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 9296: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9297: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9298: e.g.:</p>
1.1 dsieger 9299: <pre class="programlisting">
1.47 wiz 9300: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 9301: </pre>
1.47 wiz 9302: <p>The perl5 config variables
9303: <code class="varname">installarchlib</code>,
9304: <code class="varname">installscript</code>,
9305: <code class="varname">installvendorbin</code>,
9306: <code class="varname">installvendorscript</code>,
9307: <code class="varname">installvendorarch</code>,
9308: <code class="varname">installvendorlib</code>,
9309: <code class="varname">installvendorman1dir</code>, and
9310: <code class="varname">installvendorman3dir</code> represent those
9311: locations in which components of perl5 modules may be installed,
9312: provided as variable with uppercase and prefixed with
9313: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9314: and may be used by perl5 packages that don't have a packlist.
9315: These variables are also substituted for in the
9316: <code class="filename">PLIST</code> as uppercase prefixed with
9317: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 9318: </div>
1.41 asau 9319: <div class="sect2">
1.1 dsieger 9320: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9321: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 9322: <p>Some packages install info files or use the
1.23 wiz 9323: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 9324: commands. <code class="varname">INFO_FILES</code> should be defined in
9325: the package Makefile so that <code class="filename">INSTALL</code> and
9326: <code class="filename">DEINSTALL</code> scripts will be generated to
9327: handle registration of the info files in the Info directory
1.23 wiz 9328: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 9329: files registration is either provided by the system, or by a
9330: special purpose package automatically added as dependency if
9331: needed.</p>
9332: <p><code class="varname">PKGINFODIR</code> is the directory under
9333: <code class="filename">${PREFIX}</code> where info files are primarily
9334: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 9335: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 9336: <p>The info files for the package should be listed in the
9337: package <code class="filename">PLIST</code>; however any split info files
9338: need not be listed.</p>
1.23 wiz 9339: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9340: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 9341: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 9342: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 9343: should be noted with the <code class="varname">TEXINFO_REQD</code>
9344: variable in the package <code class="filename">Makefile</code>. By
9345: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 9346: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 9347: does not match the required minimum, a build dependency on the
1.207 leot 9348: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/index.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.1 dsieger 9349: be added automatically.</p>
9350: <p>The build and installation process of the software provided
9351: by the package should not use the
1.10 hubertf 9352: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 9353: info files is the task of the package
9354: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 9355: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 9356: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 9357: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9358: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 9359: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9360: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9361: no effect except the logging of a message. The script overriding
1.10 hubertf 9362: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9363: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9364: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9365: </div>
1.41 asau 9366: <div class="sect2">
1.1 dsieger 9367: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9368: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9369: <p>All packages that install manual pages should install them
9370: into the same directory, so that there is one common place to look
9371: for them. In pkgsrc, this place is
9372: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9373: should be used in packages. The default for
9374: <code class="varname">PKGMANDIR</code> is
1.23 wiz 9375: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9376: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9377: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9378: <h3 class="title">Note</h3>
9379: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9380: is far from complete.</p>
9381: </div>
9382: <p>The <code class="filename">PLIST</code> files can just use
9383: <code class="filename">man/</code> as the top level directory for the man
9384: page file entries, and the pkgsrc framework will convert as
9385: needed. In all other places, the correct
9386: <code class="varname">PKGMANDIR</code> must be used.</p>
9387: <p>Packages that are
9388: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 9389: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9390: <code class="filename">./configure</code>
9391: --mandir switch to set where the man pages should be installed.
9392: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9393: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9394: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9395: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 9396: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9397: Or if the <code class="filename">./configure</code> script uses
9398: a non-standard use of --mandir, you can set
9399: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.184 rillig 9400: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, “Man page compression”</a> for
1.1 dsieger 9401: information on installation of compressed manual pages.</p>
9402: </div>
1.41 asau 9403: <div class="sect2">
1.1 dsieger 9404: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9405: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9406: <p>If a package installs font files, you will need to rebuild
9407: the fonts database in the directory where they get installed at
9408: installation and deinstallation time. This can be automatically
9409: done by using the pkginstall framework.</p>
9410: <p>You can list the directories where fonts are installed in the
9411: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9412: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9413: <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 9414: Also make sure that the database file
9415: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9416: <p>Note that you should not create new directories for fonts;
9417: instead use the standard ones to avoid that the user needs to
9418: manually configure his X server to find them.</p>
9419: </div>
1.41 asau 9420: <div class="sect2">
1.1 dsieger 9421: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9422: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9423: <p>If a package installs SGML or XML data files that need to be
9424: registered in system-wide catalogs (like DTDs, sub-catalogs,
9425: etc.), you need to take some extra steps:</p>
1.23 wiz 9426: <div class="orderedlist"><ol class="orderedlist" type="1">
9427: <li class="listitem"><p>Include
1.1 dsieger 9428: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9429: your <code class="filename">Makefile</code>, which takes care of
9430: registering those files in system-wide catalogs at
9431: installation and deinstallation time.</p></li>
1.23 wiz 9432: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9433: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9434: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9435: any XML catalogs installed by the package.</p></li>
1.23 wiz 9436: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9437: to be added to the SGML catalog. These come in groups of
9438: three strings; see xmlcatmgr(1) for more information
9439: (specifically, arguments recognized by the 'add' action).
9440: Note that you will normally not use this variable.</p></li>
1.23 wiz 9441: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9442: to be added to the XML catalog. These come in groups of three
9443: strings; see xmlcatmgr(1) for more information (specifically,
9444: arguments recognized by the 'add' action). Note that you will
9445: normally not use this variable.</p></li>
9446: </ol></div>
9447: </div>
1.41 asau 9448: <div class="sect2">
1.1 dsieger 9449: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9450: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9451: <p>If a package provides extensions to the MIME database by
9452: installing <code class="filename">.xml</code> files inside
9453: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9454: need to take some extra steps to ensure that the database is kept
9455: consistent with respect to these new files:</p>
1.23 wiz 9456: <div class="orderedlist"><ol class="orderedlist" type="1">
9457: <li class="listitem"><p>Include
1.1 dsieger 9458: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9459: (avoid using the <code class="filename">buildlink3.mk</code> file from
9460: this same directory, which is reserved for inclusion from
9461: other <code class="filename">buildlink3.mk</code> files). It takes
9462: care of rebuilding the MIME database at installation and
9463: deinstallation time, and disallows any access to it directly
9464: from the package.</p></li>
1.23 wiz 9465: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9466: <code class="filename">share/mime</code> directory,
9467: <span class="emphasis"><em>except</em></span> for files saved under
9468: <code class="filename">share/mime/packages</code>. The former are
9469: handled automatically by
9470: the update-mime-database program, but the latter are
9471: package-dependent and must be removed by the package that
9472: installed them in the first place.</p></li>
1.23 wiz 9473: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9474: from the PLIST. They will be handled by the shared-mime-info
9475: package.</p></li>
9476: </ol></div>
9477: </div>
1.41 asau 9478: <div class="sect2">
1.1 dsieger 9479: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9480: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.1 dsieger 9481: <p>If a package uses intltool during its build, add
9482: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9483: which forces it to use the intltool package provided by pkgsrc,
9484: instead of the one bundled with the distribution file.</p>
9485: <p>This tracks intltool's build-time dependencies and uses the
9486: latest available version; this way, the package benefits of any
9487: bug fixes that may have appeared since it was released.</p>
9488: </div>
1.41 asau 9489: <div class="sect2">
1.1 dsieger 9490: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9491: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9492: <p>If a package contains a rc.d script, it won't be copied into
9493: the startup directory by default, but you can enable it, by adding
9494: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9495: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9496: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9497: it will automatically remove the scripts when the package is
9498: deinstalled.</p>
9499: </div>
1.41 asau 9500: <div class="sect2">
1.1 dsieger 9501: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9502: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9503: <p>If a package installs TeX packages into the texmf tree,
9504: the <code class="filename">ls-R</code> database of the tree needs to be
9505: updated.</p>
1.41 asau 9506: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9507: <h3 class="title">Note</h3>
1.22 jakllsch 9508: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9509: packages should install files
1.22 jakllsch 9510: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9511: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9512: </div>
1.23 wiz 9513: <div class="orderedlist"><ol class="orderedlist" type="1">
9514: <li class="listitem"><p>Include
1.22 jakllsch 9515: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9516: takes care of rebuilding the <code class="filename">ls-R</code>
9517: database at installation and deinstallation time.</p></li>
1.23 wiz 9518: <li class="listitem">
1.1 dsieger 9519: <p>If your package installs files into a texmf
9520: tree other than the one
1.22 jakllsch 9521: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9522: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9523: trees that need database update.</p>
9524: <p>If your package also installs font map files that need
1.10 hubertf 9525: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9526: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9527: set <code class="varname">TEX_MAP_FILES</code> and/or
9528: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9529: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9530: be run automatically at installation/deinstallation to
9531: enable/disable font map files for TeX output
9532: drivers.</p>
9533: </li>
1.23 wiz 9534: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9535: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9536: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9537: </ol></div>
9538: </div>
1.41 asau 9539: <div class="sect2">
1.1 dsieger 9540: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9541: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.1 dsieger 9542: emulation</h3></div></div></div>
9543: <p>There are some packages that provide libraries and
9544: executables for running binaries from a one operating system
9545: on a different one (if the latter supports it). One example
9546: is running Linux binaries on NetBSD.</p>
1.207 leot 9547: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/index.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.1 dsieger 9548: helps in extracting and packaging Linux rpm packages.</p>
9549: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9550: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9551: if all libraries for each installed executable can be found by
9552: the dynamic linker. Since the standard dynamic linker is run,
9553: this fails for emulation packages, because the libraries used
9554: by the emulation are not in the standard directories.</p>
9555: </div>
1.184 rillig 9556: <div class="sect2">
9557: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9558: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.184 rillig 9559: <p>If a package installs images under the
9560: <code class="filename">share/icons/hicolor</code> and/or updates the
9561: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9562: database, you need to take some extra steps to make sure that the
9563: shared theme directory is handled appropriately and that the cache
9564: database is rebuilt:</p>
9565: <div class="orderedlist"><ol class="orderedlist" type="1">
9566: <li class="listitem"><p>Include
9567: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9568: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9569: entry that refers to the theme cache.</p></li>
9570: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9571: directories from the <code class="filename">share/icons/hicolor</code>
9572: hierarchy because they will be handled automatically.</p></li>
9573: </ol></div>
9574: <p>The best way to verify that the PLIST is correct with
9575: respect to the last two points is to regenerate it using
9576: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9577: </div>
9578: <div class="sect2">
9579: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9580: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.184 rillig 9581: <p>If a package installs <code class="filename">.desktop</code> files
9582: under <code class="filename">share/applications</code> and these include
9583: MIME information (MimeType key), you need to take extra steps to
9584: ensure that they are registered into the MIME database:</p>
9585: <div class="orderedlist"><ol class="orderedlist" type="1">
9586: <li class="listitem"><p>Include
9587: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9588: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9589: <code class="filename">share/applications/mimeinfo.cache</code> file.
9590: It will be handled automatically.</p></li>
9591: </ol></div>
9592: <p>The best way to verify that the PLIST is correct with
9593: respect to the last point is to regenerate it using <span class="command"><strong>make
9594: print-PLIST</strong></span>.</p>
9595: </div>
9596: </div>
9597: <div class="sect1">
9598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9599: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9600: <p>In some cases one does not have the time to solve a problem
9601: immediately. In this case, one can plainly mark a package as broken. For
9602: this, one just sets the variable <code class="varname">BROKEN</code> to the
9603: reason why the package is broken (similar to the
9604: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9605: the package will immediately be shown this message, and the build
9606: will not be even tried.</p>
9607: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9608: intervals.</p>
9609: </div>
9610: </div>
9611: <div class="chapter">
9612: <div class="titlepage"><div><div><h2 class="title">
9613: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9614: <div class="toc">
9615: <p><b>Table of Contents</b></p>
9616: <dl class="toc">
9617: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9618: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9619: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9620: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9621: </dl>
9622: </div>
9623: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9624: site</a>:</p>
9625: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9626: environment, an intuitive and attractive desktop for users, and the
9627: GNOME development platform, an extensive framework for building
9628: applications that integrate into the rest of the desktop.</p></blockquote></div>
9629: <p>pkgsrc provides a seamless way to automatically build and install
9630: a complete GNOME environment <span class="emphasis"><em>under many different
9631: platforms</em></span>. We can say with confidence that pkgsrc is one of
9632: the most advanced build and packaging systems for GNOME due to its
9633: included technologies buildlink3, the wrappers and tools framework and
9634: automatic configuration file management. Lots of efforts are put into
9635: achieving a completely clean deinstallation of installed software
9636: components.</p>
9637: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9638: the above also means that great efforts are put into making GNOME work
1.201 cirnatda 9639: under this operating system.</p>
1.184 rillig 9640: <p>This chapter is aimed at pkgsrc developers and other people
9641: interested in helping our GNOME porting and packaging efforts. It
9642: provides instructions on how to manage the existing packages and some
9643: important information regarding their internals.</p>
9644: <div class="sect1">
9645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9646: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9647: <p>pkgsrc includes three GNOME-related meta packages:</p>
9648: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 9649: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/index.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.184 rillig 9650: the core GNOME desktop environment. It only includes the necessary
9651: bits to get it to boot correctly, although it may lack important
9652: functionality for daily operation. The idea behind this package is
9653: to let end users build their own configurations on top of this one,
9654: first installing this meta package to achieve a functional setup and
9655: then adding individual applications.</p></li>
1.207 leot 9656: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/index.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.184 rillig 9657: complete installation of the GNOME platform and desktop as defined
9658: by the GNOME project; this is based on the components distributed in
9659: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9660: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9661: official FTP server. Developer-only tools found in those
9662: directories are not installed unless required by some other
9663: component to work properly. Similarly, packages from the bindings
9664: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9665: in unless required as a dependency for an end-user component. This
1.207 leot 9666: package "extends" <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/index.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
9667: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.184 rillig 9668: Installs all the tools required to build a GNOME component when
9669: fetched from the CVS repository. These are required to let the
9670: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9671: </ul></div>
9672: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9673: sorted in a way that eases updates: a package may depend on other
9674: packages listed before it but not on any listed after it. It is very
9675: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9676: change it to alphabetical sorting!</em></span></p>
9677: </div>
9678: <div class="sect1">
9679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9680: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9681: <p>Almost all GNOME applications are written in C and use a common
9682: set of tools as their build system. Things get different with the new
9683: bindings to other languages (such as Python), but the following will
9684: give you a general idea on the minimum required tools:</p>
9685: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9686: <li class="listitem">
9687: <p>Almost all GNOME applications use the GNU Autotools as their
9688: build system. As a general rule you will need to tell this to your
9689: package:</p>
9690: <pre class="programlisting">
1.223 nia 9691: GNU_CONFIGURE= yes
9692: USE_LIBTOOL= yes
9693: USE_TOOLS+= gmake
1.184 rillig 9694: </pre>
9695: </li>
9696: <li class="listitem">
9697: <p>If the package uses pkg-config to detect dependencies, add this
9698: tool to the list of required utilities:</p>
9699: <pre class="programlisting">
1.223 nia 9700: USE_TOOLS+= pkg-config
1.184 rillig 9701: </pre>
1.207 leot 9702: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/index.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.184 rillig 9703: the end of the build process to ensure that you did not miss to
9704: specify any dependency in your package and that the version
9705: requirements are all correct.</p>
9706: </li>
9707: <li class="listitem"><p>If the package uses intltool, be sure to add
9708: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9709: to handle dependencies and to force the package to use the latest
9710: available version.</p></li>
9711: <li class="listitem">
9712: <p>If the package uses gtk-doc (a documentation generation
9713: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9714: tool is rather big and the distfile should come with pregenerated
9715: documentation anyway; if it does not, it is a bug that you ought to
9716: report. For such packages you should disable gtk-doc (unless it is
9717: the default):</p>
9718: <pre class="programlisting">
1.223 nia 9719: CONFIGURE_ARGS+= --disable-gtk-doc
1.184 rillig 9720: </pre>
9721: <p>The default location of installed HTML files
9722: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9723: and should not be changed unless the package insists on installing
9724: them somewhere else. Otherwise programs as
9725: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9726: do that with an entry similar to:</p>
9727: <pre class="programlisting">
1.223 nia 9728: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.184 rillig 9729: </pre>
9730: </li>
9731: </ul></div>
9732: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9733: files under the installation prefix to maintain databases. In this
9734: context, shared means that those exact same directories and files are
9735: used among several different packages, leading to conflicts in the
9736: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9737: handle the most common cases, so you have to forget about using
9738: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9739: omitting shared files from them. If you find yourself doing those,
9740: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9741: <p>The following table lists the common situations that result in
9742: using shared directories or files. For each of them, the appropriate
9743: solution is given. After applying the solution be sure to
9744: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9745: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9746: <div class="table">
9747: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9748: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9749: <colgroup>
9750: <col>
9751: <col>
9752: </colgroup>
9753: <thead><tr>
9754: <th>If the package...</th>
9755: <th>Then...</th>
9756: </tr></thead>
9757: <tbody>
9758: <tr>
9759: <td>Installs icons under the
9760: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9761: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.203 nia 9762: <td>See <a class="xref" href="#hicolor-theme" title="21.6.16. Packages installing hicolor icons">Section 21.6.16, “Packages installing hicolor icons”</a>.</td>
1.184 rillig 9763: </tr>
9764: <tr>
9765: <td>Installs files under
9766: <code class="filename">share/mime/packages</code>.</td>
1.203 nia 9767: <td>See <a class="xref" href="#mime-database" title="21.6.11. Packages installing extensions to the MIME database">Section 21.6.11, “Packages installing extensions to the MIME database”</a>.</td>
1.184 rillig 9768: </tr>
9769: <tr>
9770: <td>Installs <code class="filename">.desktop</code> files under
9771: <code class="filename">share/applications</code> and these include MIME
9772: information.</td>
1.203 nia 9773: <td>See <a class="xref" href="#desktop-files" title="21.6.17. Packages installing desktop files">Section 21.6.17, “Packages installing desktop files”</a>.</td>
1.184 rillig 9774: </tr>
9775: </tbody>
9776: </table></div>
1.1 dsieger 9777: </div>
1.184 rillig 9778: <br class="table-break">
1.1 dsieger 9779: </div>
1.41 asau 9780: <div class="sect1">
1.1 dsieger 9781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 9782: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9783: <p>When seeing GNOME as a whole, there are two kinds of
9784: updates:</p>
9785: <div class="variablelist"><dl class="variablelist">
9786: <dt><span class="term">Major update</span></dt>
9787: <dd>
9788: <p>Given that there is still a very long way for GNOME 3 (if it
9789: ever appears), we consider a major update one that goes from a
9790: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9791: where <code class="literal">Y</code> is even and greater than
9792: <code class="literal">X</code>. These are hard to achieve because they
9793: introduce lots of changes in the components' code and almost all
9794: GNOME distfiles are updated to newer versions. Some of them can
9795: even break API and ABI compatibility with the previous major
9796: version series. As a result, the update needs to be done all at
9797: once to minimize breakage.</p>
9798: <p>A major update typically consists of around 80 package
9799: updates and the addition of some new ones.</p>
9800: </dd>
9801: <dt><span class="term">Minor update</span></dt>
9802: <dd>
9803: <p>We consider a minor update one that goes from a
9804: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9805: one where <code class="literal">Y</code> is greater than
9806: <code class="literal">X</code>. These are easy to achieve because they do
9807: not update all GNOME components, can be done in an incremental way
9808: and do not break API nor ABI compatibility.</p>
9809: <p>A minor update typically consists of around 50 package
9810: updates, although the numbers here may vary a lot.</p>
9811: </dd>
9812: </dl></div>
9813: <p>In order to update the GNOME components in pkgsrc to a new stable
9814: release (either major or minor), the following steps should be
9815: followed:</p>
9816: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23 wiz 9817: <li class="listitem">
1.184 rillig 9818: <p>Get a list of all the tarballs that form the new release by
9819: using the following commands. These will leave the full list of the
9820: components' distfiles into the <code class="filename">list.txt</code>
9821: file:</p>
9822: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9823: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9824: awk '{ print $9 }' >list.txt</code></strong>
9825: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9826: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9827: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.1 dsieger 9828: </li>
1.184 rillig 9829: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9830: bump their version to the release you are updating them to. The
9831: three meta packages should be always consistent with versioning.
9832: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9833: in them.</p></li>
1.23 wiz 9834: <li class="listitem">
1.184 rillig 9835: <p>For each meta package, update all its
9836: <code class="varname">DEPENDS</code> lines to match the latest versions as
9837: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9838: newer version (even if found in the FTP) because the meta packages
9839: are supposed to list the exact versions that form a specific GNOME
9840: release. Exceptions are permitted here if a newer version solves a
9841: serious issue in the overall desktop experience; these typically
9842: come in the form of a revision bump in pkgsrc, not in newer versions
9843: from the developers.</p>
9844: <p>Packages not listed in the <code class="filename">list.txt</code> file
9845: should be updated to the latest version available (if found in
9846: pkgsrc). This is the case, for example, of the dependencies on the
1.207 leot 9847: GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/index.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.1 dsieger 9848: </li>
1.23 wiz 9849: <li class="listitem">
1.184 rillig 9850: <p>Generate a patch from the modified meta packages and extract the
9851: list of "new" lines. This will provide you an outline on what
9852: packages need to be updated in pkgsrc and in what order:</p>
9853: <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>
1.1 dsieger 9854: </li>
1.184 rillig 9855: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9856: installed packages and start over from scratch at this point.</p></li>
9857: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9858: of <code class="filename">todo.txt</code> and update the packages listed in
9859: it in order. For major desktop updates none of these should be
9860: committed until the entire set is completed because there are chances
9861: of breaking not-yet-updated packages.</p></li>
9862: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9863: the tree one by one with appropriate log messages. At the end,
9864: commit the three meta package updates and all the corresponding
9865: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9866: <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>
9867: </ol></div>
9868: </div>
9869: <div class="sect1">
9870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9871: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9872: <p>GNOME is a very big component in pkgsrc which approaches 100
9873: packages. Please, it is very important that you always, always,
9874: <span class="strong"><strong>always</strong></span> feed back any portability
9875: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="12.3.5. Feedback to the author">Section 12.3.5, “Feedback to the author”</a>). This is the only way to get
9876: their attention on portability issues and to ensure that future versions
9877: can be built out-of-the box on NetBSD. The less custom patches in
9878: pkgsrc, the easier further updates are. Those developers in charge of
9879: issuing major GNOME updates will be grateful if you do that.</p>
1.200 cirnatda 9880: <p>The most common places to report bugs are the <a class="ulink" href="https://gitlab.gnome.org/GNOME" target="_top">GNOME's GitLab</a> and the <a class="ulink" href="https://gitlab.freedesktop.org/explore/groups" target="_top">freedesktop.org's
9881: GitLab</a>. Not all components use these to track bugs, but most
1.184 rillig 9882: of them do. Do not be short on your reports: always provide detailed
9883: explanations of the current failure, how it can be improved to achieve
1.200 cirnatda 9884: maximum portability and, if at all possible, provide a patch against the
9885: main Git branch. The more verbose you are, the higher chances of your
9886: patch being accepted.</p>
1.184 rillig 9887: <p>Also, please avoid using preprocessor magic to fix portability
9888: issues. While the FreeBSD GNOME people are doing a great job in porting
9889: GNOME to their operating system, the official GNOME sources are now
9890: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9891: and similar macros. This hurts portability. Please see our patching
9892: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9893: details.</p>
9894: </div>
1.1 dsieger 9895: </div>
1.41 asau 9896: <div class="chapter">
1.1 dsieger 9897: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9898: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9899: <div class="toc">
9900: <p><b>Table of Contents</b></p>
1.100 leot 9901: <dl class="toc">
1.154 rillig 9902: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9903: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9904: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9905: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9906: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9907: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9908: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9909: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9910: </dl>
9911: </div>
1.41 asau 9912: <div class="sect1">
1.1 dsieger 9913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9914: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9915: <p>Our policy is that we accept binaries only from pkgsrc
9916: developers to guarantee that the packages don't contain any
9917: trojan horses etc. This is not to annoy anyone but rather to
9918: protect our users! You're still free to put up your home-made
9919: binary packages and tell the world where to get them. NetBSD
9920: developers doing bulk builds and wanting to upload them please
1.154 rillig 9921: 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 9922: builds)</i></a>.</p>
1.1 dsieger 9923: </div>
1.41 asau 9924: <div class="sect1">
1.1 dsieger 9925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9926: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.218 nia 9927: <p>Firstly, you can import new packages into
9928: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
9929: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
9930: for details.</p>
9931: <p>Next, check that your package is complete, compiles and
1.184 rillig 9932: runs well; see <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> and the rest of this
1.218 nia 9933: document. Run the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
9934: tool and fix any errors that appear.</p>
9935: <p>Finally, send a report to the pkgsrc bug tracking system,
1.207 leot 9936: either with the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 9937: that, go to the web page
1.174 leot 9938: <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 9939: which contains some instructions and a link to a form where you
9940: can submit packages. The
1.207 leot 9941: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/index.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.21 snj 9942: also available as a substitute for either of the above two tools.
9943: </p>
1.1 dsieger 9944: <p>In the form of the problem report, the category should be
1.23 wiz 9945: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9946: and version number, and the description field should contain a
9947: short description of your package (contents of the COMMENT
1.218 nia 9948: variable or DESCR file are OK).</p>
1.1 dsieger 9949: </div>
1.41 asau 9950: <div class="sect1">
1.1 dsieger 9951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9952: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9953: <p>Please note all package additions, updates, moves, and
9954: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9955: important to keep this file up to date and conforming to the
9956: existing format, because it will be used by scripts to
1.174 leot 9957: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9958: sites. Additionally, check the
9959: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9960: for the package you updated or removed, in case it was mentioned
9961: there.</p>
9962: <p>When the <code class="varname">PKGREVISION</code> of a package is
9963: bumped, the change should appear in
9964: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9965: related or otherwise relevant. Mass bumps that result from a
9966: dependency being updated should not be mentioned. In all other
9967: cases it's the developer's decision.</p>
9968: <p>There is a make target that helps in creating proper
1.10 hubertf 9969: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9970: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9971: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9972: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9973: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9974: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9975: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9976: For new packages, or package moves or removals, set the
9977: <code class="varname">CTYPE</code> variable on the command line to "Added",
9978: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9979: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9980: not the same as your NetBSD login name. The target also automatically
9981: removes possibly existing entries for the package in the
9982: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 9983: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 9984: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9985: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9986: makes the cvs commands use the main repository.
9987: </p>
1.1 dsieger 9988: </div>
1.41 asau 9989: <div class="sect1">
1.1 dsieger 9990: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9991: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 9992: <p>For several years, there have been mirrors of pkgsrc in
9993: fossil, git, and hg. Standard practise when using these tools is to
9994: make the first line of a commit message function as a summary that
9995: can be read without the rest, such as is commonly done with "git log
9996: --oneline". For this reason, we have the following guidelines for
9997: pkgsrc commit messages:</p>
9998: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9999: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 10000: big picture in 65 characters or less. When a commit is for one
1.130 wiz 10001: package, include the name of the package. For updates, include the
10002: version to which it is updated.</p></li>
10003: <li class="listitem"><p>Leave the next line empty.</p></li>
10004: <li class="listitem"><p>Then come the details for the commit (changes in that
10005: package, reason for a change) and any relevant PRs. Wrap this
10006: section.</p></li>
10007: </ul></div>
10008: <p>Here is an example:
1.238 wiz 10009: </p>
1.130 wiz 10010: <pre class="programlisting">
1.238 wiz 10011: libxslt: update to 1.0.30
1.130 wiz 10012:
1.238 wiz 10013: Changes since 1.0.29:
10014: ...
10015: </pre>
1.130 wiz 10016: <p>
10017: </p>
10018: <p>Here is another example:
1.238 wiz 10019: </p>
1.130 wiz 10020: <pre class="programlisting">
1.238 wiz 10021: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.130 wiz 10022:
1.238 wiz 10023: (rationale)
10024: </pre>
1.130 wiz 10025: <p>
10026: </p>
10027: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
10028: allowed on the pkgsrc repository to change commit messages.</p>
10029: </div>
10030: <div class="sect1">
10031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10032: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 10033: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 10034: access to the pkgsrc repository.</p>
10035: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
10036: Start by adding the directory and then files in the directory. Don't
10037: forget to add the new package to the category's
10038: <code class="filename">Makefile</code>. Make sure you don't forget any files;
10039: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
10040: <pre class="programlisting">
10041: <code class="prompt">$</code> cd .../pkgsrc/category
10042: <code class="prompt">$</code> cvs add pkgname
10043: <code class="prompt">$</code> cd pkgname
10044: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
10045: <code class="prompt">$</code> cvs add patches/p*
10046: <code class="prompt">$</code> cvs status | less
1.34 wiz 10047: <code class="prompt">$</code> cvs commit
1.33 wiz 10048: <code class="prompt">$</code> cd ..
1.236 gutterid 10049: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.34 wiz 10050: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 10051: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 10052: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 10053: </pre>
1.1 dsieger 10054: <p>The commit message of the initial import should include part of the
10055: <code class="filename">DESCR</code> file, so people reading the mailing lists know
10056: what the package is/does.</p>
1.33 wiz 10057: <p>Also mention the new package in
10058: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
10059: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
10060: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 10061: </div>
1.41 asau 10062: <div class="sect1">
1.1 dsieger 10063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10064: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 10065: <p>Please always put a concise, appropriate and relevant summary of the
10066: changes between old and new versions into the commit log when updating
10067: a package. There are various reasons for this:</p>
1.41 asau 10068: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10069: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 10070: or its information may be overwritten by newer information.</p></li>
1.23 wiz 10071: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10072: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 10073: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10074: repository is very useful for people who read the pkgsrc-changes mailing
10075: list, so that they can make tactical decisions about when to upgrade
10076: the package.</p></li>
10077: </ul></div>
10078: <p>Please also recognize that, just because a new version of a package
10079: has been released, it should not automatically be upgraded in the CVS
10080: repository. We prefer to be conservative in the packages that are
10081: included in pkgsrc - development or beta packages are not really the
10082: best thing for most places in which pkgsrc is used. Please use your
10083: judgement about what should go into pkgsrc, and bear in mind that
10084: stability is to be preferred above new and possibly untested features.</p>
10085: </div>
1.41 asau 10086: <div class="sect1">
1.1 dsieger 10087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10088: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 10089: <p>Renaming packages is not recommended.</p>
1.175 gutterid 10090: <p>When renaming packages, be sure to fix any references to the old name
1.20 snj 10091: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 10092: <p>
1.175 gutterid 10093: Also, when renaming a package, please add
1.167 leot 10094: the package name and version pattern(s) of the previous package
10095: to <code class="varname">SUPERSEDES</code>.
1.20 snj 10096: This may be repeated for multiple renames.
10097: The new package would be an exact replacement.
1.167 leot 10098: Example:
1.20 snj 10099: </p>
1.167 leot 10100: <pre class="programlisting">
10101: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
10102: SUPERSEDES+= optcomp-[0-9]*
10103: </pre>
1.23 wiz 10104: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 10105: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
10106: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
10107: not be an exact replacement but is a suggestion for the replaced
10108: functionality.</p>
10109: </div>
1.41 asau 10110: <div class="sect1">
1.20 snj 10111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10112: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 10113: <p>It is preferred that packages are not renamed or moved, but if needed
10114: please follow these steps.
10115: </p>
1.23 wiz 10116: <div class="orderedlist"><ol class="orderedlist" type="1">
10117: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
10118: <li class="listitem">
1.1 dsieger 10119: <p>Remove all CVS dirs.</p>
10120: <p>Alternatively to the first two steps you can also do:</p>
10121: <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>
10122: <p>and use that for further work.</p>
10123: </li>
1.23 wiz 10124: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
10125: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
10126: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
10127: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 10128: <code class="varname">PREV_PKGPATH</code> to the previous category/package
10129: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
10130: for doing an update using pkgsrc building; for example, it can
1.207 leot 10131: search the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20 snj 10132: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
10133: new <code class="varname">PKGPATH</code> for that moved package. Note that
10134: it may have multiple matches, so the tool should also check on the
10135: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
10136: probably has no value unless <code class="varname">SUPERSEDES</code> is not
10137: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.237 gutterid 10138: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.1 dsieger 10139: place.</p></li>
1.23 wiz 10140: <li class="listitem">
1.1 dsieger 10141: <p>Check if any package depends on it:
10142: </p>
10143: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
10144: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
10145: </li>
1.23 wiz 10146: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
10147: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
10148: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
10149: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
10150: <li class="listitem">
1.1 dsieger 10151: <p>Commit the changed and removed files:</p>
10152: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
10153: <p>(and any packages from step 5, of course).</p>
10154: </li>
10155: </ol></div>
10156: </div>
10157: </div>
1.41 asau 10158: <div class="chapter">
1.1 dsieger 10159: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10160: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 10161: <p>This section contains the answers to questions that may
10162: arise when you are writing a package. If you don't find your
10163: question answered here, first have a look in the other chapters,
10164: and if you still don't have the answer, ask on the
10165: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 10166: <div class="qandaset">
1.174 leot 10167: <a name="devfaq.qandaset"></a><dl>
1.154 rillig 10168: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 10169: MAKEFLAGS, .MAKEFLAGS and
10170: MAKE_FLAGS?</a>
10171: </dt>
1.154 rillig 10172: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 10173: MAKE, GMAKE and
10174: MAKE_PROGRAM?</a>
10175: </dt>
1.154 rillig 10176: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 10177: CC, PKG_CC and
10178: PKGSRC_COMPILER?</a>
10179: </dt>
1.223 nia 10180: <dt>24.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 10181: VARNAME=BUILDLINK_PREFIX.foo
10182: say it's empty?</a>
10183: </dt>
1.223 nia 10184: <dt>24.5. <a href="#devfaq.master_sites">What does
1.1 dsieger 10185: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10186: don't understand the := inside
10187: it.</a>
10188: </dt>
1.223 nia 10189: <dt>24.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 10190: developers?</a>
10191: </dt>
1.223 nia 10192: <dt>24.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 10193: documentation?</a>
10194: </dt>
1.223 nia 10195: <dt>24.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.174 leot 10196: What shall I do?</a>
1.1 dsieger 10197: </dt>
10198: </dl>
1.41 asau 10199: <table border="0" style="width: 100%;">
10200: <colgroup>
1.1 dsieger 10201: <col align="left" width="1%">
1.23 wiz 10202: <col>
1.41 asau 10203: </colgroup>
1.1 dsieger 10204: <tbody>
1.41 asau 10205: <tr class="question">
1.1 dsieger 10206: <td align="left" valign="top">
1.174 leot 10207: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1 dsieger 10208: </td>
10209: <td align="left" valign="top"><p>What is the difference between
10210: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10211: <code class="varname">MAKE_FLAGS</code>?</p></td>
10212: </tr>
10213: <tr class="answer">
10214: <td align="left" valign="top"></td>
1.223 nia 10215: <td align="left" valign="top">
10216: <p><code class="varname">MAKEFLAGS</code> are the flags passed
10217: to the pkgsrc-internal invocations of <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.</p>
10218: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
10219: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
10220: package.</p>
10221: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
10222: <span class="command"><strong>bmake</strong></span> and should not be used by
10223: packages.</p>
10224: </td>
1.1 dsieger 10225: </tr>
1.41 asau 10226: <tr class="question">
1.1 dsieger 10227: <td align="left" valign="top">
1.174 leot 10228: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1 dsieger 10229: </td>
10230: <td align="left" valign="top"><p>What is the difference between
10231: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10232: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10233: </tr>
10234: <tr class="answer">
10235: <td align="left" valign="top"></td>
1.223 nia 10236: <td align="left" valign="top">
10237: <p><code class="varname">MAKE</code> is the path to the
1.207 leot 10238: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.223 nia 10239: infrastructure.</p>
10240: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
10241: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
10242: that.</p>
10243: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
10244: program that is used for building the package.</p>
10245: </td>
1.1 dsieger 10246: </tr>
1.41 asau 10247: <tr class="question">
1.1 dsieger 10248: <td align="left" valign="top">
1.174 leot 10249: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1 dsieger 10250: </td>
10251: <td align="left" valign="top"><p>What is the difference between
10252: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10253: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10254: </tr>
10255: <tr class="answer">
10256: <td align="left" valign="top"></td>
10257: <td align="left" valign="top">
1.223 nia 10258: <p><code class="varname">CC</code> is the path to the real C
10259: compiler, which can be configured by the pkgsrc user.</p>
10260: <p><code class="varname">PKG_CC</code> is the path to the compiler
10261: wrapper.</p>
10262: <p><code class="varname">PKGSRC_COMPILER</code> is
10263: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
10264: compiler that should be used. See
10265: <code class="filename">mk/compiler.mk</code> for more information about
10266: the latter variable.</p>
1.1 dsieger 10267: </td>
10268: </tr>
1.41 asau 10269: <tr class="question">
1.1 dsieger 10270: <td align="left" valign="top">
1.223 nia 10271: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.1 dsieger 10272: </td>
1.10 hubertf 10273: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 10274: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10275: say it's empty?</p></td>
10276: </tr>
10277: <tr class="answer">
10278: <td align="left" valign="top"></td>
10279: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 10280: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10281: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 10282: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 10283: command.</p></td>
10284: </tr>
1.41 asau 10285: <tr class="question">
1.1 dsieger 10286: <td align="left" valign="top">
1.223 nia 10287: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.1 dsieger 10288: </td>
10289: <td align="left" valign="top"><p>What does
1.108 rillig 10290: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10291: don't understand the <code class="code">:=</code> inside
1.1 dsieger 10292: it.</p></td>
10293: </tr>
10294: <tr class="answer">
10295: <td align="left" valign="top"></td>
1.223 nia 10296: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
10297: assignment operator, even though it may look like one.
1.1 dsieger 10298: Instead, it is a degenerate form of
1.108 rillig 10299: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.207 leot 10300: which is documented in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108 rillig 10301: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 10302: case of <code class="varname">MASTER_SITE_*</code>,
10303: <em class="replaceable"><code>old_string</code></em> is the empty string and
10304: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 10305: <code class="code">package/</code>. That's where the
10306: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 10307: together.</p></td>
10308: </tr>
1.41 asau 10309: <tr class="question">
1.1 dsieger 10310: <td align="left" valign="top">
1.223 nia 10311: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.1 dsieger 10312: </td>
10313: <td align="left" valign="top"><p>Which mailing lists are there for package
10314: developers?</p></td>
10315: </tr>
10316: <tr class="answer">
10317: <td align="left" valign="top"></td>
1.41 asau 10318: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174 leot 10319: <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 10320: <dd><p>This is a list for technical discussions related
10321: to pkgsrc development, e.g. soliciting feedback for changes to
10322: pkgsrc infrastructure, proposed new features, questions related
10323: to porting pkgsrc to a new platform, advice for maintaining a
10324: package, patches that affect many packages, help requests moved
10325: from pkgsrc-users when an infrastructure bug is found,
10326: etc.</p></dd>
1.174 leot 10327: <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 10328: <dd><p>All bug reports in category "pkg" sent with
1.207 leot 10329: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 10330: directly; use one of the other mailing
10331: lists.</p></dd>
10332: </dl></div></td>
10333: </tr>
1.41 asau 10334: <tr class="question">
1.1 dsieger 10335: <td align="left" valign="top">
1.223 nia 10336: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.1 dsieger 10337: </td>
10338: <td align="left" valign="top"><p>Where is the pkgsrc
10339: documentation?</p></td>
10340: </tr>
10341: <tr class="answer">
10342: <td align="left" valign="top"></td>
10343: <td align="left" valign="top">
10344: <p>There are many places where you can find
10345: documentation about pkgsrc:</p>
1.41 asau 10346: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10347: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 10348: of chapters that explain large parts of pkgsrc, but some
10349: chapters tend to be outdated. Which ones they are is hard to
10350: say.</p></li>
1.174 leot 10351: <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 10352: about certain features, announcements of new parts of the pkgsrc
10353: infrastructure and sometimes even announcements that a certain
10354: feature has been marked as obsolete. The benefit here is that
10355: each message has a date appended to it.</p></li>
1.23 wiz 10356: <li class="listitem"><p>Many of the files in the
1.1 dsieger 10357: <code class="filename">mk/</code> directory start with a comment that
10358: describes the purpose of the file and how it can be used by the
10359: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 10360: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 10361: help</strong></span>.</p></li>
1.23 wiz 10362: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 10363: information, but they tend to be highly abbreviated, especially
10364: for actions that occur often. Some contain a detailed
10365: description of what has changed, but they are geared towards the
10366: other pkgsrc developers, not towards an average pkgsrc user.
10367: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10368: don't know what has been before, these messages may not be worth
10369: too much to you.</p></li>
1.23 wiz 10370: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10371: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 10372: mind of the developer who wrote the code. To get this
1.10 hubertf 10373: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 10374: to see who has written it and ask on the
10375: <code class="literal">tech-pkg</code> mailing list, so that others can
10376: find your questions later (see above). To be sure that the
10377: developer in charge reads the mail, you may CC him or
10378: her.</p></li>
10379: </ul></div>
1.184 rillig 10380: </td>
10381: </tr>
10382: <tr class="question">
10383: <td align="left" valign="top">
1.223 nia 10384: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.184 rillig 10385: </td>
1.223 nia 10386: <td align="left" valign="top"><p>I have a little time to kill.
1.184 rillig 10387: What shall I do?</p></td>
10388: </tr>
10389: <tr class="answer">
10390: <td align="left" valign="top"></td>
10391: <td align="left" valign="top">
10392: <p>This is not really an FAQ yet, but here's the answer
10393: anyway.</p>
1.41 asau 10394: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 10395: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.207 leot 10396: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/index.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
1.184 rillig 10397: will tell you about newer versions of installed packages that are
10398: available, but not yet updated in pkgsrc.</p></li>
10399: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10400: — it contains a list of suggested new packages and a list of
10401: cleanups and enhancements for pkgsrc that would be nice to
10402: have.</p></li>
10403: <li class="listitem"><p>Review packages for which review was requested on
10404: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10405: mailing list.</p></li>
1.1 dsieger 10406: </ul></div>
1.184 rillig 10407: </td>
1.1 dsieger 10408: </tr>
10409: </tbody>
1.184 rillig 10410: </table>
1.1 dsieger 10411: </div>
10412: </div>
10413: </div>
1.41 asau 10414: <div class="part">
1.1 dsieger 10415: <div class="titlepage"><div><div><h1 class="title">
10416: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10417: <div class="partintro">
1.1 dsieger 10418: <div></div>
10419: <p>This part of the guide deals with everything
10420: from the infrastructure that is behind the interfaces described
10421: in the developer's guide. A casual package maintainer should not
10422: need anything from this part.</p>
10423: <div class="toc">
10424: <p><b>Table of Contents</b></p>
1.100 leot 10425: <dl class="toc">
1.184 rillig 10426: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10427: <dd><dl>
1.184 rillig 10428: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10429: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10430: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10431: <dd><dl>
1.184 rillig 10432: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10433: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10434: </dl></dd>
1.184 rillig 10435: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10436: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10437: <dd><dl>
1.184 rillig 10438: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10439: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10440: </dl></dd>
1.184 rillig 10441: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10442: <dd><dl>
1.184 rillig 10443: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10444: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10445: </dl></dd>
10446: </dl></dd>
1.184 rillig 10447: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 10448: <dd><dl>
1.184 rillig 10449: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10450: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10451: <dd><dl>
1.184 rillig 10452: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10453: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10454: </dl></dd>
10455: </dl></dd>
1.184 rillig 10456: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10457: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.1 dsieger 10458: </dl>
10459: </div>
10460: </div>
1.41 asau 10461: <div class="chapter">
1.1 dsieger 10462: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10463: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10464: <div class="toc">
10465: <p><b>Table of Contents</b></p>
1.100 leot 10466: <dl class="toc">
1.184 rillig 10467: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10468: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10469: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10470: <dd><dl>
1.184 rillig 10471: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10472: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10473: </dl></dd>
1.184 rillig 10474: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10475: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10476: <dd><dl>
1.184 rillig 10477: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10478: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10479: </dl></dd>
1.184 rillig 10480: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10481: <dd><dl>
1.184 rillig 10482: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10483: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10484: </dl></dd>
10485: </dl>
10486: </div>
10487: <p>The pkgsrc infrastructure consists of many small Makefile
10488: fragments. Each such fragment needs a properly specified
10489: interface. This chapter explains how such an interface looks
10490: like.</p>
1.41 asau 10491: <div class="sect1">
1.1 dsieger 10492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10493: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10494: <p>Whenever a variable is defined in the pkgsrc
10495: infrastructure, the location and the way of definition provide
10496: much information about the intended use of that variable.
10497: Additionally, more documentation may be found in a header
10498: comment or in this pkgsrc guide.</p>
10499: <p>A special file is
10500: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10501: variables that are intended to be user-defined. They are either
10502: defined using the <code class="literal">?=</code> operator or they are
10503: left undefined because defining them to anything would
1.23 wiz 10504: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10505: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10506: file.</p>
10507: <p>Outside this file, the following conventions apply:
10508: Variables that are defined using the <code class="literal">?=</code>
10509: operator may be overridden by a package.</p>
10510: <p>Variables that are defined using the <code class="literal">=</code>
10511: operator may be used read-only at run-time.</p>
10512: <p>Variables whose name starts with an underscore must not be
10513: accessed outside the pkgsrc infrastructure at all. They may
10514: change without further notice.</p>
1.41 asau 10515: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10516: <h3 class="title">Note</h3>
10517: <p>These conventions are currently not applied
10518: consistently to the complete pkgsrc
10519: infrastructure.</p>
10520: </div>
10521: </div>
1.41 asau 10522: <div class="sect1">
1.1 dsieger 10523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10524: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10525: <p>All variables that contain lists of things should default
10526: to being empty. Two examples that do not follow this rule are
10527: <code class="varname">USE_LANGUAGES</code> and
10528: <code class="varname">DISTFILES</code>. These variables cannot simply be
10529: modified using the <code class="literal">+=</code> operator in package
10530: <code class="filename">Makefile</code>s (or other files included by
10531: them), since there is no guarantee whether the variable is
10532: already set or not, and what its value is. In the case of
1.23 wiz 10533: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10534: the default value and just define it as in the following
10535: example.</p>
10536: <pre class="programlisting">
10537: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10538: </pre>
10539: <p>Because of the selection of this default value, the same
10540: value appears in many package Makefiles. Similarly for
10541: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10542: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10543: doesn't stand out. Nevertheless it is mentioned in many
10544: files.</p>
10545: </div>
1.41 asau 10546: <div class="sect1">
1.1 dsieger 10547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10548: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.41 asau 10549: <div class="sect2">
1.1 dsieger 10550: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10551: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.1 dsieger 10552: <p>Variable evaluation takes place either at load time or at
10553: runtime, depending on the context in which they occur. The
10554: contexts where variables are evaluated at load time are:</p>
1.41 asau 10555: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10556: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10557: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10558: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10559: <code class="literal">.for</code>,</p></li>
1.23 wiz 10560: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10561: </ul></div>
10562: <p>A special exception are references to the iteration
10563: variables of <code class="literal">.for</code> loops, which are expanded
10564: inline, no matter in which context they appear.</p>
10565: <p>As the values of variables may change during load time,
10566: care must be taken not to evaluate them by accident. Typical
10567: examples for variables that should not be evaluated at load time
10568: are <code class="varname">DEPENDS</code> and
10569: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10570: clear, here is an example:</p>
10571: <pre class="programlisting">
10572: CONFIGURE_ARGS= # none
10573: CFLAGS= -O
10574: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10575:
10576: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10577:
10578: CFLAGS+= -Wall
1.111 sevan 10579: </pre>
1.1 dsieger 10580: <p>This code shows how the use of the <code class="literal">:=</code>
10581: operator can quickly lead to unexpected results. The first
10582: paragraph is fairly common code. The second paragraph evaluates
10583: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10584: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10585: <code class="literal">-Wall</code> is appended to the
10586: <code class="varname">CFLAGS</code>, but this addition will not appear in
10587: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10588: paragraphs from above typically occur in completely unrelated
10589: files.</p>
10590: </div>
1.41 asau 10591: <div class="sect2">
1.1 dsieger 10592: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10593: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10594: <p>After all the files have been loaded, the values of the
10595: variables cannot be changed anymore. Variables that are used in
10596: the shell commands are expanded at this point.</p>
10597: </div>
10598: </div>
1.41 asau 10599: <div class="sect1">
1.1 dsieger 10600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10601: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10602: <p>There are many ways in which the definition and use of a
1.108 rillig 10603: variable can be restricted in order to detect bugs and violations
10604: of the (mostly unwritten) policies. A package can be checked with
10605: <code class="literal">pkglint -Wall</code> to see whether it meets these
10606: rules.</p>
1.1 dsieger 10607: </div>
1.41 asau 10608: <div class="sect1">
1.1 dsieger 10609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10610: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10611: <p>Most of the <code class="filename">.mk</code> files fall into one
10612: of the following classes. Cases where a file falls into more
10613: than one class should be avoided as it often leads to subtle
10614: bugs.</p>
1.41 asau 10615: <div class="sect2">
1.1 dsieger 10616: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10617: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10618: <p>In a traditional imperative programming language some of
10619: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10620: procedures. They take some input parameters and—after
10621: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10622: variables in <code class="filename">Makefile</code>s have global scope
10623: care must be taken not to use parameter names that have already
10624: another meaning. For example, <code class="varname">PKGNAME</code> is a
10625: bad choice for a parameter name.</p>
10626: <p>Procedures are completely evaluated at preprocessing time.
10627: That is, when calling a procedure all input parameters must be
10628: completely resolvable. For example,
10629: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10630: parameter since it is very likely that further text will be
10631: added after calling the procedure, which would effectively apply
10632: the procedure to only a part of the variable. Also, references
1.108 rillig 10633: to other variables will be modified after calling the
1.1 dsieger 10634: procedure.</p>
10635: <p>A procedure can declare its output parameters either as
10636: suitable for use in preprocessing directives or as only
10637: available at runtime. The latter alternative is for variables
10638: that contain references to other runtime variables.</p>
10639: <p>Procedures shall be written such that it is possible to
10640: call the procedure more than once. That is, the file must not
10641: contain multiple-inclusion guards.</p>
10642: <p>Examples for procedures are
10643: <code class="filename">mk/bsd.options.mk</code> and
10644: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10645: that the parameters are evaluated at load time, they should be
10646: assigned using the <code class="literal">:=</code> operator, which should
10647: be used only for this purpose.</p>
10648: </div>
1.41 asau 10649: <div class="sect2">
1.1 dsieger 10650: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10651: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10652: <p>Action files take some input parameters and may define
10653: runtime variables. They shall not define loadtime variables.
10654: There are action files that are included implicitly by the
10655: pkgsrc infrastructure, while other must be included
10656: explicitly.</p>
10657: <p>An example for action files is
10658: <code class="filename">mk/subst.mk</code>.</p>
10659: </div>
10660: </div>
1.41 asau 10661: <div class="sect1">
1.1 dsieger 10662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10663: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10664: <p>Package <code class="filename">Makefile</code>s usually consist of
10665: a set of variable definitions, and include the file
10666: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10667: Before that, they may also include various other
10668: <code class="filename">*.mk</code> files if they need to query the
10669: availability of certain features like the type of compiler or
10670: the X11 implementation. Due to the heavy use of preprocessor
10671: directives like <code class="literal">.if</code> and
10672: <code class="literal">.for</code>, the order in which the files are loaded
10673: matters.</p>
10674: <p>This section describes at which point the various files
10675: are loaded and gives reasons for that order.</p>
1.41 asau 10676: <div class="sect2">
1.1 dsieger 10677: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10678: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10679: </h3></div></div></div>
10680: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10681: is to define some essential variables like
10682: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10683: <code class="varname">MACHINE_ARCH</code>.</p>
10684: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10685: 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 10686: After that, those variables
1.1 dsieger 10687: that have not been overridden by the user are loaded from
10688: <code class="filename">mk/defaults/mk.conf</code>.</p>
10689: <p>After the user settings, the system settings and platform
10690: settings are loaded, which may override the user
10691: settings.</p>
10692: <p>Then, the tool definitions are loaded. The tool wrappers
10693: are not yet in effect. This only happens when building a
10694: package, so the proper variables must be used instead of the
10695: direct tool names.</p>
10696: <p>As the last steps, some essential variables from the
10697: wrapper and the package system flavor are loaded, as well as the
10698: variables that have been cached in earlier phases of a package
10699: build.</p>
10700: </div>
1.41 asau 10701: <div class="sect2">
1.1 dsieger 10702: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10703: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10704: </h3></div></div></div>
10705: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10706: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10707: loaded, which fill default values for those variables that have
10708: not been defined by the package. These variables may later
10709: be used even in unrelated files.</p>
10710: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10711: provides the target <code class="literal">error-check</code> that is added
10712: as a special dependency to all other targets that use
10713: <code class="varname">DELAYED_ERROR_MSG</code> or
10714: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10715: <p>Then, the package-specific hacks from
10716: <code class="filename">hacks.mk</code> are included.</p>
10717: <p>Then, various other files follow. Most of them don't have
10718: any dependencies on what they need to have included before or
10719: after them, though some do.</p>
10720: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10721: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10722: restricts the use of these variables to all the files that have
10723: been included before. Appearances in later files will be
10724: silently ignored.</p>
10725: <p>Then, the files for the main targets are included, in the
10726: order of later execution, though the actual order should not
10727: matter.</p>
10728: <p>At last, some more files are included that don't set any
10729: interesting variables but rather just define make targets to be
10730: executed.</p>
10731: </div>
10732: </div>
10733: </div>
1.41 asau 10734: <div class="chapter">
1.1 dsieger 10735: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10736: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.1 dsieger 10737: <div class="toc">
10738: <p><b>Table of Contents</b></p>
1.100 leot 10739: <dl class="toc">
1.184 rillig 10740: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10741: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10742: <dd><dl>
1.184 rillig 10743: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10744: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10745: </dl></dd>
10746: </dl>
10747: </div>
10748: <p>The pkgsrc infrastructure consists of a large codebase,
10749: and there are many corners where every little bit of a file is
10750: well thought out, making pkgsrc likely to fail as soon as
10751: anything is changed near those parts. To prevent most changes
10752: from breaking anything, a suite of regression tests should go
10753: along with every important part of the pkgsrc infrastructure.
10754: This chapter describes how regression tests work in pkgsrc and
10755: how you can add new tests.</p>
1.41 asau 10756: <div class="sect1">
1.1 dsieger 10757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10758: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.207 leot 10759: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/index.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10 hubertf 10760: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10761: can simply run that command, which will run all tests in the
1.168 rillig 10762: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10763: </div>
1.41 asau 10764: <div class="sect1">
1.1 dsieger 10765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10766: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10767: <p>Every directory in the <code class="filename">regress/</code>
10768: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10769: is considered a regression test. This file is a shell program
1.10 hubertf 10770: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10771: The following functions can be overridden to suit your
10772: needs.</p>
1.41 asau 10773: <div class="sect2">
1.1 dsieger 10774: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10775: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10776: <p>These functions do not take any parameters. Although they
10777: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.174 leot 10778: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10779: question</a> for details.</p>
1.41 asau 10780: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10781: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10782: <dd><p>This function prepares the environment for the
10783: test. By default it does nothing.</p></dd>
1.108 rillig 10784: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10785: <dd>
10786: <p>This function runs the actual test. By default,
1.1 dsieger 10787: it calls <code class="varname">TEST_MAKE</code> with the arguments
10788: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10789: error messages into the file
1.108 rillig 10790: <code class="varname">TEST_OUTFILE</code>.</p>
10791: <p>When defining this function, make sure that all output that
10792: needs to be checked is written to the correct output file.
10793: Example:</p>
10794: <pre class="programlisting">
10795: do_test() {
1.112 rillig 10796: echo "Example output"
1.108 rillig 10797: } 1>$TEST_OUTFILE 2>&1
10798: </pre>
10799: </dd>
10800: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10801: <dd>
10802: <p>This function is run after the test and is
1.1 dsieger 10803: typically used to compare the actual output from the one that is
10804: expected. It can make use of the various helper functions from
1.108 rillig 10805: the next section. Example:</p>
10806: <pre class="programlisting">
10807: check_result() {
1.112 rillig 10808: exit_status 0
10809: output_require "Example"
10810: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10811: output_prohibit "no such file or directory"
1.168 rillig 10812: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 10813: }
10814: </pre>
10815: </dd>
10816: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10817: <dd><p>This function cleans everything up after the
10818: test has been run. By default it does nothing.</p></dd>
10819: </dl></div>
10820: </div>
1.41 asau 10821: <div class="sect2">
1.1 dsieger 10822: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10823: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.41 asau 10824: <div class="variablelist"><dl class="variablelist">
1.168 rillig 10825: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10826: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 10827: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10828: <dd><p>This function compares the exitcode of the
1.108 rillig 10829: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10830: If they differ, the test will fail.</p></dd>
1.108 rillig 10831: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10832: <dd>
10833: <p>This function checks for each of its parameters
10834: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10835: extended regular expression. If it does not, the test will
1.108 rillig 10836: fail. Example:</p>
10837: <pre class="programlisting">
10838: output_require "looks fine"
10839: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10840: </pre>
10841: </dd>
1.177 leot 10842: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1 dsieger 10843: <dd><p>This function checks for each of its parameters
1.10 hubertf 10844: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10845: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10846: If any of the regular expressions matches, the test will
10847: fail.</p></dd>
10848: </dl></div>
10849: </div>
10850: </div>
10851: </div>
1.41 asau 10852: <div class="chapter">
1.1 dsieger 10853: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10854: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10855: <div class="toc">
10856: <p><b>Table of Contents</b></p>
1.184 rillig 10857: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.1 dsieger 10858: </div>
10859: <p>The pkgsrc system has already been ported to many
10860: operating systems, hardware architectures and compilers. This
10861: chapter explains the necessary steps to make pkgsrc even more
10862: portable.</p>
1.41 asau 10863: <div class="sect1">
1.1 dsieger 10864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10865: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10866: <p>To port pkgsrc to a new operating system (called
10867: <code class="literal">MyOS</code> in this example), you need to touch the
10868: following files:</p>
1.41 asau 10869: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10870: <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>
10871: <dd><p>This file contains some basic definitions, for
10872: example the name of the C
10873: compiler.</p></dd>
10874: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10875: <dd><p>Insert code that defines the variables
10876: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.212 wiz 10877: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.1 dsieger 10878: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10879: <code class="varname">APPEND_ELF</code>, and the other variables that
10880: appear in this file.</p></dd>
10881: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10882: <dd><p>This file contains the platform-specific
10883: definitions that are used by pkgsrc. Start by copying one of the
10884: other files and edit it to your
10885: needs.</p></dd>
10886: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10887: <dd><p>This file defines the paths to all the tools
10888: that are needed by one or the other package in pkgsrc, as well
10889: as by pkgsrc itself. Find out where these tools are on your
10890: platform and add them.</p></dd>
10891: </dl></div>
10892: <p>Now, you should be able to build some basic packages, like
1.207 leot 10893: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/index.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/index.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.1 dsieger 10894: </div>
10895: </div>
10896: </div>
1.41 asau 10897: <div class="appendix">
10898: <div class="titlepage"><div><div><h1 class="title">
10899: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10900: <div class="toc">
10901: <p><b>Table of Contents</b></p>
1.100 leot 10902: <dl class="toc">
1.1 dsieger 10903: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10904: <dd><dl>
10905: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10906: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10907: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 10908: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 10909: </dl></dd>
10910: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10911: </dl>
10912: </div>
10913: <p>We checked to find a piece of software that wasn't in the packages
10914: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10915: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10916: present in the tree is beyond us, but it's useful for the purposes of
10917: this exercise.</p>
1.41 asau 10918: <div class="sect1">
1.1 dsieger 10919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10920: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10921: <div class="sect2">
1.1 dsieger 10922: <div class="titlepage"><div><div><h3 class="title">
10923: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10924: <pre class="programlisting">
10925: # $NetBSD$
10926: #
10927:
10928: DISTNAME= bison-1.25
10929: CATEGORIES= devel
1.171 rillig 10930: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 10931:
1.29 dholland 10932: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 10933: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 10934: COMMENT= GNU yacc clone
10935:
10936: GNU_CONFIGURE= yes
1.46 wiz 10937: INFO_FILES= yes
1.1 dsieger 10938:
10939: .include "../../mk/bsd.pkg.mk"
10940: </pre>
10941: </div>
1.41 asau 10942: <div class="sect2">
1.1 dsieger 10943: <div class="titlepage"><div><div><h3 class="title">
10944: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10945: <pre class="programlisting">
10946: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.207 leot 10947: improvements. Why you would want this when Berkeley <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 10948: of the NetBSD source tree is beyond me.
10949: </pre>
10950: </div>
1.41 asau 10951: <div class="sect2">
1.1 dsieger 10952: <div class="titlepage"><div><div><h3 class="title">
10953: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10954: <pre class="programlisting">
10955: @comment $NetBSD$
10956: bin/bison
10957: man/man1/bison.1.gz
10958: share/bison.simple
10959: share/bison.hairy
10960: </pre>
10961: </div>
1.41 asau 10962: <div class="sect2">
1.1 dsieger 10963: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 10964: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 10965: <p>The NetBSD package system comes with
1.207 leot 10966: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1 dsieger 10967: which helps to check the contents of these
10968: files. After installation it is quite easy to use, just change to the
1.171 rillig 10969: directory of the package you wish to examine and run
1.10 hubertf 10970: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10971: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 10972: ERROR: Makefile: Each package must define its LICENSE.
10973: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
10974: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
10975: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
10976: 1 error, 2 warnings and 1 note found.
10977: (Run "pkglint -e" to show explanations.)
10978: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 10979: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 10980: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 10981: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 10982: -Wall</strong></span> for a very thorough check.</p>
10983: </div>
10984: </div>
1.41 asau 10985: <div class="sect1">
1.1 dsieger 10986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10987: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10988: <p>Create the directory where the package lives,
10989: plus any auxiliary directories:</p>
10990: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10991: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10992: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10993: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10994: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.184 rillig 10995: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 12. Package components - files, directories and contents">Chapter 12, <i>Package components - files, directories and contents</i></a>)
1.1 dsieger 10996: then continue with fetching the distfile:</p>
10997: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10998: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10999: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
11000: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11001: ftp: Error retrieving file: 500 Internal error
11002:
11003: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
11004: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11005: ftp: Error retrieving file: 500 Internal error
11006:
11007: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
11008: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11009: Successfully retrieved file.</pre>
11010: <p>Generate the checksum of the distfile into
11011: <code class="filename">distinfo</code>:</p>
11012: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
11013: <p>Now compile:</p>
11014: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11015: >> Checksum OK for bison-1.25.tar.gz.
11016: ===> Extracting for bison-1.25
11017: ===> Patching for bison-1.25
11018: ===> Ignoring empty patch directory
11019: ===> Configuring for bison-1.25
11020: creating cache ./config.cache
11021: checking for gcc... cc
11022: checking whether we are using GNU C... yes
11023: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
11024: checking how to run the C preprocessor... cc -E
11025: checking for minix/config.h... no
11026: checking for POSIXized ISC... no
11027: checking whether cross-compiling... no
11028: checking for ANSI C header files... yes
11029: checking for string.h... yes
11030: checking for stdlib.h... yes
11031: checking for memory.h... yes
11032: checking for working const... yes
11033: checking for working alloca.h... no
11034: checking for alloca... yes
11035: checking for strerror... yes
11036: updating cache ./config.cache
11037: creating ./config.status
11038: creating Makefile
11039: ===> Building for bison-1.25
11040: 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
11041: 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
11042: 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
11043: 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
11044: 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
11045: 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
11046: 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
11047: 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
11048: 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
11049: 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
11050: 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
11051: 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
11052: 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
11053: 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
11054: 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
11055: 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
11056: 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
11057: 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
11058: 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
11059: 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
11060: 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
11061: 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
11062: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
11063: rm -f bison.s1
11064: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
11065: <p>Everything seems OK, so install the files:</p>
11066: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11067: >> Checksum OK for bison-1.25.tar.gz.
11068: ===> Installing for bison-1.25
11069: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
11070: rm -f /usr/pkg/bin/bison
11071: cd /usr/pkg/share; rm -f bison.simple bison.hairy
11072: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
11073: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11074: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11075: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11076: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11077: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
11078: ===> Registering installation for bison-1.25</pre>
11079: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 11080: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 11081: binary package, do this now:</p>
11082: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11083: >> Checksum OK for bison-1.25.tar.gz.
11084: ===> Building package for bison-1.25
11085: Creating package bison-1.25.tgz
11086: Registering depends:.
11087: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11088: <p>Now that you don't need the source and object files
11089: any more, clean up:</p>
11090: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11091: ===> Cleaning for bison-1.25</pre>
11092: </div>
11093: </div>
1.41 asau 11094: <div class="appendix">
11095: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 11096: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.1 dsieger 11097: <div class="toc">
11098: <p><b>Table of Contents</b></p>
1.100 leot 11099: <dl class="toc">
1.207 leot 11100: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
11101: <dd><dl>
11102: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
11103: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
11104: </dl></dd>
11105: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
11106: <dd><dl>
11107: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
11108: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
11109: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
11110: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
11111: </dl></dd>
11112: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
11113: <dd><dl>
11114: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
11115: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
11116: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
11117: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
11118: </dl></dd>
1.1 dsieger 11119: </dl>
11120: </div>
1.207 leot 11121: <p>
11122: A number of mechanisms are available in pkgsrc to improve the security of the
11123: resulting system. This page describes the mechanisms, and gives hints
11124: about detecting and fixing problems.
11125: </p>
11126: <p>
11127: Mechanisms can be enabled individually in
11128: <code class="filename">mk.conf</code>, and are
11129: individually described below.
11130: </p>
11131: <p>
11132: Typically, a feature will cause some programs to fail to build or work
11133: when first enabled. This can be due to latent problems in the
11134: program, and can be due to other reasons. After enough testing to
11135: have confidence that user problems will be quite rare, individual
11136: mechanisms will be enabled by default.
11137: </p>
11138: <p>
11139: For each mechanism, see the Caveats section below for an explanation
11140: of what might go wrong at compile time and at run time, and how to
11141: notice and address these problems.
11142: </p>
1.41 asau 11143: <div class="sect1">
1.1 dsieger 11144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11145: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
11146: <div class="sect2">
11147: <div class="titlepage"><div><div><h3 class="title">
11148: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
11149: <div class="sect3">
11150: <div class="titlepage"><div><div><h4 class="title">
11151: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
11152: <p>
11153: This allows substitute wrappers to be used for some commonly used
11154: library functions that do not have built-in bounds checking - but
11155: could in some cases.
11156: </p>
11157: <p>
11158: Two mitigation levels are available:
11159: </p>
11160: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11161: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
11162: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
11163: </ul></div>
11164: <p>
11165: "strong" has been enabled by default since pkgsrc-2017Q3.
11166: </p>
11167: </div>
11168: <div class="sect3">
11169: <div class="titlepage"><div><div><h4 class="title">
11170: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
11171: <p>
11172: This enables a stack-smashing protection mitigation. It is done by adding a
11173: guard variable to functions with vulnerable objects. The guards are initialized
11174: when a function is entered and then checked when the function exits. The guard
11175: check will fail and the program forcibly exited if the variable was modified in
11176: the meantime. This can happen in case of buffer overflows or memory corruption,
11177: and therefore exposing these bugs.
11178: </p>
11179: <p>
11180: Different mitigation levels are available:
11181: </p>
11182: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11183: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11184: by the compiler;</p></li>
11185: <li class="listitem"><p>"all", which will protect every function;</p></li>
11186: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11187: two settings above.</p></li>
11188: </ul></div>
11189: <p>
11190: This mitigation is supported by both GCC and clang. It may be supported in
11191: additional compilers, possibly under a different name. It is particularly useful
11192: for unsafe programming languages, such as C/C++.
11193: </p>
11194: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11195: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11196: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11197: </ul></div>
11198: <p>More details can be found here:</p>
11199: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11200: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11201: </p></li></ul></div>
11202: </div>
11203: <div class="sect3">
11204: <div class="titlepage"><div><div><h4 class="title">
11205: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
11206: <p>
11207: This requests the creation of PIE (Position Independent Executables) for all
11208: executables. The PIE mechanism is normally used for shared libraries, so that
11209: they can be loaded at differing addresses at runtime. PIE itself does not have
11210: useful security properties; however, it is necessary to fully leverage some,
11211: such as ASLR. Some operating systems support Address Space Layout Randomization
11212: (ASLR), which causes different addresses to be used each time a program is run.
11213: This makes it more difficult for an attacker to guess addresses and thus makes
11214: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11215: program, instead of the stack and heap only.
11216: </p>
11217: <p>
11218: PIE executables will only be built for toolchains that are known to support PIE.
11219: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11220: </p>
11221: <p>
11222: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11223: </p>
1.1 dsieger 11224: </div>
1.210 gutterid 11225: <div class="sect3">
11226: <div class="titlepage"><div><div><h4 class="title">
1.219 nia 11227: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.207 leot 11228: <p>
11229: This also makes the exploitation of some security vulnerabilities more
11230: difficult in some cases.
11231: </p>
11232: <p>Two different mitigation levels are available:</p>
11233: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11234: <li class="listitem"><p>
1.219 nia 11235: partial (the default): the ELF sections are reordered so that internal data sections
1.207 leot 11236: precede the program's own data sections, and non-PLT GOT is read-only;
11237: </p></li>
11238: <li class="listitem"><p>
11239: full: in addition to partial RELRO, every relocation is performed immediately
1.218 nia 11240: when starting the program, allowing the entire GOT to be read-only. This
11241: can greatly slow down startup of large programs.
1.207 leot 11242: </p></li>
11243: </ul></div>
11244: <p>
11245: This is currently supported by GCC. Many software distributions now enable this
1.220 nia 11246: feature by default, at the "partial" level.
1.207 leot 11247: </p>
11248: <p>
11249: More details can be found here:
11250: </p>
11251: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11252: <a class="ulink" href="https://www.redhat.com/en/blog/hardening-elf-binaries-using-relocation-read-only-relro" target="_top">Hardening ELF binaries using Relocation Read-Only (RELRO)</a>
11253: </p></li></ul></div>
1.1 dsieger 11254: </div>
1.219 nia 11255: </div>
11256: <div class="sect2">
11257: <div class="titlepage"><div><div><h3 class="title">
11258: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
11259: <div class="sect3">
11260: <div class="titlepage"><div><div><h4 class="title">
11261: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
11262: <p>
11263: With this option, pkgsrc will try to build packages reproducibly. This allows
11264: packages built from the same tree and with the same options, to produce
11265: identical results bit by bit. This option should be combined with ASLR and
11266: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11267: attackers attempting to exploit security vulnerabilities.
11268: </p>
11269: <p>
11270: More details can be found here:
11271: </p>
11272: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11273: <a class="ulink" href="https://reproducible-builds.org/" target="_top">Reproducible Builds - a set of software development practices that create an independently-verifiable path from source to binary code</a>
11274: </p></li></ul></div>
11275: <p>
11276: More work likely needs to be done before pkgsrc is fully reproducible.
11277: </p>
11278: </div>
1.207 leot 11279: <div class="sect3">
11280: <div class="titlepage"><div><div><h4 class="title">
1.219 nia 11281: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.207 leot 11282: <p>
11283: This uses <code class="literal">-fstack-check</code> with GCC for
11284: another stack protection mitigation.
11285: </p>
11286: <p>
11287: It asks the compiler to generate code verifying that it does not corrupt the
11288: stack. According to GCC's manual page, this is really only useful for
11289: multi-threaded programs.
11290: </p>
1.1 dsieger 11291: </div>
11292: </div>
11293: </div>
1.41 asau 11294: <div class="sect1">
1.1 dsieger 11295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11296: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
11297: <div class="sect2">
11298: <div class="titlepage"><div><div><h3 class="title">
11299: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
11300: <div class="sect3">
11301: <div class="titlepage"><div><div><h4 class="title">
11302: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
11303: <p>
11304: A number of packages may fail to build with this option enabled. The
11305: failures are often related to the absence of the <code class="literal">-fPIC</code>
11306: compilation flag when building libraries or executables (or ideally
11307: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11308: <code class="varname">CFLAGS</code> already, but requires the package to
11309: actually support it.
11310: </p>
11311: <div class="sect4">
11312: <div class="titlepage"><div><div><h5 class="title">
11313: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
11314: <p>
11315: These instructions are meant as a reference only; they likely need to be adapted
11316: for many packages individually.
11317: </p>
11318: <p>
11319: For packages using <code class="filename">Makefiles</code>:
11320: </p>
11321: <pre class="programlisting">
11322: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11323: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11324: </pre>
11325: <p>
11326: For packages using <code class="filename">Imakefiles</code>:
11327: </p>
11328: <pre class="programlisting">
11329: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11330: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11331: </pre>
11332: </div>
11333: </div>
11334: <div class="sect3">
11335: <div class="titlepage"><div><div><h4 class="title">
11336: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
11337: <p>
11338: Some programs may fail to run, or crash at random times once built as PIE. Two
11339: scenarios are essentially possible. This is nearly always due to a bug in
11340: the program being exposed due to ASLR.
11341: </p>
11342: </div>
11343: <div class="sect3">
11344: <div class="titlepage"><div><div><h4 class="title">
11345: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
11346: <p>
11347: Ideally, packages should be fixed for compatibility with MKPIE.
11348: However, in some cases this is very difficult, due to complex build systems,
11349: packages using non-standard toolchains, or programming languages with odd
11350: bootstrapping mechanisms.
11351: </p>
11352: <p>
11353: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11354: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11355: <code class="filename">bsd.prefs.mk</code> is included.
11356: </p>
11357: </div>
11358: </div>
11359: <div class="sect2">
11360: <div class="titlepage"><div><div><h3 class="title">
11361: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
11362: <div class="sect3">
11363: <div class="titlepage"><div><div><h4 class="title">
11364: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
11365: <p>
11366: This feature makes use of pre-processing directives to look for hardened,
11367: alternative implementations of essential library calls. Some programs may fail
11368: to build as a result; this usually happens for those trying too hard to be
11369: portable, or otherwise abusing definitions in the standard library.
11370: </p>
11371: </div>
11372: <div class="sect3">
11373: <div class="titlepage"><div><div><h4 class="title">
11374: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
11375: <p>
11376: This feature may cause some programs to crash, usually indicating an
11377: actual bug in the program. The fix will typically involve patching the
11378: original program's source code.
11379: </p>
11380: </div>
11381: <div class="sect3">
11382: <div class="titlepage"><div><div><h4 class="title">
11383: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
11384: <p>
11385: At least in the case of GCC, FORTIFY will only be applied if optimization is
11386: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11387: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11388: optimization level. This cannot easily be applied globally, as some packages
11389: may require specific optimization levels.
11390: </p>
11391: </div>
11392: <div class="sect3">
11393: <div class="titlepage"><div><div><h4 class="title">
11394: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
11395: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11396: <h3 class="title">Note</h3>
11397: <p>FORTIFY should not be disabled to work around runtime crashes in
11398: the program! This is a very bad idea and will expose you to security
11399: vulnerabilities.
11400: </p>
11401: </div>
11402: <p>
11403: To disable FORTIFY on a per-package basis, set the following
11404: in the package's <code class="filename">Makefile</code>
11405: before <code class="filename">bsd.prefs.mk</code> is included:
11406: </p>
11407: <pre class="programlisting">
11408: FORTIFY_SUPPORTED= no
11409: </pre>
11410: </div>
11411: </div>
11412: <div class="sect2">
11413: <div class="titlepage"><div><div><h3 class="title">
11414: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
11415: <div class="sect3">
11416: <div class="titlepage"><div><div><h4 class="title">
11417: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
11418: <p>
11419: For better protection, full RELRO requires every symbol to be resolved when the
11420: program starts, rather than simply when required at run-time. This will have
11421: more impact on programs using a lot of symbols, or linked to libraries exposing
11422: a lot of symbols. Therefore, daemons or programs otherwise running in
11423: background are affected only when started. Programs loading plug-ins at
11424: run-time are affected when loading the plug-ins.
11425: </p>
11426: <p>
11427: The impact is not expected to be noticeable on modern hardware, except in some
11428: cases for big programs.
11429: </p>
11430: </div>
11431: <div class="sect3">
11432: <div class="titlepage"><div><div><h4 class="title">
11433: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
11434: <p>
11435: Some programs handle plug-ins and dependencies in a way that conflicts with
11436: RELRO: for instance, with an initialization routine listing any other plug-in
11437: required. With full RELRO, the missing symbols are resolved before the
11438: initialization routine can run, and the dynamic loader will not be able to find
11439: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11440: drivers. Partial RELRO can be applied instead in this case.
11441: </p>
11442: </div>
11443: <div class="sect3">
11444: <div class="titlepage"><div><div><h4 class="title">
11445: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
11446: <p>
11447: To disable RELRO on a per-package basis, set the following
11448: in the package's <code class="filename">Makefile</code>
11449: before <code class="filename">bsd.prefs.mk</code> is included:
11450: </p>
11451: <pre class="programlisting">
11452: RELRO_SUPPORTED= no
11453: </pre>
1.209 nia 11454: <p>
11455: It is also possible to at most enable partial RELRO, by
11456: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11457: </p>
1.207 leot 11458: </div>
11459: </div>
11460: <div class="sect2">
11461: <div class="titlepage"><div><div><h3 class="title">
11462: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
11463: <div class="sect3">
11464: <div class="titlepage"><div><div><h4 class="title">
11465: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
11466: <p>
11467: The stack-smashing protection provided by this option does not work for some
11468: programs. The most common situation in which this happens is when the program
11469: allocates variables on the stack, with the size determined at run-time.
11470: </p>
11471: </div>
11472: <div class="sect3">
11473: <div class="titlepage"><div><div><h4 class="title">
11474: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
11475: <p>
11476: Again, this feature may cause some programs to crash via a
11477: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11478: </p>
11479: <p>
11480: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11481: messages are sent and - by default -
11482: appended to <code class="filename">/var/log/messages</code>, e.g.:
11483: </p>
11484: <pre class="programlisting">
11485: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11486: </pre>
11487: <p>
11488: (where <code class="literal">hostname</code> is the hostname(1) and
11489: <code class="literal">program</code> is the basename(1) of the program crashed).
11490: </p>
11491: <p>
11492: Patching the original program is then required.
11493: </p>
11494: <p>
11495: Rebuilding the package via:
11496: </p>
11497: <pre class="programlisting">
11498: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11499: </pre>
11500: <p>
11501: and inspecting the backtrace of the coredump via the debugger
11502: should point out the problematic call by inspecting the frame
11503: calling the _chk() (SSP) function.
11504: </p>
11505: </div>
11506: <div class="sect3">
11507: <div class="titlepage"><div><div><h4 class="title">
11508: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
11509: <p>
11510: The compiler emits extra code when using this feature: a check for buffer
11511: overflows is performed when entering and exiting functions, requiring an extra
11512: variable on the stack. The level of protection can otherwise be adjusted to
11513: affect only those functions considered more sensitive by the compiler (with
11514: -fstack-protector instead of -fstack-protector-all).
11515: </p>
11516: <p>
11517: The impact is not expected to be noticeable on modern hardware. However,
11518: programs with a hard requirement to run at the fastest possible speed should
11519: avoid using this feature, or using libraries built with this feature.
11520: </p>
11521: </div>
11522: <div class="sect3">
11523: <div class="titlepage"><div><div><h4 class="title">
11524: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
11525: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11526: <h3 class="title">Note</h3>
11527: <p>SSP should not be disabled to work around runtime crashes in
11528: the program! This is a very bad idea and will expose you to security
11529: vulnerabilities.</p>
11530: </div>
11531: <p>
11532: To disable SSP on a per-package basis, set the following
11533: in the package's <code class="filename">Makefile</code>
11534: before <code class="filename">bsd.prefs.mk</code> is included:
11535: </p>
11536: <pre class="programlisting">
11537: SSP_SUPPORTED= no
11538: </pre>
11539: </div>
11540: </div>
11541: </div>
11542: <div class="sect1">
11543: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11544: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
11545: <p>
11546: The illusion of security is worse than having no security at all. This section
11547: lists a number of ways to ensure the security features requested are actually
11548: effective.
11549: </p>
11550: <p>
11551: These instructions were obtained and tested on a system derived from NetBSD 7
11552: (amd64). YMMV.
11553: </p>
11554: <div class="sect2">
11555: <div class="titlepage"><div><div><h3 class="title">
11556: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
11557: <p>
11558: The ELF executable type in use changes for binaries built as PIE; without:
11559: </p>
11560: <pre class="programlisting">
11561: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11562: /path/to/bin/ary: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
11563: </pre>
11564: <p>as opposed to the following binary, built as PIE:</p>
11565: <pre class="programlisting">
11566: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11567: /path/to/pie/bin/ary: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
11568: </pre>
11569: <p>
11570: The latter result is then what is expected.
11571: </p>
11572: </div>
11573: <div class="sect2">
11574: <div class="titlepage"><div><div><h3 class="title">
11575: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
11576: <p>
11577: The following command should list a section called RELRO:
11578: </p>
11579: <pre class="programlisting">
11580: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11581:
11582: /path/to/bin/ary: file format elf64-x86-64
11583:
11584: Program Header:
11585: [...]
11586: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11587: </pre>
11588: <p>
11589: This check is now performed automatically if
11590: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11591: </p>
11592: </div>
11593: <div class="sect2">
11594: <div class="titlepage"><div><div><h3 class="title">
11595: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
11596: <p>
11597: The dynamic loader will apply RELRO immediately when detecting the presence of
11598: the <code class="varname">BIND_NOW</code> flag:
11599: </p>
11600: <pre class="programlisting">
11601: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11602:
11603: /path/to/bin/ary: file format elf64-x86-64
11604:
11605: Dynamic Section:
11606: [...]
11607: BIND_NOW 0x0000000000000000
11608: </pre>
11609: <p>
11610: This has to be combined with partial RELRO (see above) to be fully efficient.
11611: </p>
11612: <p>
11613: This check is now performed automatically (where supported) if
11614: <code class="varname">PKG_DEVELOPER</code> is set.
11615: </p>
11616: </div>
11617: <div class="sect2">
11618: <div class="titlepage"><div><div><h3 class="title">
11619: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.208 nia 11620: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11621: <h3 class="title">Note</h3>
11622: <p>
11623: Checking for SSP using this method only works where the operating system
11624: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11625: on recent NetBSD/FreeBSD/Linux versions.
11626: </p>
11627: </div>
1.207 leot 11628: <p>
11629: Building objects, binaries and libraries with SSP will affect the presence of
11630: additional symbols in the resulting file:
11631: </p>
11632: <pre class="programlisting">
11633: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11634: [...]
11635: U __stack_chk_fail
11636: 0000000000600ea0 B __stack_chk_guard
11637: </pre>
11638: <p>
11639: This is an indicator that the program was indeed built with support for SSP.
11640: </p>
11641: <p>
11642: This check is now performed automatically (where supported) if
11643: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11644: </p>
11645: </div>
11646: </div>
11647: </div>
11648: <div class="appendix">
11649: <div class="titlepage"><div><div><h1 class="title">
11650: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
11651: <div class="toc">
11652: <p><b>Table of Contents</b></p>
11653: <dl class="toc">
11654: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11655: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11656: </dl>
11657: </div>
11658: <div class="sect1">
11659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11660: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
11661: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11662: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11663: => figlet221.tar.gz doesn't seem to exist on this system.
11664: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11665: => [172219 bytes]
11666: Connected to ftp.plig.net.
11667: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11668: 331 Guest login ok, send your complete e-mail address as password.
11669: 230-You are user #5 of 500 simultaneous users allowed.
11670: 230-
11671: 230- ___ _ _ _
11672: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11673: 230- | _| _| . |_| . | | | . |_| . | _| . |
11674: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11675: 230- |_| |_| |___| |___|
11676: 230-
11677: 230-** Welcome to ftp.plig.org **
11678: 230-
11679: 230-Please note that all transfers from this FTP site are logged. If you
11680: 230-do not like this, please disconnect now.
11681: 230-
11682: 230-This archive is available via
11683: 230-
11684: 230-HTTP: http://ftp.plig.org/
11685: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11686: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11687: 230-
11688: 230-Please email comments, bug reports and requests for packages to be
11689: 230-mirrored to ftp-admin@plig.org.
11690: 230-
11691: 230-
11692: 230 Logged in anonymously.
11693: Remote system type is UNIX.
11694: Using binary mode to transfer files.
11695: 200 Type okay.
11696: 250 "/pub" is new cwd.
11697: 250-"/pub/figlet" is new cwd.
11698: 250-
11699: 250-Welcome to the figlet archive at ftp.figlet.org
11700: 250-
11701: 250- ftp://ftp.figlet.org/pub/figlet/
11702: 250-
11703: 250-The official FIGlet web page is:
11704: 250- http://www.figlet.org/
11705: 250-
11706: 250-If you have questions, please mailto:info@figlet.org. If you want to
11707: 250-contribute a font or something else, you can email us.
11708: 250
11709: 250 "/pub/figlet/program" is new cwd.
11710: 250 "/pub/figlet/program/unix" is new cwd.
11711: local: figlet221.tar.gz remote: figlet221.tar.gz
11712: 502 Unimplemented command.
11713: 227 Entering Passive Mode (195,40,6,41,246,104)
11714: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11715: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11716: 226 Transfer completed.
11717: 172219 bytes received in 00:02 (75.99 KB/s)
11718: 221 Goodbye.
11719: => Checksum OK for figlet221.tar.gz.
11720: ===> Extracting for figlet-2.2.1nb2
11721: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11722: ===> Patching for figlet-2.2.1nb2
11723: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11724: ===> Overriding tools for figlet-2.2.1nb2
11725: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11726: ===> Configuring for figlet-2.2.1nb2
11727: ===> Building for figlet-2.2.1nb2
11728: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11729: chmod a+x figlet
11730: gcc -O2 -o chkfont chkfont.c
11731: => Unwrapping files-to-be-installed.
11732: <code class="prompt">#</code>
11733: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11734: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11735: ===> Installing for figlet-2.2.1nb2
11736: install -d -o root -g wheel -m 755 /usr/pkg/bin
11737: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11738: mkdir -p /usr/pkg/share/figlet
11739: cp figlet /usr/pkg/bin
11740: cp chkfont /usr/pkg/bin
11741: chmod 555 figlist showfigfonts
11742: cp figlist /usr/pkg/bin
11743: cp showfigfonts /usr/pkg/bin
11744: cp fonts/*.flf /usr/pkg/share/figlet
11745: cp fonts/*.flc /usr/pkg/share/figlet
11746: cp figlet.6 /usr/pkg/man/man6
11747: ===> Registering installation for figlet-2.2.1nb2
11748: <code class="prompt">#</code></pre>
11749: </div>
11750: <div class="sect1">
11751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11752: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
11753: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11754: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11755: ===> Packaging figlet-2.2.1nb2
11756: ===> Building binary package for figlet-2.2.1nb2
11757: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11758: Using SrcDir value of /usr/pkg
11759: Registering depends:.
11760: <code class="prompt">#</code></pre>
11761: </div>
11762: </div>
11763: <div class="appendix">
11764: <div class="titlepage"><div><div><h1 class="title">
11765: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
11766: <div class="toc">
11767: <p><b>Table of Contents</b></p>
11768: <dl class="toc">
11769: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11770: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11771: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11772: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11773: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11774: <code class="filename">stable</code>,
11775: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11776: source packages</a></span></dt>
11777: </dl>
11778: </div>
11779: <p>As in other big projects, the directory layout of pkgsrc
11780: is quite complex for newbies. This chapter explains where you
11781: find things on the FTP server. The base directory on
11782: <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>.
11783: On other servers it may be different, but inside this directory,
11784: everything should look the same, no matter on which server you
11785: are. This directory contains some subdirectories, which are
11786: explained below.</p>
11787: <div class="sect1">
11788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11789: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11790: <p>The directory <code class="filename">distfiles</code> contains lots
11791: of archive files from all pkgsrc packages, which are mirrored
11792: here. The subdirectories are called after their package names
11793: and are used when the distributed files have names that don't
11794: explicitly contain a version number or are otherwise too generic
11795: (for example <code class="filename">release.tar.gz</code>).</p>
11796: </div>
11797: <div class="sect1">
11798: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11799: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11800: <p>This directory contains things that individual pkgsrc
11801: developers find worth publishing.</p>
11802: </div>
11803: <div class="sect1">
11804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11805: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11806: <p>This directory contains binary packages for the various
11807: platforms that are supported by pkgsrc.
11808: 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>
11809: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11810: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
11811: operating system for which the packages have been built. The
11812: name is taken from the output of the <span class="command"><strong>uname</strong></span>
11813: command, so it may differ from the one you are used to
11814: hear.</p></li>
11815: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
11816: architecture of the platform for which the packages have been
11817: built. It also includes the <code class="varname">ABI</code> (Application
11818: Binary Interface) for platforms that have several of
11819: them.</p></li>
11820: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
11821: the operating system. For version numbers that change often (for
11822: example NetBSD-current), the often-changing part should be
11823: replaced with an <code class="literal">x</code>, for example
11824: <code class="literal">4.99.x</code>.</p></li>
11825: <li class="listitem"><p><code class="varname">TAG</code> is either
11826: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11827: for a stable branch, or <code class="literal">head</code> for packages
11828: built from the HEAD branch. The latter should only be used when
11829: the packages are updated on a regular basis. Otherwise the date
11830: from checking out pkgsrc should be appended, for example
11831: <code class="literal">head_20071015</code>.</p></li>
11832: </ul></div>
11833: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11834: can quickly click through the directories on the
11835: server and find the best binary packages for their machines. Since they
11836: usually know the operating system and the hardware architecture, OPSYS
11837: and ARCH are placed first. After these choices, they can select the
11838: best combination of OSVERSION and TAG together, since it is usually the
11839: case that packages stay compatible between different version of the
11840: operating system.</p>
11841: <p>In each of these directories, there is a
11842: whole binary packages collection for a specific platform. It has a directory called
11843: <code class="filename">All</code> which contains all binary packages.
11844: Besides that, there are various category directories that
11845: contain symbolic links to the real binary packages.</p>
11846: </div>
11847: <div class="sect1">
11848: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11849: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 11850: <p>Here are the reports from bulk builds, for those who want
11851: to fix packages that didn't build on some of the platforms. The
1.207 leot 11852: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="D.3. packages: Binary packages">Section D.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 11853: </div>
1.41 asau 11854: <div class="sect1">
1.8 rillig 11855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11856: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.148 leot 11857: <code class="filename">stable</code>,
1.22 jakllsch 11858: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11859: source packages</h2></div></div></div>
1.23 wiz 11860: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 11861: that is the files that define how to create binary packages from
11862: source archives.</p>
1.149 leot 11863: <p>Each of the <code class="filename">current</code>,
11864: <code class="filename">stable</code> and
11865: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11866: directories share the same structure. They each contain a
11867: <code class="filename">pkgsrc</code> directory and
11868: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 11869: <p>The directory <code class="filename">pkgsrc</code> contains a
11870: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 11871: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11872: as the directory, ready to be downloaded as a whole.</p>
11873: <p>The <code class="filename">current</code> directory contains files
11874: related to the HEAD branch of the CVS repository.
11875: In this directory there is an additional file called
11876: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11877: all pkgsrc <code class="filename">README</code>s with information about
11878: categories and packages.
11879: </p>
11880: <p>The <code class="filename">stable</code> directory is a symlink to
11881: the latest
11882: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11883: </p>
11884: <p>The
11885: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11886: directories contain files related to the
11887: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11888: stable branch of the CVS repository. In these directories there is
11889: an additional file called
11890: <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 11891: which contains the state of pkgsrc when it was branched.</p>
11892: </div>
11893: </div>
1.41 asau 11894: <div class="appendix">
11895: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 11896: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.154 rillig 11897: <p>
11898: The following list contains all help topics that are available
11899: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11900: </p>
1.156 leot 11901: <table border="0" summary="Simple list" class="simplelist">
11902: <tr>
11903: <td>#!</td>
11904: <td>-lintl</td>
11905: </tr>
11906: <tr>
1.205 wiz 11907: <td>32bit</td>
1.156 leot 11908: <td>64bit</td>
1.205 wiz 11909: </tr>
11910: <tr>
1.156 leot 11911: <td>ABI</td>
1.205 wiz 11912: <td>ACCEPTABLE_LICENSES</td>
1.156 leot 11913: </tr>
11914: <tr>
11915: <td>ACROREAD_FONTPATH</td>
1.205 wiz 11916: <td>ADDITIONAL</td>
1.156 leot 11917: </tr>
11918: <tr>
11919: <td>AFAIK</td>
1.205 wiz 11920: <td>AIX</td>
1.156 leot 11921: </tr>
11922: <tr>
1.243 gutterid 11923: <td>ALLOW_NEWER_COMPILER</td>
1.156 leot 11924: <td>ALLOW_VULNERABLE_PACKAGES</td>
11925: </tr>
11926: <tr>
1.243 gutterid 11927: <td>ALL_ENV</td>
1.200 cirnatda 11928: <td>ALTERNATIVES_SRC</td>
1.241 rillig 11929: </tr>
11930: <tr>
1.243 gutterid 11931: <td>AMANDA_TMP</td>
1.241 rillig 11932: <td>AMANDA_USER</td>
1.238 wiz 11933: </tr>
11934: <tr>
1.243 gutterid 11935: <td>AMANDA_VAR</td>
1.241 rillig 11936: <td>APACHE_GROUP</td>
1.233 wiz 11937: </tr>
11938: <tr>
1.243 gutterid 11939: <td>APACHE_MODULE_NAME</td>
1.241 rillig 11940: <td>APACHE_MODULE_SRC</td>
1.227 wiz 11941: </tr>
11942: <tr>
1.243 gutterid 11943: <td>APACHE_MODULE_SRCDIR</td>
1.241 rillig 11944: <td>APACHE_PKG_PREFIX</td>
1.223 nia 11945: </tr>
11946: <tr>
1.243 gutterid 11947: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.241 rillig 11948: <td>APACHE_SUEXEC_DOCROOT</td>
1.217 rillig 11949: </tr>
11950: <tr>
1.243 gutterid 11951: <td>APACHE_USER</td>
1.241 rillig 11952: <td>APPEND_ABI</td>
1.214 leot 11953: </tr>
11954: <tr>
1.243 gutterid 11955: <td>APPEND_ELF</td>
1.241 rillig 11956: <td>ARLA_CACHE</td>
1.212 wiz 11957: </tr>
11958: <tr>
1.243 gutterid 11959: <td>AUDIT_PACKAGES_FLAGS</td>
1.241 rillig 11960: <td>AUTOCONF_REQD</td>
1.197 leot 11961: </tr>
11962: <tr>
1.243 gutterid 11963: <td>AUTOMAKE_OVERRIDE</td>
1.241 rillig 11964: <td>AUTOMAKE_REQD</td>
1.177 leot 11965: </tr>
11966: <tr>
1.243 gutterid 11967: <td>AUTO_MKDIRS</td>
1.241 rillig 11968: <td>BDB185_DEFAULT</td>
1.161 leot 11969: </tr>
11970: <tr>
1.243 gutterid 11971: <td>BDBBASE</td>
1.241 rillig 11972: <td>BDB_ACCEPTED</td>
1.159 rillig 11973: </tr>
11974: <tr>
1.243 gutterid 11975: <td>BDB_DEFAULT</td>
1.241 rillig 11976: <td>BDB_LIBS</td>
1.156 leot 11977: </tr>
11978: <tr>
1.243 gutterid 11979: <td>BDB_TYPE</td>
1.241 rillig 11980: <td>BINCIMAP_GROUP</td>
1.156 leot 11981: </tr>
11982: <tr>
1.243 gutterid 11983: <td>BINCIMAP_USER</td>
1.241 rillig 11984: <td>BIND_DIR</td>
1.156 leot 11985: </tr>
11986: <tr>
1.243 gutterid 11987: <td>BIND_GROUP</td>
1.241 rillig 11988: <td>BIND_USER</td>
1.156 leot 11989: </tr>
11990: <tr>
1.243 gutterid 11991: <td>BINOWN</td>
1.241 rillig 11992: <td>BINPKG_SITES</td>
1.156 leot 11993: </tr>
11994: <tr>
1.243 gutterid 11995: <td>BIN_INSTALL_FLAGS</td>
1.241 rillig 11996: <td>BISON_PKGDATADIR</td>
1.156 leot 11997: </tr>
11998: <tr>
1.243 gutterid 11999: <td>BLAS</td>
1.241 rillig 12000: <td>BLAS_ACCEPTED</td>
1.156 leot 12001: </tr>
12002: <tr>
1.243 gutterid 12003: <td>BLAS_C_INTERFACE</td>
1.241 rillig 12004: <td>BLAS_INCLUDES</td>
1.156 leot 12005: </tr>
12006: <tr>
1.243 gutterid 12007: <td>BLAS_INDEX64</td>
1.241 rillig 12008: <td>BLAS_LIBS</td>
1.156 leot 12009: </tr>
12010: <tr>
1.243 gutterid 12011: <td>BLAS_PC</td>
1.241 rillig 12012: <td>BLAS_TYPE</td>
1.156 leot 12013: </tr>
12014: <tr>
1.243 gutterid 12015: <td>BOOTSTRAP_DEPENDS</td>
1.241 rillig 12016: <td>BROKEN</td>
1.198 leot 12017: </tr>
12018: <tr>
1.243 gutterid 12019: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.241 rillig 12020: <td>BROKEN_ON_PLATFORM</td>
1.229 gutterid 12021: </tr>
12022: <tr>
1.243 gutterid 12023: <td>BSDSRCDIR</td>
1.241 rillig 12024: <td>BSDXSRCDIR</td>
1.156 leot 12025: </tr>
12026: <tr>
1.243 gutterid 12027: <td>BSD_MAKE_ENV</td>
1.241 rillig 12028: <td>BUILDLINK_AUTO_DIRS</td>
1.156 leot 12029: </tr>
12030: <tr>
1.243 gutterid 12031: <td>BUILDLINK_AUTO_VARS</td>
1.241 rillig 12032: <td>BUILDLINK_CFLAGS</td>
1.189 bacon 12033: </tr>
12034: <tr>
1.243 gutterid 12035: <td>BUILDLINK_CONTENTS_FILTER</td>
1.241 rillig 12036: <td>BUILDLINK_CPPFLAGS</td>
1.156 leot 12037: </tr>
12038: <tr>
1.243 gutterid 12039: <td>BUILDLINK_FILES</td>
1.216 gutterid 12040: <td>BUILDLINK_FILES_CMD</td>
1.205 wiz 12041: </tr>
12042: <tr>
1.243 gutterid 12043: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.216 gutterid 12044: <td>BUILDLINK_LDFLAGS</td>
1.156 leot 12045: </tr>
12046: <tr>
1.243 gutterid 12047: <td>BUILDLINK_LIBS</td>
1.216 gutterid 12048: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.156 leot 12049: </tr>
12050: <tr>
1.243 gutterid 12051: <td>BUILDLINK_PKGNAME</td>
1.216 gutterid 12052: <td>BUILDLINK_PREFIX</td>
1.156 leot 12053: </tr>
12054: <tr>
1.243 gutterid 12055: <td>BUILDLINK_RPATHDIRS</td>
1.216 gutterid 12056: <td>BUILDLINK_TREE</td>
1.156 leot 12057: </tr>
12058: <tr>
1.243 gutterid 12059: <td>BUILD_DEFS</td>
1.216 gutterid 12060: <td>BUILD_DEFS_EFFECTS</td>
1.156 leot 12061: </tr>
12062: <tr>
1.243 gutterid 12063: <td>BUILD_DEPENDS</td>
1.216 gutterid 12064: <td>BUILD_DIRS</td>
1.156 leot 12065: </tr>
12066: <tr>
1.243 gutterid 12067: <td>BUILD_ENV_SHELL</td>
1.216 gutterid 12068: <td>BUILD_MAKE_CMD</td>
1.156 leot 12069: </tr>
12070: <tr>
1.243 gutterid 12071: <td>BUILD_MAKE_FLAGS</td>
1.216 gutterid 12072: <td>BUILD_TARGET</td>
1.156 leot 12073: </tr>
12074: <tr>
1.243 gutterid 12075: <td>BUILTIN_FIND_FILES</td>
1.216 gutterid 12076: <td>BUILTIN_FIND_FILES_VAR</td>
1.156 leot 12077: </tr>
12078: <tr>
1.243 gutterid 12079: <td>BUILTIN_FIND_GREP</td>
1.216 gutterid 12080: <td>BUILTIN_FIND_HEADERS</td>
1.156 leot 12081: </tr>
12082: <tr>
1.243 gutterid 12083: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.216 gutterid 12084: <td>BUILTIN_FIND_PKGCONFIG</td>
1.156 leot 12085: </tr>
12086: <tr>
1.243 gutterid 12087: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.216 gutterid 12088: <td>BUILTIN_PKG</td>
1.195 gutterid 12089: </tr>
12090: <tr>
1.243 gutterid 12091: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.216 gutterid 12092: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.156 leot 12093: </tr>
12094: <tr>
1.243 gutterid 12095: <td>BUILTIN_VERSION_SCRIPT</td>
1.216 gutterid 12096: <td>BUILTIN_X11_TYPE</td>
1.156 leot 12097: </tr>
12098: <tr>
1.243 gutterid 12099: <td>BUILTIN_X11_VERSION</td>
1.216 gutterid 12100: <td>CACTI_GROUP</td>
1.156 leot 12101: </tr>
12102: <tr>
1.243 gutterid 12103: <td>CACTI_USER</td>
1.216 gutterid 12104: <td>CANNA_GROUP</td>
1.156 leot 12105: </tr>
12106: <tr>
1.243 gutterid 12107: <td>CANNA_USER</td>
1.216 gutterid 12108: <td>CAT</td>
1.156 leot 12109: </tr>
12110: <tr>
1.243 gutterid 12111: <td>CBLAS_LIBS</td>
1.229 gutterid 12112: <td>CBLAS_PC</td>
1.156 leot 12113: </tr>
12114: <tr>
1.243 gutterid 12115: <td>CCACHE_BASE</td>
1.189 bacon 12116: <td>CCACHE_DIR</td>
1.156 leot 12117: </tr>
12118: <tr>
1.243 gutterid 12119: <td>CCACHE_LOGFILE</td>
1.189 bacon 12120: <td>CC_VERSION</td>
1.156 leot 12121: </tr>
12122: <tr>
1.243 gutterid 12123: <td>CC_VERSION_STRING</td>
1.189 bacon 12124: <td>CDRECORD_CONF</td>
1.156 leot 12125: </tr>
12126: <tr>
1.243 gutterid 12127: <td>CDROM_PKG_URL_DIR</td>
1.189 bacon 12128: <td>CDROM_PKG_URL_HOST</td>
1.223 nia 12129: </tr>
12130: <tr>
1.243 gutterid 12131: <td>CHANGES</td>
1.226 gutterid 12132: <td>CHECK_COMPILER</td>
1.241 rillig 12133: </tr>
12134: <tr>
1.243 gutterid 12135: <td>CHECK_FAKEHOME</td>
1.241 rillig 12136: <td>CHECK_FILES</td>
1.238 wiz 12137: </tr>
12138: <tr>
1.243 gutterid 12139: <td>CHECK_FILES_SKIP</td>
1.241 rillig 12140: <td>CHECK_FILES_STRICT</td>
1.233 wiz 12141: </tr>
12142: <tr>
1.243 gutterid 12143: <td>CHECK_HEADERS</td>
1.241 rillig 12144: <td>CHECK_HEADERS_SKIP</td>
1.227 wiz 12145: </tr>
12146: <tr>
1.243 gutterid 12147: <td>CHECK_INTERPRETER</td>
1.241 rillig 12148: <td>CHECK_INTERPRETER_SKIP</td>
1.217 rillig 12149: </tr>
12150: <tr>
1.243 gutterid 12151: <td>CHECK_PERMS</td>
1.241 rillig 12152: <td>CHECK_PERMS_AUTOFIX</td>
1.214 leot 12153: </tr>
12154: <tr>
1.243 gutterid 12155: <td>CHECK_PERMS_SKIP</td>
1.241 rillig 12156: <td>CHECK_PIE</td>
1.212 wiz 12157: </tr>
12158: <tr>
1.243 gutterid 12159: <td>CHECK_PIE_SKIP</td>
1.241 rillig 12160: <td>CHECK_PIE_SUPPORTED</td>
1.205 wiz 12161: </tr>
12162: <tr>
1.243 gutterid 12163: <td>CHECK_PORTABILITY</td>
1.241 rillig 12164: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.197 leot 12165: </tr>
12166: <tr>
1.243 gutterid 12167: <td>CHECK_PORTABILITY_SKIP</td>
1.241 rillig 12168: <td>CHECK_RELRO</td>
1.177 leot 12169: </tr>
12170: <tr>
1.243 gutterid 12171: <td>CHECK_RELRO_SKIP</td>
1.241 rillig 12172: <td>CHECK_RELRO_SUPPORTED</td>
1.161 leot 12173: </tr>
12174: <tr>
1.243 gutterid 12175: <td>CHECK_SHLIBS</td>
1.241 rillig 12176: <td>CHECK_SHLIBS_SKIP</td>
1.216 gutterid 12177: </tr>
12178: <tr>
1.243 gutterid 12179: <td>CHECK_SHLIBS_SUPPORTED</td>
1.241 rillig 12180: <td>CHECK_SHLIBS_TOXIC</td>
1.159 rillig 12181: </tr>
12182: <tr>
1.243 gutterid 12183: <td>CHECK_SSP</td>
1.241 rillig 12184: <td>CHECK_SSP_SKIP</td>
1.156 leot 12185: </tr>
12186: <tr>
1.243 gutterid 12187: <td>CHECK_SSP_SUPPORTED</td>
1.241 rillig 12188: <td>CHECK_STRIPPED</td>
1.156 leot 12189: </tr>
12190: <tr>
1.243 gutterid 12191: <td>CHECK_STRIPPED_SKIP</td>
1.241 rillig 12192: <td>CHECK_WRKREF</td>
1.156 leot 12193: </tr>
12194: <tr>
1.243 gutterid 12195: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.241 rillig 12196: <td>CHECK_WRKREF_SKIP</td>
1.156 leot 12197: </tr>
12198: <tr>
1.243 gutterid 12199: <td>CLAMAV_DBDIR</td>
1.241 rillig 12200: <td>CLAMAV_GROUP</td>
1.156 leot 12201: </tr>
12202: <tr>
1.243 gutterid 12203: <td>CLAMAV_USER</td>
1.241 rillig 12204: <td>CLANGBASE</td>
1.156 leot 12205: </tr>
12206: <tr>
1.243 gutterid 12207: <td>CLEANDEPENDS</td>
1.241 rillig 12208: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156 leot 12209: </tr>
12210: <tr>
1.243 gutterid 12211: <td>CMAKE_INSTALL_NAME_DIR</td>
1.241 rillig 12212: <td>CMAKE_INSTALL_PREFIX</td>
1.156 leot 12213: </tr>
12214: <tr>
1.243 gutterid 12215: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.241 rillig 12216: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.156 leot 12217: </tr>
12218: <tr>
1.243 gutterid 12219: <td>CMAKE_PREFIX_PATH</td>
1.241 rillig 12220: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.156 leot 12221: </tr>
12222: <tr>
1.243 gutterid 12223: <td>COMPILER_RPATH_FLAG</td>
1.226 gutterid 12224: <td>COMPILER_USE_SYMLINKS</td>
1.156 leot 12225: </tr>
12226: <tr>
1.243 gutterid 12227: <td>CONFIGURE_ARGS</td>
1.226 gutterid 12228: <td>CONFIGURE_DIRS</td>
1.156 leot 12229: </tr>
12230: <tr>
1.243 gutterid 12231: <td>CONFIGURE_ENV</td>
1.226 gutterid 12232: <td>CONFIGURE_ENV_SHELL</td>
1.156 leot 12233: </tr>
12234: <tr>
1.243 gutterid 12235: <td>CONFIGURE_HAS_INFODIR</td>
1.226 gutterid 12236: <td>CONFIGURE_HAS_MANDIR</td>
1.156 leot 12237: </tr>
12238: <tr>
1.243 gutterid 12239: <td>CONFIGURE_SCRIPT</td>
1.226 gutterid 12240: <td>CONFIG_SHELL</td>
1.156 leot 12241: </tr>
12242: <tr>
1.243 gutterid 12243: <td>CONFIG_SHELL_FLAGS</td>
1.226 gutterid 12244: <td>CONF_FILES</td>
1.156 leot 12245: </tr>
12246: <tr>
1.243 gutterid 12247: <td>CONF_FILES_MODE</td>
1.226 gutterid 12248: <td>CONF_FILES_PERMS</td>
1.156 leot 12249: </tr>
12250: <tr>
1.243 gutterid 12251: <td>CONSERVER_DEFAULTHOST</td>
1.226 gutterid 12252: <td>CONSERVER_DEFAULTPORT</td>
1.156 leot 12253: </tr>
12254: <tr>
1.243 gutterid 12255: <td>CP</td>
1.232 gutterid 12256: <td>CPE</td>
12257: </tr>
12258: <tr>
1.243 gutterid 12259: <td>CPE_EDITION</td>
1.232 gutterid 12260: <td>CPE_LANG</td>
12261: </tr>
12262: <tr>
1.243 gutterid 12263: <td>CPE_OTHER</td>
1.232 gutterid 12264: <td>CPE_PART</td>
12265: </tr>
12266: <tr>
1.243 gutterid 12267: <td>CPE_PRODUCT</td>
1.232 gutterid 12268: <td>CPE_SW_EDITION</td>
12269: </tr>
12270: <tr>
1.243 gutterid 12271: <td>CPE_TARGET_HW</td>
1.232 gutterid 12272: <td>CPE_TARGET_SW</td>
12273: </tr>
12274: <tr>
1.243 gutterid 12275: <td>CPE_UPDATE</td>
1.232 gutterid 12276: <td>CPE_URI</td>
12277: </tr>
12278: <tr>
1.243 gutterid 12279: <td>CPE_VENDOR</td>
1.232 gutterid 12280: <td>CPE_VERSION</td>
1.156 leot 12281: </tr>
12282: <tr>
1.243 gutterid 12283: <td>CPP</td>
1.232 gutterid 12284: <td>CPP_PRECOMP_FLAGS</td>
1.156 leot 12285: </tr>
12286: <tr>
1.243 gutterid 12287: <td>CREATE_WRKDIR_SYMLINK</td>
1.232 gutterid 12288: <td>CROSSBASE</td>
1.156 leot 12289: </tr>
12290: <tr>
1.243 gutterid 12291: <td>CTFCONVERT</td>
1.232 gutterid 12292: <td>CTF_FILES_SKIP</td>
1.156 leot 12293: </tr>
12294: <tr>
1.243 gutterid 12295: <td>CTF_SUPPORTED</td>
1.232 gutterid 12296: <td>CTYPE</td>
1.156 leot 12297: </tr>
12298: <tr>
1.243 gutterid 12299: <td>CUPS_GROUP</td>
1.232 gutterid 12300: <td>CUPS_SYSTEM_GROUPS</td>
1.177 leot 12301: </tr>
12302: <tr>
1.243 gutterid 12303: <td>CUPS_USER</td>
1.232 gutterid 12304: <td>CURSES_DEFAULT</td>
1.227 wiz 12305: </tr>
12306: <tr>
1.243 gutterid 12307: <td>CURSES_TYPE</td>
1.232 gutterid 12308: <td>CXX</td>
1.238 wiz 12309: </tr>
12310: <tr>
1.243 gutterid 12311: <td>CYRUS_GROUP</td>
1.238 wiz 12312: <td>CYRUS_IDLE</td>
1.233 wiz 12313: </tr>
12314: <tr>
1.243 gutterid 12315: <td>CYRUS_USER</td>
1.238 wiz 12316: <td>DAEMONTOOLS_GROUP</td>
1.217 rillig 12317: </tr>
12318: <tr>
1.243 gutterid 12319: <td>DAEMONTOOLS_LOG_USER</td>
1.238 wiz 12320: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.214 leot 12321: </tr>
12322: <tr>
1.243 gutterid 12323: <td>DARWIN_REQUIRES_FILTER</td>
1.238 wiz 12324: <td>DBUS_GROUP</td>
1.212 wiz 12325: </tr>
12326: <tr>
1.243 gutterid 12327: <td>DBUS_USER</td>
1.238 wiz 12328: <td>DEFANG_GROUP</td>
1.205 wiz 12329: </tr>
12330: <tr>
1.243 gutterid 12331: <td>DEFANG_USER</td>
1.238 wiz 12332: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.197 leot 12333: </tr>
12334: <tr>
1.243 gutterid 12335: <td>DEFAULT_DISTFILES</td>
1.238 wiz 12336: <td>DEFAULT_IRC_SERVER</td>
1.159 rillig 12337: </tr>
12338: <tr>
1.243 gutterid 12339: <td>DEFAULT_SERIAL_DEVICE</td>
1.238 wiz 12340: <td>DEF_UMASK</td>
1.156 leot 12341: </tr>
12342: <tr>
1.243 gutterid 12343: <td>DEINSTALLDEPENDS</td>
1.238 wiz 12344: <td>DEINSTALL_SRC</td>
1.156 leot 12345: </tr>
12346: <tr>
1.243 gutterid 12347: <td>DEINSTALL_TEMPLATES</td>
1.238 wiz 12348: <td>DELAYED_ERROR_MSG</td>
1.195 gutterid 12349: </tr>
12350: <tr>
1.243 gutterid 12351: <td>DELAYED_WARNING_MSG</td>
1.238 wiz 12352: <td>DEPENDS</td>
1.156 leot 12353: </tr>
12354: <tr>
1.243 gutterid 12355: <td>DEPENDS_TARGET</td>
1.238 wiz 12356: <td>DEPENDS_TYPE</td>
1.156 leot 12357: </tr>
12358: <tr>
1.243 gutterid 12359: <td>DESTDIR</td>
1.238 wiz 12360: <td>DESTDIR_VARNAME</td>
1.156 leot 12361: </tr>
12362: <tr>
1.243 gutterid 12363: <td>DIALER_GROUP</td>
1.238 wiz 12364: <td>DIGEST_REQD</td>
1.156 leot 12365: </tr>
12366: <tr>
1.243 gutterid 12367: <td>DISTDIR</td>
1.238 wiz 12368: <td>DISTFILES</td>
1.156 leot 12369: </tr>
12370: <tr>
1.243 gutterid 12371: <td>DISTINFO_FILE</td>
1.238 wiz 12372: <td>DISTNAME</td>
1.156 leot 12373: </tr>
12374: <tr>
1.243 gutterid 12375: <td>DIST_PATH</td>
1.238 wiz 12376: <td>DIST_SUBDIR</td>
1.156 leot 12377: </tr>
12378: <tr>
1.243 gutterid 12379: <td>DJBDNS_AXFR_USER</td>
1.238 wiz 12380: <td>DJBDNS_CACHE_USER</td>
1.156 leot 12381: </tr>
12382: <tr>
1.243 gutterid 12383: <td>DJBDNS_DJBDNS_GROUP</td>
1.238 wiz 12384: <td>DJBDNS_LOG_USER</td>
1.156 leot 12385: </tr>
12386: <tr>
1.243 gutterid 12387: <td>DJBDNS_RBL_USER</td>
1.238 wiz 12388: <td>DJBDNS_TINY_USER</td>
1.156 leot 12389: </tr>
12390: <tr>
1.243 gutterid 12391: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.238 wiz 12392: <td>DL_AUTO_VARS</td>
1.156 leot 12393: </tr>
12394: <tr>
1.243 gutterid 12395: <td>DL_CFLAGS</td>
1.238 wiz 12396: <td>DL_LDFLAGS</td>
1.156 leot 12397: </tr>
12398: <tr>
1.243 gutterid 12399: <td>DL_LIBS</td>
1.238 wiz 12400: <td>DNS</td>
1.156 leot 12401: </tr>
12402: <tr>
1.243 gutterid 12403: <td>DOCOWN</td>
1.238 wiz 12404: <td>DOWNLOADED_DISTFILE</td>
1.156 leot 12405: </tr>
12406: <tr>
1.243 gutterid 12407: <td>DQCACHE_GROUP</td>
1.238 wiz 12408: <td>DQCACHE_USER</td>
1.156 leot 12409: </tr>
12410: <tr>
1.243 gutterid 12411: <td>DT_LAYOUT</td>
1.238 wiz 12412: <td>DYNAMIC_SITES_CMD</td>
1.156 leot 12413: </tr>
12414: <tr>
1.243 gutterid 12415: <td>DYNAMIC_SITES_SCRIPT</td>
1.238 wiz 12416: <td>ECHO</td>
1.243 gutterid 12417: </tr>
12418: <tr>
1.242 gutterid 12419: <td>ECHO_N</td>
1.243 gutterid 12420: <td>ELK_GUI</td>
1.218 nia 12421: </tr>
12422: <tr>
1.242 gutterid 12423: <td>EMACS_TYPE</td>
1.243 gutterid 12424: <td>EMULDIR</td>
1.156 leot 12425: </tr>
12426: <tr>
1.242 gutterid 12427: <td>EMULSUBDIR</td>
1.243 gutterid 12428: <td>EMULSUBDIRSLASH</td>
1.156 leot 12429: </tr>
12430: <tr>
1.242 gutterid 12431: <td>EMUL_ARCH</td>
1.243 gutterid 12432: <td>EMUL_DISTRO</td>
1.156 leot 12433: </tr>
12434: <tr>
1.242 gutterid 12435: <td>EMUL_EXEC_FMT</td>
1.243 gutterid 12436: <td>EMUL_IS_NATIVE</td>
1.156 leot 12437: </tr>
12438: <tr>
1.242 gutterid 12439: <td>EMUL_MODULES</td>
1.243 gutterid 12440: <td>EMUL_OPSYS</td>
1.156 leot 12441: </tr>
12442: <tr>
1.242 gutterid 12443: <td>EMUL_PKG_FMT</td>
1.243 gutterid 12444: <td>EMUL_PLATFORM</td>
1.156 leot 12445: </tr>
12446: <tr>
1.242 gutterid 12447: <td>EMUL_PLATFORMS</td>
1.243 gutterid 12448: <td>EMUL_PREFER</td>
1.156 leot 12449: </tr>
12450: <tr>
1.242 gutterid 12451: <td>EMUL_REQD</td>
1.243 gutterid 12452: <td>EMUL_TYPE</td>
1.156 leot 12453: </tr>
12454: <tr>
1.242 gutterid 12455: <td>ERROR_MSG</td>
1.243 gutterid 12456: <td>EXIM_GROUP</td>
1.156 leot 12457: </tr>
12458: <tr>
1.242 gutterid 12459: <td>EXIM_USER</td>
1.243 gutterid 12460: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.156 leot 12461: </tr>
12462: <tr>
1.242 gutterid 12463: <td>EXTRACTOR</td>
1.243 gutterid 12464: <td>EXTRACT_CMD</td>
1.156 leot 12465: </tr>
12466: <tr>
1.242 gutterid 12467: <td>EXTRACT_CMD_DEFAULT</td>
1.243 gutterid 12468: <td>EXTRACT_DIR</td>
1.156 leot 12469: </tr>
12470: <tr>
1.242 gutterid 12471: <td>EXTRACT_ELEMENTS</td>
1.243 gutterid 12472: <td>EXTRACT_ENV</td>
1.156 leot 12473: </tr>
12474: <tr>
1.242 gutterid 12475: <td>EXTRACT_ONLY</td>
1.243 gutterid 12476: <td>EXTRACT_OPTS</td>
1.223 nia 12477: </tr>
12478: <tr>
1.242 gutterid 12479: <td>EXTRACT_SUFX</td>
1.243 gutterid 12480: <td>EXTRACT_USING</td>
1.156 leot 12481: </tr>
12482: <tr>
1.242 gutterid 12483: <td>FAIL</td>
1.243 gutterid 12484: <td>FAILOVER_FETCH</td>
1.156 leot 12485: </tr>
12486: <tr>
1.242 gutterid 12487: <td>FAIL_MSG</td>
1.243 gutterid 12488: <td>FAKE_NCURSES</td>
1.156 leot 12489: </tr>
12490: <tr>
1.242 gutterid 12491: <td>FAM</td>
1.243 gutterid 12492: <td>FAM_ACCEPTED</td>
1.156 leot 12493: </tr>
12494: <tr>
1.242 gutterid 12495: <td>FAM_DEFAULT</td>
1.243 gutterid 12496: <td>FAM_SERVER</td>
1.156 leot 12497: </tr>
12498: <tr>
1.242 gutterid 12499: <td>FCPATH</td>
1.243 gutterid 12500: <td>FEATURE_CPPFLAGS</td>
1.156 leot 12501: </tr>
12502: <tr>
1.242 gutterid 12503: <td>FEATURE_LDFLAGS</td>
1.243 gutterid 12504: <td>FEATURE_LIBS</td>
1.156 leot 12505: </tr>
12506: <tr>
1.242 gutterid 12507: <td>FETCH_AFTER_ARGS</td>
1.243 gutterid 12508: <td>FETCH_BEFORE_ARGS</td>
1.156 leot 12509: </tr>
12510: <tr>
1.242 gutterid 12511: <td>FETCH_CMD</td>
1.243 gutterid 12512: <td>FETCH_OUTPUT_ARGS</td>
1.156 leot 12513: </tr>
12514: <tr>
1.242 gutterid 12515: <td>FETCH_PROXY</td>
1.243 gutterid 12516: <td>FETCH_RESUME_ARGS</td>
1.177 leot 12517: </tr>
12518: <tr>
1.242 gutterid 12519: <td>FETCH_TIMEOUT</td>
1.243 gutterid 12520: <td>FETCH_USE_IPV4_ONLY</td>
1.241 rillig 12521: </tr>
12522: <tr>
1.242 gutterid 12523: <td>FETCH_USING</td>
1.243 gutterid 12524: <td>FILES_SUBST</td>
1.156 leot 12525: </tr>
12526: <tr>
1.242 gutterid 12527: <td>FILES_SUBST_SED</td>
1.243 gutterid 12528: <td>FIX_SYSTEM_HEADERS</td>
1.156 leot 12529: </tr>
12530: <tr>
1.226 gutterid 12531: <td>FONTS_DIRS</td>
1.243 gutterid 12532: <td>FONTS_VERBOSE</td>
1.177 leot 12533: </tr>
12534: <tr>
1.226 gutterid 12535: <td>FOO_HACKS_MK</td>
1.244 gutterid 12536: <td>FORCE_CXX_STD</td>
12537: </tr>
12538: <tr>
12539: <td>FORCE_C_STD</td>
1.243 gutterid 12540: <td>FOX_USE_XUNICODE</td>
1.156 leot 12541: </tr>
12542: <tr>
1.226 gutterid 12543: <td>FREEWNN_GROUP</td>
1.243 gutterid 12544: <td>FREEWNN_USER</td>
1.156 leot 12545: </tr>
12546: <tr>
1.226 gutterid 12547: <td>FTP_PKG_URL_DIR</td>
1.243 gutterid 12548: <td>FTP_PKG_URL_HOST</td>
1.156 leot 12549: </tr>
12550: <tr>
1.226 gutterid 12551: <td>GAMEDATAMODE</td>
1.243 gutterid 12552: <td>GAMEDATA_PERMS</td>
1.156 leot 12553: </tr>
12554: <tr>
1.226 gutterid 12555: <td>GAMEDIRMODE</td>
1.243 gutterid 12556: <td>GAMEDIR_PERMS</td>
1.156 leot 12557: </tr>
12558: <tr>
1.226 gutterid 12559: <td>GAMEGRP</td>
1.243 gutterid 12560: <td>GAMEMODE</td>
1.156 leot 12561: </tr>
12562: <tr>
1.226 gutterid 12563: <td>GAMEOWN</td>
1.243 gutterid 12564: <td>GAMES_GROUP</td>
1.156 leot 12565: </tr>
12566: <tr>
1.226 gutterid 12567: <td>GAMES_USER</td>
1.243 gutterid 12568: <td>GCC</td>
1.156 leot 12569: </tr>
12570: <tr>
1.226 gutterid 12571: <td>GCCBASE</td>
1.243 gutterid 12572: <td>GCC_REQD</td>
1.156 leot 12573: </tr>
12574: <tr>
1.226 gutterid 12575: <td>GCC_VERSION_SUFFIX</td>
1.243 gutterid 12576: <td>GEM_BUILD</td>
1.156 leot 12577: </tr>
12578: <tr>
1.226 gutterid 12579: <td>GEM_CLEANBUILD</td>
1.243 gutterid 12580: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.156 leot 12581: </tr>
12582: <tr>
1.226 gutterid 12583: <td>GEM_DOCDIR</td>
1.243 gutterid 12584: <td>GEM_EXTSDIR</td>
1.177 leot 12585: </tr>
12586: <tr>
1.226 gutterid 12587: <td>GEM_HOME</td>
1.243 gutterid 12588: <td>GEM_KEEPBUILD</td>
1.156 leot 12589: </tr>
12590: <tr>
1.226 gutterid 12591: <td>GEM_LIBDIR</td>
1.243 gutterid 12592: <td>GEM_NAME</td>
1.156 leot 12593: </tr>
12594: <tr>
1.226 gutterid 12595: <td>GEM_PATH</td>
1.243 gutterid 12596: <td>GEM_PLUGINSDIR</td>
1.198 leot 12597: </tr>
12598: <tr>
1.226 gutterid 12599: <td>GEM_SPECFILE</td>
1.243 gutterid 12600: <td>GENERATE_PLIST</td>
1.156 leot 12601: </tr>
12602: <tr>
1.226 gutterid 12603: <td>GHC</td>
1.243 gutterid 12604: <td>GHOSTSCRIPT_REQD</td>
1.156 leot 12605: </tr>
12606: <tr>
1.226 gutterid 12607: <td>GITHUB_PROJECT</td>
1.243 gutterid 12608: <td>GITHUB_RELEASE</td>
1.177 leot 12609: </tr>
12610: <tr>
1.226 gutterid 12611: <td>GITHUB_SUBMODULES</td>
1.243 gutterid 12612: <td>GITHUB_TAG</td>
1.159 rillig 12613: </tr>
12614: <tr>
1.226 gutterid 12615: <td>GITHUB_TYPE</td>
1.243 gutterid 12616: <td>GITLAB_PROJECT</td>
1.223 nia 12617: </tr>
12618: <tr>
1.226 gutterid 12619: <td>GITLAB_RELEASE</td>
1.243 gutterid 12620: <td>GITLAB_SUBMODULES</td>
1.223 nia 12621: </tr>
12622: <tr>
1.226 gutterid 12623: <td>GITLAB_TAG</td>
1.243 gutterid 12624: <td>GITLAB_TYPE</td>
1.223 nia 12625: </tr>
12626: <tr>
1.242 gutterid 12627: <td>GNU</td>
1.243 gutterid 12628: <td>GNU_CONFIGURE</td>
1.241 rillig 12629: </tr>
12630: <tr>
1.242 gutterid 12631: <td>GNU_CONFIGURE_INFODIR</td>
1.243 gutterid 12632: <td>GNU_CONFIGURE_MANDIR</td>
1.233 wiz 12633: </tr>
12634: <tr>
1.242 gutterid 12635: <td>GNU_CONFIGURE_QUIET</td>
1.243 gutterid 12636: <td>GNU_CONFIGURE_STRICT</td>
1.156 leot 12637: </tr>
12638: <tr>
1.242 gutterid 12639: <td>GODEP_REDIRECTS</td>
1.243 gutterid 12640: <td>GO_BUILD_PATTERN</td>
1.156 leot 12641: </tr>
12642: <tr>
1.242 gutterid 12643: <td>GO_DEPS</td>
1.243 gutterid 12644: <td>GO_DIST_BASE</td>
1.156 leot 12645: </tr>
12646: <tr>
1.242 gutterid 12647: <td>GO_EXTRA_MOD_DIRS</td>
1.243 gutterid 12648: <td>GO_MODULE_FILES</td>
1.238 wiz 12649: </tr>
12650: <tr>
1.242 gutterid 12651: <td>GO_SRCPATH</td>
1.243 gutterid 12652: <td>GROUP_SPECIFIC_PKGS</td>
1.156 leot 12653: </tr>
12654: <tr>
1.242 gutterid 12655: <td>GRUB_NETWORK_CARDS</td>
1.243 gutterid 12656: <td>GRUB_PRESET_COMMAND</td>
1.156 leot 12657: </tr>
12658: <tr>
1.242 gutterid 12659: <td>GRUB_SCAN_ARGS</td>
1.243 gutterid 12660: <td>GZIP</td>
1.156 leot 12661: </tr>
12662: <tr>
1.233 wiz 12663: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.243 gutterid 12664: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.217 rillig 12665: </tr>
12666: <tr>
1.222 gutterid 12667: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.243 gutterid 12668: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.226 gutterid 12669: </tr>
12670: <tr>
1.236 gutterid 12671: <td>HASKELL_ENABLE_TESTS</td>
1.243 gutterid 12672: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.220 nia 12673: </tr>
12674: <tr>
1.232 gutterid 12675: <td>HASKELL_PKG_NAME</td>
1.243 gutterid 12676: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.229 gutterid 12677: </tr>
12678: <tr>
1.226 gutterid 12679: <td>HEADER_TEMPLATES</td>
1.243 gutterid 12680: <td>HOMEPAGE</td>
1.214 leot 12681: </tr>
12682: <tr>
1.242 gutterid 12683: <td>HOST_PKGTOOLS_ARGS</td>
1.243 gutterid 12684: <td>HOST_SPECIFIC_PKGS</td>
1.241 rillig 12685: </tr>
12686: <tr>
1.242 gutterid 12687: <td>HOWL_GROUP</td>
1.243 gutterid 12688: <td>HOWL_USER</td>
1.233 wiz 12689: </tr>
12690: <tr>
1.242 gutterid 12691: <td>ICCBASE</td>
1.243 gutterid 12692: <td>ICECAST_CHROOTDIR</td>
1.227 wiz 12693: </tr>
12694: <tr>
1.242 gutterid 12695: <td>ICON_THEMES</td>
1.243 gutterid 12696: <td>IDOBASE</td>
1.223 nia 12697: </tr>
12698: <tr>
1.242 gutterid 12699: <td>IGNORE_CCACHE</td>
1.243 gutterid 12700: <td>IGNORE_INFO_DIRS</td>
1.156 leot 12701: </tr>
12702: <tr>
1.242 gutterid 12703: <td>IGNORE_INTERACTIVE_FETCH</td>
1.243 gutterid 12704: <td>IMAKE</td>
1.156 leot 12705: </tr>
12706: <tr>
1.242 gutterid 12707: <td>IMAKEOPTS</td>
1.243 gutterid 12708: <td>IMAKE_MAKE</td>
1.191 bacon 12709: </tr>
12710: <tr>
1.242 gutterid 12711: <td>IMAKE_MANINSTALL</td>
1.243 gutterid 12712: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.156 leot 12713: </tr>
12714: <tr>
1.242 gutterid 12715: <td>IMDICTDIR</td>
1.243 gutterid 12716: <td>INCOMPAT_CURSES</td>
1.156 leot 12717: </tr>
12718: <tr>
1.242 gutterid 12719: <td>INFO_DIR</td>
1.243 gutterid 12720: <td>INFO_FILES</td>
1.156 leot 12721: </tr>
12722: <tr>
1.240 gutterid 12723: <td>INFO_MSG</td>
1.243 gutterid 12724: <td>INIT_SYSTEM</td>
1.156 leot 12725: </tr>
12726: <tr>
1.240 gutterid 12727: <td>INN_DATA_DIR</td>
1.243 gutterid 12728: <td>INN_GROUP</td>
1.156 leot 12729: </tr>
12730: <tr>
1.240 gutterid 12731: <td>INN_USER</td>
1.243 gutterid 12732: <td>INSTALLATION_DIRS</td>
1.156 leot 12733: </tr>
12734: <tr>
1.240 gutterid 12735: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.243 gutterid 12736: <td>INSTALL_ENV</td>
1.156 leot 12737: </tr>
12738: <tr>
1.240 gutterid 12739: <td>INSTALL_SH_OVERRIDE</td>
1.243 gutterid 12740: <td>INSTALL_SRC</td>
1.156 leot 12741: </tr>
12742: <tr>
1.240 gutterid 12743: <td>INSTALL_TEMPLATES</td>
1.243 gutterid 12744: <td>INSTALL_UNSTRIPPED</td>
1.172 rillig 12745: </tr>
12746: <tr>
1.240 gutterid 12747: <td>IRCD_HYBRID_IRC_GROUP</td>
1.243 gutterid 12748: <td>IRCD_HYBRID_IRC_USER</td>
1.156 leot 12749: </tr>
12750: <tr>
1.240 gutterid 12751: <td>IRCD_HYBRID_MAXCONN</td>
1.243 gutterid 12752: <td>IRCD_HYBRID_NICLEN</td>
1.156 leot 12753: </tr>
12754: <tr>
1.240 gutterid 12755: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.243 gutterid 12756: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.156 leot 12757: </tr>
12758: <tr>
1.240 gutterid 12759: <td>IRCD_HYBRID_TOPICLEN</td>
1.243 gutterid 12760: <td>IRIX</td>
1.156 leot 12761: </tr>
12762: <tr>
1.240 gutterid 12763: <td>IRRD_USE_PGP</td>
1.243 gutterid 12764: <td>JABBERD_GROUP</td>
1.156 leot 12765: </tr>
12766: <tr>
1.240 gutterid 12767: <td>JABBERD_LOGDIR</td>
1.243 gutterid 12768: <td>JABBERD_PIDDIR</td>
1.156 leot 12769: </tr>
12770: <tr>
1.240 gutterid 12771: <td>JABBERD_SPOOLDIR</td>
1.243 gutterid 12772: <td>JABBERD_USER</td>
1.156 leot 12773: </tr>
12774: <tr>
1.240 gutterid 12775: <td>JAVA_BINPREFIX</td>
1.243 gutterid 12776: <td>JAVA_CLASSPATH</td>
1.156 leot 12777: </tr>
12778: <tr>
1.240 gutterid 12779: <td>JAVA_HOME</td>
1.243 gutterid 12780: <td>JAVA_LD_LIBRARY_PATH</td>
1.233 wiz 12781: </tr>
12782: <tr>
1.240 gutterid 12783: <td>JAVA_NAME</td>
1.243 gutterid 12784: <td>JAVA_UNLIMIT</td>
1.156 leot 12785: </tr>
12786: <tr>
1.240 gutterid 12787: <td>JAVA_WRAPPERS</td>
1.243 gutterid 12788: <td>JPEG_ACCEPTED</td>
1.227 wiz 12789: </tr>
12790: <tr>
1.240 gutterid 12791: <td>JPEG_DEFAULT</td>
1.243 gutterid 12792: <td>KERBEROS</td>
1.177 leot 12793: </tr>
12794: <tr>
1.240 gutterid 12795: <td>KERMIT_SUID_UUCP</td>
1.243 gutterid 12796: <td>KJS_USE_PCRE</td>
1.156 leot 12797: </tr>
12798: <tr>
1.240 gutterid 12799: <td>KNEWS_DOMAIN_FILE</td>
1.243 gutterid 12800: <td>KNEWS_DOMAIN_NAME</td>
1.217 rillig 12801: </tr>
12802: <tr>
1.240 gutterid 12803: <td>KRB5_ACCEPTED</td>
1.243 gutterid 12804: <td>KRB5_DEFAULT</td>
1.156 leot 12805: </tr>
12806: <tr>
1.240 gutterid 12807: <td>LANGUAGES</td>
1.243 gutterid 12808: <td>LAPACKE_LIBS</td>
1.156 leot 12809: </tr>
12810: <tr>
1.240 gutterid 12811: <td>LAPACKE_PC</td>
1.243 gutterid 12812: <td>LAPACK_LIBS</td>
1.156 leot 12813: </tr>
12814: <tr>
1.240 gutterid 12815: <td>LAPACK_PC</td>
1.243 gutterid 12816: <td>LATEX2HTML_ICONPATH</td>
1.156 leot 12817: </tr>
12818: <tr>
1.240 gutterid 12819: <td>LDCONFIG_ADD_CMD</td>
1.243 gutterid 12820: <td>LDCONFIG_REMOVE_CMD</td>
1.156 leot 12821: </tr>
12822: <tr>
1.240 gutterid 12823: <td>LDD</td>
1.243 gutterid 12824: <td>LEAFNODE_DATA_DIR</td>
1.177 leot 12825: </tr>
12826: <tr>
1.240 gutterid 12827: <td>LEAFNODE_GROUP</td>
1.243 gutterid 12828: <td>LEAFNODE_USER</td>
1.156 leot 12829: </tr>
12830: <tr>
1.240 gutterid 12831: <td>LIBDVDCSS_HOMEPAGE</td>
1.243 gutterid 12832: <td>LIBDVDCSS_MASTER_SITES</td>
1.156 leot 12833: </tr>
12834: <tr>
1.244 gutterid 12835: <td>LIBIMAGEQUANT_TYPE</td>
1.240 gutterid 12836: <td>LIBRSVG_TYPE</td>
1.156 leot 12837: </tr>
12838: <tr>
1.244 gutterid 12839: <td>LIBTOOL</td>
1.240 gutterid 12840: <td>LIBTOOLIZE_PLIST</td>
1.156 leot 12841: </tr>
12842: <tr>
1.244 gutterid 12843: <td>LIBTOOL_M4_OVERRIDE</td>
1.240 gutterid 12844: <td>LIBUSB_TYPE</td>
1.205 wiz 12845: </tr>
12846: <tr>
1.244 gutterid 12847: <td>LICENSE</td>
1.240 gutterid 12848: <td>LINKER_RPATH_FLAG</td>
1.157 leot 12849: </tr>
12850: <tr>
1.244 gutterid 12851: <td>LINK_RPATH_FLAG</td>
1.242 gutterid 12852: <td>LINUX_LOCALES</td>
1.241 rillig 12853: </tr>
12854: <tr>
1.244 gutterid 12855: <td>LOCALBASE</td>
1.242 gutterid 12856: <td>LOCALBASE_LOCKTYPE</td>
1.156 leot 12857: </tr>
12858: <tr>
1.244 gutterid 12859: <td>LOCALPATCHES</td>
1.242 gutterid 12860: <td>LOVE_DATA</td>
1.238 wiz 12861: </tr>
12862: <tr>
1.244 gutterid 12863: <td>LOVE_GAME</td>
1.242 gutterid 12864: <td>LOVE_VERSION</td>
1.223 nia 12865: </tr>
12866: <tr>
1.244 gutterid 12867: <td>LP32PLATFORMS</td>
1.242 gutterid 12868: <td>LP64PLATFORMS</td>
1.177 leot 12869: </tr>
12870: <tr>
1.244 gutterid 12871: <td>LUA_BUSTED_ARGS</td>
1.242 gutterid 12872: <td>LUA_CDIR</td>
1.214 leot 12873: </tr>
12874: <tr>
1.244 gutterid 12875: <td>LUA_COMPILER</td>
1.242 gutterid 12876: <td>LUA_DOCDIR</td>
1.197 leot 12877: </tr>
12878: <tr>
1.244 gutterid 12879: <td>LUA_EXAMPLESDIR</td>
1.242 gutterid 12880: <td>LUA_INCDIR</td>
1.156 leot 12881: </tr>
12882: <tr>
1.244 gutterid 12883: <td>LUA_INTERPRETER</td>
1.242 gutterid 12884: <td>LUA_LDIR</td>
1.156 leot 12885: </tr>
12886: <tr>
1.244 gutterid 12887: <td>LUA_LINKER_MAGIC</td>
1.242 gutterid 12888: <td>LUA_PKGPREFIX</td>
1.221 nia 12889: </tr>
12890: <tr>
1.244 gutterid 12891: <td>LUA_SELF_CONFLICT</td>
1.242 gutterid 12892: <td>LUA_USE_BUSTED</td>
1.218 nia 12893: </tr>
12894: <tr>
1.244 gutterid 12895: <td>LUA_VERSIONS_ACCEPTED</td>
1.242 gutterid 12896: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.218 nia 12897: </tr>
12898: <tr>
1.244 gutterid 12899: <td>LUA_VERSION_DEFAULT</td>
1.242 gutterid 12900: <td>LUA_VERSION_REQD</td>
1.218 nia 12901: </tr>
12902: <tr>
1.244 gutterid 12903: <td>Lua</td>
1.242 gutterid 12904: <td>MACHINE_PLATFORM</td>
1.218 nia 12905: </tr>
12906: <tr>
1.244 gutterid 12907: <td>MAILAGENT_DOMAIN</td>
1.242 gutterid 12908: <td>MAILAGENT_EMAIL</td>
1.218 nia 12909: </tr>
12910: <tr>
1.244 gutterid 12911: <td>MAILAGENT_FQDN</td>
1.242 gutterid 12912: <td>MAILAGENT_ORGANIZATION</td>
1.218 nia 12913: </tr>
12914: <tr>
1.244 gutterid 12915: <td>MAJORDOMO_HOMEDIR</td>
1.240 gutterid 12916: <td>MAKEINFO_ARGS</td>
1.205 wiz 12917: </tr>
12918: <tr>
1.244 gutterid 12919: <td>MAKE_DIRS</td>
1.240 gutterid 12920: <td>MAKE_DIRS_PERMS</td>
1.233 wiz 12921: </tr>
12922: <tr>
1.244 gutterid 12923: <td>MAKE_ENV</td>
1.240 gutterid 12924: <td>MAKE_FILE</td>
1.227 wiz 12925: </tr>
12926: <tr>
1.244 gutterid 12927: <td>MAKE_FLAGS</td>
1.240 gutterid 12928: <td>MAKE_JOBS</td>
1.156 leot 12929: </tr>
12930: <tr>
1.244 gutterid 12931: <td>MAKE_JOBS_SAFE</td>
1.240 gutterid 12932: <td>MAKE_PROGRAM</td>
1.212 wiz 12933: </tr>
12934: <tr>
1.244 gutterid 12935: <td>MANCOMPRESSED_IF_MANZ</td>
1.240 gutterid 12936: <td>MANINSTALL</td>
1.156 leot 12937: </tr>
12938: <tr>
1.244 gutterid 12939: <td>MANZ</td>
1.243 gutterid 12940: <td>MARIADB_VERSIONS_ALL</td>
1.156 leot 12941: </tr>
12942: <tr>
1.244 gutterid 12943: <td>MASTER_SITES</td>
1.236 gutterid 12944: <td>MASTER_SITE_BACKUP</td>
1.156 leot 12945: </tr>
12946: <tr>
1.244 gutterid 12947: <td>MASTER_SITE_LOCAL</td>
1.236 gutterid 12948: <td>MASTER_SITE_MOZILLA</td>
1.156 leot 12949: </tr>
12950: <tr>
1.244 gutterid 12951: <td>MASTER_SITE_OVERRIDE</td>
1.236 gutterid 12952: <td>MASTER_SITE_PERL_CPAN</td>
1.189 bacon 12953: </tr>
12954: <tr>
1.244 gutterid 12955: <td>MASTER_SORT</td>
1.236 gutterid 12956: <td>MASTER_SORT_RANDOM</td>
1.156 leot 12957: </tr>
12958: <tr>
1.244 gutterid 12959: <td>MASTER_SORT_REGEX</td>
1.236 gutterid 12960: <td>MECAB_CHARSET</td>
1.156 leot 12961: </tr>
12962: <tr>
1.244 gutterid 12963: <td>MEDIATOMB_GROUP</td>
1.236 gutterid 12964: <td>MEDIATOMB_USER</td>
1.156 leot 12965: </tr>
12966: <tr>
1.244 gutterid 12967: <td>MIPSPROBASE</td>
1.236 gutterid 12968: <td>MIREDO_GROUP</td>
1.156 leot 12969: </tr>
12970: <tr>
1.244 gutterid 12971: <td>MIREDO_USER</td>
1.236 gutterid 12972: <td>MISSING_FEATURES</td>
1.156 leot 12973: </tr>
12974: <tr>
1.244 gutterid 12975: <td>MKDIR</td>
1.236 gutterid 12976: <td>MKPIE_SUPPORTED</td>
1.156 leot 12977: </tr>
12978: <tr>
1.244 gutterid 12979: <td>MLDONKEY_GROUP</td>
1.236 gutterid 12980: <td>MLDONKEY_HOME</td>
1.156 leot 12981: </tr>
12982: <tr>
1.244 gutterid 12983: <td>MLDONKEY_USER</td>
1.236 gutterid 12984: <td>MONOTONE_GROUP</td>
1.156 leot 12985: </tr>
12986: <tr>
1.244 gutterid 12987: <td>MONOTONE_USER</td>
1.236 gutterid 12988: <td>MOTIFBASE</td>
1.156 leot 12989: </tr>
12990: <tr>
1.244 gutterid 12991: <td>MOTIF_TYPE</td>
1.236 gutterid 12992: <td>MOTIF_TYPE_DEFAULT</td>
1.207 leot 12993: </tr>
12994: <tr>
1.244 gutterid 12995: <td>MPI_TYPE</td>
1.236 gutterid 12996: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156 leot 12997: </tr>
12998: <tr>
1.244 gutterid 12999: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.232 gutterid 13000: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.241 rillig 13001: </tr>
13002: <tr>
1.244 gutterid 13003: <td>MV</td>
1.241 rillig 13004: <td>MYSQL_CHARSET</td>
1.156 leot 13005: </tr>
13006: <tr>
1.244 gutterid 13007: <td>MYSQL_DATADIR</td>
1.241 rillig 13008: <td>MYSQL_EXTRA_CHARSET</td>
1.238 wiz 13009: </tr>
13010: <tr>
1.244 gutterid 13011: <td>MYSQL_GROUP</td>
1.241 rillig 13012: <td>MYSQL_USER</td>
1.223 nia 13013: </tr>
13014: <tr>
1.244 gutterid 13015: <td>MYSQL_VERSION</td>
1.241 rillig 13016: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.214 leot 13017: </tr>
13018: <tr>
1.244 gutterid 13019: <td>MYSQL_VERSION_DEFAULT</td>
1.242 gutterid 13020: <td>NAGIOSCMD_GROUP</td>
1.197 leot 13021: </tr>
13022: <tr>
1.244 gutterid 13023: <td>NAGIOSDIR</td>
1.242 gutterid 13024: <td>NAGIOS_GROUP</td>
1.205 wiz 13025: </tr>
13026: <tr>
1.244 gutterid 13027: <td>NAGIOS_USER</td>
1.242 gutterid 13028: <td>NATIVE_APPEND_ABI</td>
1.156 leot 13029: </tr>
13030: <tr>
1.244 gutterid 13031: <td>NATIVE_APPEND_ELF</td>
1.242 gutterid 13032: <td>NATIVE_EXEC_FMT</td>
1.156 leot 13033: </tr>
13034: <tr>
1.244 gutterid 13035: <td>NATIVE_MACHINE_PLATFORM</td>
1.242 gutterid 13036: <td>NATIVE_OBJECT_FMT</td>
1.156 leot 13037: </tr>
13038: <tr>
1.244 gutterid 13039: <td>NBPAX_PROGRAM_PREFIX</td>
1.242 gutterid 13040: <td>NETBSD_LOGIN_NAME</td>
1.156 leot 13041: </tr>
13042: <tr>
1.244 gutterid 13043: <td>NMH_EDITOR</td>
1.242 gutterid 13044: <td>NMH_MTA</td>
1.195 gutterid 13045: </tr>
13046: <tr>
1.244 gutterid 13047: <td>NMH_PAGER</td>
1.242 gutterid 13048: <td>NODE_VERSIONS_ACCEPTED</td>
1.156 leot 13049: </tr>
13050: <tr>
1.244 gutterid 13051: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.242 gutterid 13052: <td>NODE_VERSION_DEFAULT</td>
1.156 leot 13053: </tr>
13054: <tr>
1.244 gutterid 13055: <td>NODE_VERSION_REQD</td>
1.242 gutterid 13056: <td>NOLOGIN</td>
1.156 leot 13057: </tr>
13058: <tr>
1.244 gutterid 13059: <td>NOTE</td>
1.242 gutterid 13060: <td>NOT_FOR_PLATFORM</td>
1.156 leot 13061: </tr>
13062: <tr>
1.244 gutterid 13063: <td>NOT_PAX_ASLR_SAFE</td>
1.242 gutterid 13064: <td>NOT_PAX_MPROTECT_SAFE</td>
1.156 leot 13065: </tr>
13066: <tr>
1.244 gutterid 13067: <td>NO_BUILD</td>
1.242 gutterid 13068: <td>NO_CHECKSUM</td>
1.229 gutterid 13069: </tr>
13070: <tr>
1.244 gutterid 13071: <td>NO_CONFIGURE</td>
1.242 gutterid 13072: <td>NO_SKIP</td>
1.218 nia 13073: </tr>
13074: <tr>
1.244 gutterid 13075: <td>NS_PREFERRED</td>
1.242 gutterid 13076: <td>NULLMAILER_GROUP</td>
1.218 nia 13077: </tr>
13078: <tr>
1.244 gutterid 13079: <td>NULLMAILER_USER</td>
1.242 gutterid 13080: <td>OBJHOSTNAME</td>
1.156 leot 13081: </tr>
13082: <tr>
1.244 gutterid 13083: <td>OBJMACHINE</td>
1.242 gutterid 13084: <td>OCAML_FINDLIB_DIRS</td>
1.178 rillig 13085: </tr>
13086: <tr>
1.244 gutterid 13087: <td>OCAML_FINDLIB_REGISTER</td>
1.242 gutterid 13088: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.156 leot 13089: </tr>
13090: <tr>
1.244 gutterid 13091: <td>OCAML_SITELIBDIR</td>
1.242 gutterid 13092: <td>OMF</td>
1.156 leot 13093: </tr>
13094: <tr>
1.244 gutterid 13095: <td>ONLY_FOR_COMPILER</td>
1.242 gutterid 13096: <td>ONLY_FOR_PLATFORM</td>
1.156 leot 13097: </tr>
13098: <tr>
1.244 gutterid 13099: <td>OPENSSH_CHROOT</td>
1.242 gutterid 13100: <td>OPENSSH_GROUP</td>
1.156 leot 13101: </tr>
13102: <tr>
1.244 gutterid 13103: <td>OPENSSH_USER</td>
1.242 gutterid 13104: <td>OPSYS</td>
1.156 leot 13105: </tr>
13106: <tr>
1.244 gutterid 13107: <td>OPSYS_EMULDIR</td>
1.242 gutterid 13108: <td>OPSYS_VERSION</td>
1.156 leot 13109: </tr>
13110: <tr>
1.244 gutterid 13111: <td>OS</td>
1.242 gutterid 13112: <td>OSS_TYPE</td>
1.156 leot 13113: </tr>
13114: <tr>
1.244 gutterid 13115: <td>OSX</td>
1.239 dholland 13116: <td>OS_VARIANT</td>
1.241 rillig 13117: </tr>
13118: <tr>
1.244 gutterid 13119: <td>OS_VERSION</td>
1.241 rillig 13120: <td>OTF_FONTS_DIR</td>
1.238 wiz 13121: </tr>
13122: <tr>
1.244 gutterid 13123: <td>OVERRIDE_DIRDEPTH</td>
1.241 rillig 13124: <td>OVERRIDE_GEMSPEC</td>
1.156 leot 13125: </tr>
13126: <tr>
1.244 gutterid 13127: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.229 gutterid 13128: <td>OWN_DIRS</td>
1.233 wiz 13129: </tr>
13130: <tr>
1.244 gutterid 13131: <td>OWN_DIRS_PERMS</td>
1.233 wiz 13132: <td>P4GROUP</td>
1.214 leot 13133: </tr>
13134: <tr>
1.244 gutterid 13135: <td>P4PORT</td>
1.233 wiz 13136: <td>P4ROOT</td>
1.227 wiz 13137: </tr>
13138: <tr>
1.244 gutterid 13139: <td>P4USER</td>
1.233 wiz 13140: <td>PACKAGES</td>
1.205 wiz 13141: </tr>
13142: <tr>
1.244 gutterid 13143: <td>PALMOS_DEFAULT_SDK</td>
1.233 wiz 13144: <td>PAMBASE</td>
1.161 leot 13145: </tr>
13146: <tr>
1.244 gutterid 13147: <td>PAM_DEFAULT</td>
1.233 wiz 13148: <td>PAPERSIZE</td>
1.156 leot 13149: </tr>
13150: <tr>
1.244 gutterid 13151: <td>PASSIVE_FETCH</td>
1.233 wiz 13152: <td>PATCHDIR</td>
1.156 leot 13153: </tr>
13154: <tr>
1.244 gutterid 13155: <td>PATCHFILES</td>
1.233 wiz 13156: <td>PATCH_ARGS</td>
1.156 leot 13157: </tr>
13158: <tr>
1.244 gutterid 13159: <td>PATCH_DEBUG</td>
1.233 wiz 13160: <td>PATCH_DIST_ARGS</td>
1.156 leot 13161: </tr>
13162: <tr>
1.244 gutterid 13163: <td>PATCH_DIST_CAT</td>
1.233 wiz 13164: <td>PATCH_DIST_STRIP</td>
1.156 leot 13165: </tr>
13166: <tr>
1.244 gutterid 13167: <td>PATCH_FUZZ_FACTOR</td>
1.233 wiz 13168: <td>PATCH_STRIP</td>
1.209 nia 13169: </tr>
13170: <tr>
1.244 gutterid 13171: <td>PATH</td>
1.233 wiz 13172: <td>PCCBASE</td>
1.156 leot 13173: </tr>
13174: <tr>
1.244 gutterid 13175: <td>PEAR_CMD</td>
1.229 gutterid 13176: <td>PEAR_LIB</td>
1.227 wiz 13177: </tr>
13178: <tr>
1.244 gutterid 13179: <td>PEAR_PACKAGE_XML</td>
1.229 gutterid 13180: <td>PERL5</td>
1.156 leot 13181: </tr>
13182: <tr>
1.244 gutterid 13183: <td>PERL5_CONFIGURE</td>
1.229 gutterid 13184: <td>PERL5_CONFIGURE_DIRS</td>
1.217 rillig 13185: </tr>
13186: <tr>
1.244 gutterid 13187: <td>PERL5_LDFLAGS</td>
1.229 gutterid 13188: <td>PERL5_LICENSE</td>
1.205 wiz 13189: </tr>
13190: <tr>
1.244 gutterid 13191: <td>PERL5_MODULE_TYPE</td>
1.229 gutterid 13192: <td>PERL5_PACKLIST</td>
1.177 leot 13193: </tr>
13194: <tr>
1.244 gutterid 13195: <td>PERL5_PACKLIST_DIR</td>
1.229 gutterid 13196: <td>PERL5_PERLBASE</td>
1.161 leot 13197: </tr>
13198: <tr>
1.244 gutterid 13199: <td>PERL5_SITEBASE</td>
1.229 gutterid 13200: <td>PERL5_USE_PACKLIST</td>
1.161 leot 13201: </tr>
13202: <tr>
1.244 gutterid 13203: <td>PERL5_VENDORBASE</td>
1.229 gutterid 13204: <td>PFCTL</td>
1.156 leot 13205: </tr>
13206: <tr>
1.244 gutterid 13207: <td>PFVAR_H</td>
1.229 gutterid 13208: <td>PF_VERSION</td>
1.156 leot 13209: </tr>
13210: <tr>
1.244 gutterid 13211: <td>PGGROUP</td>
1.229 gutterid 13212: <td>PGHOME</td>
1.156 leot 13213: </tr>
13214: <tr>
1.244 gutterid 13215: <td>PGPKGSRCDIR</td>
1.229 gutterid 13216: <td>PGSQL_TYPE</td>
1.156 leot 13217: </tr>
13218: <tr>
1.244 gutterid 13219: <td>PGSQL_VERSION</td>
1.229 gutterid 13220: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156 leot 13221: </tr>
13222: <tr>
1.244 gutterid 13223: <td>PGSQL_VERSION_DEFAULT</td>
1.229 gutterid 13224: <td>PGUSER</td>
1.156 leot 13225: </tr>
13226: <tr>
1.244 gutterid 13227: <td>PG_LIB_EXT</td>
1.229 gutterid 13228: <td>PHP</td>
1.156 leot 13229: </tr>
13230: <tr>
1.244 gutterid 13231: <td>PHPCOMMON_MK</td>
1.229 gutterid 13232: <td>PHPPKGSRCDIR</td>
1.156 leot 13233: </tr>
13234: <tr>
1.244 gutterid 13235: <td>PHP_BASE_VERS</td>
1.229 gutterid 13236: <td>PHP_CHECK_INSTALLED</td>
1.156 leot 13237: </tr>
13238: <tr>
1.244 gutterid 13239: <td>PHP_EXTENSION_DIR</td>
1.229 gutterid 13240: <td>PHP_INITIAL_TEENY</td>
1.156 leot 13241: </tr>
13242: <tr>
1.244 gutterid 13243: <td>PHP_PKG_PREFIX</td>
1.229 gutterid 13244: <td>PHP_VERSION</td>
1.156 leot 13245: </tr>
13246: <tr>
1.244 gutterid 13247: <td>PHP_VERSIONS_ACCEPTED</td>
1.229 gutterid 13248: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156 leot 13249: </tr>
13250: <tr>
1.244 gutterid 13251: <td>PHP_VERSION_DEFAULT</td>
1.229 gutterid 13252: <td>PHP_VERSION_REQD</td>
1.156 leot 13253: </tr>
13254: <tr>
1.244 gutterid 13255: <td>PILRC_USE_GTK</td>
1.229 gutterid 13256: <td>PKGCONFIG_BASE</td>
1.156 leot 13257: </tr>
13258: <tr>
1.244 gutterid 13259: <td>PKGCONFIG_FILE</td>
1.229 gutterid 13260: <td>PKGCONFIG_OVERRIDE</td>
1.156 leot 13261: </tr>
13262: <tr>
1.244 gutterid 13263: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.229 gutterid 13264: <td>PKGDIR</td>
1.156 leot 13265: </tr>
13266: <tr>
1.244 gutterid 13267: <td>PKGGNUDIR</td>
1.229 gutterid 13268: <td>PKGINFODIR</td>
1.156 leot 13269: </tr>
13270: <tr>
1.244 gutterid 13271: <td>PKGLOCALEDIR</td>
1.229 gutterid 13272: <td>PKGMANDIR</td>
1.156 leot 13273: </tr>
13274: <tr>
1.244 gutterid 13275: <td>PKGNAME</td>
1.229 gutterid 13276: <td>PKGNAME_REQD</td>
1.156 leot 13277: </tr>
13278: <tr>
1.244 gutterid 13279: <td>PKGPATH</td>
1.229 gutterid 13280: <td>PKGREVISION</td>
1.156 leot 13281: </tr>
13282: <tr>
1.244 gutterid 13283: <td>PKGSRC_BLAS_TYPES</td>
1.229 gutterid 13284: <td>PKGSRC_CHANGES</td>
1.156 leot 13285: </tr>
13286: <tr>
1.244 gutterid 13287: <td>PKGSRC_COMPILER</td>
1.229 gutterid 13288: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.156 leot 13289: </tr>
13290: <tr>
1.244 gutterid 13291: <td>PKGSRC_LOCKTYPE</td>
1.229 gutterid 13292: <td>PKGSRC_MAKE_ENV</td>
1.156 leot 13293: </tr>
13294: <tr>
1.244 gutterid 13295: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.229 gutterid 13296: <td>PKGSRC_MKPIE</td>
1.156 leot 13297: </tr>
13298: <tr>
1.244 gutterid 13299: <td>PKGSRC_MKREPRO</td>
1.229 gutterid 13300: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.177 leot 13301: </tr>
13302: <tr>
1.244 gutterid 13303: <td>PKGSRC_RUN_TEST</td>
1.229 gutterid 13304: <td>PKGSRC_SETENV</td>
1.156 leot 13305: </tr>
13306: <tr>
1.244 gutterid 13307: <td>PKGSRC_SLEEPSECS</td>
1.229 gutterid 13308: <td>PKGSRC_TODO</td>
1.159 rillig 13309: </tr>
13310: <tr>
1.244 gutterid 13311: <td>PKGSRC_USE_CTF</td>
1.229 gutterid 13312: <td>PKGSRC_USE_FORTIFY</td>
1.156 leot 13313: </tr>
13314: <tr>
1.244 gutterid 13315: <td>PKGSRC_USE_MKTOOLS</td>
1.229 gutterid 13316: <td>PKGSRC_USE_RELRO</td>
1.156 leot 13317: </tr>
13318: <tr>
1.244 gutterid 13319: <td>PKGSRC_USE_SSP</td>
1.229 gutterid 13320: <td>PKGSRC_USE_STACK_CHECK</td>
1.156 leot 13321: </tr>
13322: <tr>
1.244 gutterid 13323: <td>PKGTASKS_DATAFILE</td>
1.229 gutterid 13324: <td>PKGTOOLS_ARGS</td>
1.156 leot 13325: </tr>
13326: <tr>
1.244 gutterid 13327: <td>PKGTOOLS_ENV</td>
1.229 gutterid 13328: <td>PKG_ALTERNATIVES</td>
1.156 leot 13329: </tr>
13330: <tr>
1.244 gutterid 13331: <td>PKG_APACHE</td>
1.229 gutterid 13332: <td>PKG_APACHE_ACCEPTED</td>
1.156 leot 13333: </tr>
13334: <tr>
1.244 gutterid 13335: <td>PKG_APACHE_DEFAULT</td>
1.229 gutterid 13336: <td>PKG_BEST_EXISTS</td>
1.156 leot 13337: </tr>
13338: <tr>
1.244 gutterid 13339: <td>PKG_BUILD_OPTIONS</td>
1.229 gutterid 13340: <td>PKG_COMPRESSION</td>
1.156 leot 13341: </tr>
13342: <tr>
1.244 gutterid 13343: <td>PKG_CONFIG</td>
1.229 gutterid 13344: <td>PKG_CONFIG_PERMS</td>
1.156 leot 13345: </tr>
13346: <tr>
1.244 gutterid 13347: <td>PKG_CREATE_USERGROUP</td>
1.229 gutterid 13348: <td>PKG_DB_TMPDIR</td>
1.156 leot 13349: </tr>
13350: <tr>
1.244 gutterid 13351: <td>PKG_DEBUG_LEVEL</td>
1.229 gutterid 13352: <td>PKG_DEFAULT_OPTIONS</td>
1.156 leot 13353: </tr>
13354: <tr>
1.244 gutterid 13355: <td>PKG_DESTDIR_SUPPORT</td>
1.229 gutterid 13356: <td>PKG_DEVELOPER</td>
1.156 leot 13357: </tr>
13358: <tr>
1.244 gutterid 13359: <td>PKG_DISABLED_OPTIONS</td>
1.229 gutterid 13360: <td>PKG_FATAL_ERRORS</td>
1.233 wiz 13361: </tr>
13362: <tr>
1.244 gutterid 13363: <td>PKG_FC</td>
1.233 wiz 13364: <td>PKG_FILELIST_CMD</td>
1.156 leot 13365: </tr>
13366: <tr>
1.244 gutterid 13367: <td>PKG_GECOS</td>
1.233 wiz 13368: <td>PKG_GID</td>
1.156 leot 13369: </tr>
13370: <tr>
1.244 gutterid 13371: <td>PKG_GROUPS</td>
1.233 wiz 13372: <td>PKG_GROUPS_VARS</td>
1.156 leot 13373: </tr>
13374: <tr>
1.244 gutterid 13375: <td>PKG_HOME</td>
1.233 wiz 13376: <td>PKG_INIT_SCRIPTS</td>
1.156 leot 13377: </tr>
13378: <tr>
1.244 gutterid 13379: <td>PKG_JAVA_HOME</td>
1.233 wiz 13380: <td>PKG_JVM</td>
1.156 leot 13381: </tr>
13382: <tr>
1.244 gutterid 13383: <td>PKG_JVMS_ACCEPTED</td>
1.233 wiz 13384: <td>PKG_JVM_DEFAULT</td>
1.156 leot 13385: </tr>
13386: <tr>
1.244 gutterid 13387: <td>PKG_LEGACY_OPTIONS</td>
1.233 wiz 13388: <td>PKG_LIBTOOL</td>
1.156 leot 13389: </tr>
13390: <tr>
1.244 gutterid 13391: <td>PKG_MKSYMLINKS</td>
1.233 wiz 13392: <td>PKG_OPTIONS</td>
1.156 leot 13393: </tr>
13394: <tr>
1.244 gutterid 13395: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.233 wiz 13396: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.156 leot 13397: </tr>
13398: <tr>
1.244 gutterid 13399: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.233 wiz 13400: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.226 gutterid 13401: </tr>
13402: <tr>
1.244 gutterid 13403: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.233 wiz 13404: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.156 leot 13405: </tr>
13406: <tr>
1.244 gutterid 13407: <td>PKG_OPTIONS_VAR</td>
1.233 wiz 13408: <td>PKG_PHP</td>
1.156 leot 13409: </tr>
13410: <tr>
1.244 gutterid 13411: <td>PKG_PHP_MAJOR_VERS</td>
1.233 wiz 13412: <td>PKG_PHP_VERSION</td>
1.156 leot 13413: </tr>
13414: <tr>
1.244 gutterid 13415: <td>PKG_RCD_SCRIPTS</td>
1.233 wiz 13416: <td>PKG_REFCOUNT_DBDIR</td>
1.156 leot 13417: </tr>
13418: <tr>
1.244 gutterid 13419: <td>PKG_REGISTER_SHELLS</td>
1.233 wiz 13420: <td>PKG_RESUME_TRANSFERS</td>
1.156 leot 13421: </tr>
13422: <tr>
1.244 gutterid 13423: <td>PKG_SHELL</td>
1.233 wiz 13424: <td>PKG_SUGGESTED_OPTIONS</td>
1.156 leot 13425: </tr>
13426: <tr>
1.244 gutterid 13427: <td>PKG_SUPPORTED_OPTIONS</td>
1.233 wiz 13428: <td>PKG_SYSCONFBASE</td>
1.156 leot 13429: </tr>
13430: <tr>
1.244 gutterid 13431: <td>PKG_SYSCONFBASEDIR</td>
1.233 wiz 13432: <td>PKG_SYSCONFDIR</td>
1.156 leot 13433: </tr>
13434: <tr>
1.244 gutterid 13435: <td>PKG_SYSCONFDIR_PERMS</td>
1.233 wiz 13436: <td>PKG_SYSCONFSUBDIR</td>
1.156 leot 13437: </tr>
13438: <tr>
1.244 gutterid 13439: <td>PKG_SYSCONFVAR</td>
1.233 wiz 13440: <td>PKG_TOOLS_BIN</td>
1.156 leot 13441: </tr>
13442: <tr>
1.244 gutterid 13443: <td>PKG_UID</td>
1.233 wiz 13444: <td>PKG_UPDATE_FONTS_DB</td>
1.156 leot 13445: </tr>
13446: <tr>
1.244 gutterid 13447: <td>PKG_USERS</td>
1.233 wiz 13448: <td>PKG_USERS_VARS</td>
1.156 leot 13449: </tr>
13450: <tr>
1.244 gutterid 13451: <td>PKG_VERBOSE</td>
1.233 wiz 13452: <td>PLEASE</td>
1.156 leot 13453: </tr>
13454: <tr>
1.244 gutterid 13455: <td>PLIST</td>
1.233 wiz 13456: <td>PLIST_AWK</td>
1.156 leot 13457: </tr>
13458: <tr>
1.244 gutterid 13459: <td>PLIST_AWK_ENV</td>
1.233 wiz 13460: <td>PLIST_SRC</td>
1.156 leot 13461: </tr>
13462: <tr>
1.244 gutterid 13463: <td>PLIST_SUBST</td>
1.233 wiz 13464: <td>PLIST_TYPE</td>
1.156 leot 13465: </tr>
13466: <tr>
1.244 gutterid 13467: <td>PLIST_VARS</td>
1.233 wiz 13468: <td>POPTOP_USE_MPPE</td>
1.156 leot 13469: </tr>
13470: <tr>
1.244 gutterid 13471: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.233 wiz 13472: <td>POST_FETCH_HOOK</td>
1.156 leot 13473: </tr>
13474: <tr>
1.244 gutterid 13475: <td>PREFER</td>
1.233 wiz 13476: <td>PREFER_NATIVE</td>
1.156 leot 13477: </tr>
13478: <tr>
1.244 gutterid 13479: <td>PREFER_NATIVE_PTHREADS</td>
1.233 wiz 13480: <td>PREFER_PKGSRC</td>
1.156 leot 13481: </tr>
13482: <tr>
1.244 gutterid 13483: <td>PREFIX</td>
1.233 wiz 13484: <td>PREPEND_PATH</td>
1.156 leot 13485: </tr>
13486: <tr>
1.244 gutterid 13487: <td>PRE_ROOT_CMD</td>
1.233 wiz 13488: <td>PRIVILEGED_STAGES</td>
1.156 leot 13489: </tr>
13490: <tr>
1.244 gutterid 13491: <td>PS</td>
1.233 wiz 13492: <td>PTHREAD_AUTO_VARS</td>
1.156 leot 13493: </tr>
13494: <tr>
1.244 gutterid 13495: <td>PTHREAD_CFLAGS</td>
1.233 wiz 13496: <td>PTHREAD_LDFLAGS</td>
1.156 leot 13497: </tr>
13498: <tr>
1.244 gutterid 13499: <td>PTHREAD_LIBS</td>
1.233 wiz 13500: <td>PTHREAD_OPTS</td>
1.156 leot 13501: </tr>
13502: <tr>
1.244 gutterid 13503: <td>PTHREAD_TYPE</td>
1.233 wiz 13504: <td>PVM_SSH</td>
1.156 leot 13505: </tr>
13506: <tr>
1.244 gutterid 13507: <td>PYPKGPREFIX</td>
1.233 wiz 13508: <td>PYTHON_FOR_BUILD_ONLY</td>
1.156 leot 13509: </tr>
13510: <tr>
1.244 gutterid 13511: <td>PYTHON_SELF_CONFLICT</td>
1.237 gutterid 13512: <td>PYTHON_VERSION</td>
1.156 leot 13513: </tr>
13514: <tr>
1.244 gutterid 13515: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.232 gutterid 13516: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156 leot 13517: </tr>
13518: <tr>
1.244 gutterid 13519: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.232 gutterid 13520: <td>PYTHON_VERSION_DEFAULT</td>
1.156 leot 13521: </tr>
13522: <tr>
1.244 gutterid 13523: <td>PYTHON_VERSION_REQD</td>
1.232 gutterid 13524: <td>PYVERSSUFFIX</td>
1.156 leot 13525: </tr>
13526: <tr>
1.244 gutterid 13527: <td>QMAILDIR</td>
1.232 gutterid 13528: <td>QMAIL_ALIAS_USER</td>
1.156 leot 13529: </tr>
13530: <tr>
1.244 gutterid 13531: <td>QMAIL_DAEMON_USER</td>
1.232 gutterid 13532: <td>QMAIL_LOG_USER</td>
1.156 leot 13533: </tr>
13534: <tr>
1.244 gutterid 13535: <td>QMAIL_NOFILES_GROUP</td>
1.232 gutterid 13536: <td>QMAIL_PASSWD_USER</td>
1.156 leot 13537: </tr>
13538: <tr>
1.244 gutterid 13539: <td>QMAIL_QMAIL_GROUP</td>
1.232 gutterid 13540: <td>QMAIL_QUEUE_DIR</td>
1.156 leot 13541: </tr>
13542: <tr>
1.244 gutterid 13543: <td>QMAIL_QUEUE_EXTRA</td>
1.232 gutterid 13544: <td>QMAIL_QUEUE_USER</td>
1.156 leot 13545: </tr>
13546: <tr>
1.244 gutterid 13547: <td>QMAIL_REMOTE_USER</td>
1.232 gutterid 13548: <td>QMAIL_ROOT_USER</td>
1.156 leot 13549: </tr>
13550: <tr>
1.244 gutterid 13551: <td>QMAIL_SEND_USER</td>
1.232 gutterid 13552: <td>QORE_LATEST_MODULE_API</td>
1.156 leot 13553: </tr>
13554: <tr>
1.244 gutterid 13555: <td>QORE_MODULE_API</td>
1.232 gutterid 13556: <td>QORE_MODULE_DIR</td>
1.156 leot 13557: </tr>
13558: <tr>
1.244 gutterid 13559: <td>QORE_USER_MODULE_DIR</td>
1.232 gutterid 13560: <td>QORE_VERSION</td>
1.156 leot 13561: </tr>
13562: <tr>
1.244 gutterid 13563: <td>QPOPPER_FAC</td>
1.232 gutterid 13564: <td>QPOPPER_SPOOL_DIR</td>
1.156 leot 13565: </tr>
13566: <tr>
1.244 gutterid 13567: <td>QPOPPER_USER</td>
1.232 gutterid 13568: <td>RAKE_NAME</td>
1.233 wiz 13569: </tr>
13570: <tr>
1.244 gutterid 13571: <td>RASMOL_DEPTH</td>
1.232 gutterid 13572: <td>RCD_SCRIPTS</td>
1.218 nia 13573: </tr>
13574: <tr>
1.244 gutterid 13575: <td>RCD_SCRIPTS_DIR</td>
1.232 gutterid 13576: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.227 wiz 13577: </tr>
13578: <tr>
1.244 gutterid 13579: <td>RCD_SCRIPTS_MODE</td>
1.232 gutterid 13580: <td>RCD_SCRIPTS_SHELL</td>
1.156 leot 13581: </tr>
13582: <tr>
1.244 gutterid 13583: <td>RCD_SCRIPT_SRC</td>
1.239 dholland 13584: <td>RDOC</td>
1.241 rillig 13585: </tr>
13586: <tr>
1.244 gutterid 13587: <td>READLINE_DEFAULT</td>
1.241 rillig 13588: <td>READLINE_TYPE</td>
1.214 leot 13589: </tr>
13590: <tr>
1.244 gutterid 13591: <td>REAL_ROOT_GROUP</td>
1.241 rillig 13592: <td>REAL_ROOT_USER</td>
1.205 wiz 13593: </tr>
13594: <tr>
1.244 gutterid 13595: <td>RECURSIVE_MAKE</td>
1.241 rillig 13596: <td>RELAY_CTRL_DIR</td>
1.223 nia 13597: </tr>
13598: <tr>
1.244 gutterid 13599: <td>RELRO_SUPPORTED</td>
1.241 rillig 13600: <td>REPLACE_AWK</td>
1.177 leot 13601: </tr>
13602: <tr>
1.244 gutterid 13603: <td>REPLACE_BASH</td>
1.241 rillig 13604: <td>REPLACE_CSH</td>
1.214 leot 13605: </tr>
13606: <tr>
1.244 gutterid 13607: <td>REPLACE_KSH</td>
1.241 rillig 13608: <td>REPLACE_LUA</td>
1.212 wiz 13609: </tr>
13610: <tr>
1.244 gutterid 13611: <td>REPLACE_NODEJS</td>
1.241 rillig 13612: <td>REPLACE_OCTAVE</td>
1.156 leot 13613: </tr>
13614: <tr>
1.244 gutterid 13615: <td>REPLACE_PERL</td>
1.241 rillig 13616: <td>REPLACE_PERL6</td>
1.205 wiz 13617: </tr>
13618: <tr>
1.244 gutterid 13619: <td>REPLACE_PHP</td>
1.241 rillig 13620: <td>REPLACE_PYTHON</td>
1.197 leot 13621: </tr>
13622: <tr>
1.244 gutterid 13623: <td>REPLACE_QORE</td>
1.241 rillig 13624: <td>REPLACE_R</td>
1.156 leot 13625: </tr>
13626: <tr>
1.244 gutterid 13627: <td>REPLACE_RUBY</td>
1.241 rillig 13628: <td>REPLACE_RUBY_DIRS</td>
1.218 nia 13629: </tr>
13630: <tr>
1.244 gutterid 13631: <td>REPLACE_RUBY_PAT</td>
1.241 rillig 13632: <td>REPLACE_SH</td>
1.161 leot 13633: </tr>
13634: <tr>
1.244 gutterid 13635: <td>REPLACE_TEXLUA</td>
1.241 rillig 13636: <td>REPLACE_WISH</td>
1.216 gutterid 13637: </tr>
13638: <tr>
1.244 gutterid 13639: <td>REQD_DIRS</td>
1.241 rillig 13640: <td>REQD_DIRS_PERMS</td>
1.156 leot 13641: </tr>
13642: <tr>
1.244 gutterid 13643: <td>REQD_FILES</td>
1.241 rillig 13644: <td>REQD_FILES_MODE</td>
1.218 nia 13645: </tr>
13646: <tr>
1.244 gutterid 13647: <td>REQD_FILES_PERMS</td>
1.241 rillig 13648: <td>RESOLV_AUTO_VARS</td>
1.156 leot 13649: </tr>
13650: <tr>
1.244 gutterid 13651: <td>RESOLV_LDFLAGS</td>
1.241 rillig 13652: <td>RESOLV_LIBS</td>
1.238 wiz 13653: </tr>
13654: <tr>
1.244 gutterid 13655: <td>RM</td>
1.232 gutterid 13656: <td>ROOT_CMD</td>
1.241 rillig 13657: </tr>
13658: <tr>
1.244 gutterid 13659: <td>ROOT_GROUP</td>
1.241 rillig 13660: <td>ROOT_USER</td>
1.156 leot 13661: </tr>
13662: <tr>
1.244 gutterid 13663: <td>RPCGEN</td>
1.241 rillig 13664: <td>RPM</td>
1.156 leot 13665: </tr>
13666: <tr>
1.244 gutterid 13667: <td>RPM2PKG_PLIST</td>
1.241 rillig 13668: <td>RPM2PKG_PREFIX</td>
1.205 wiz 13669: </tr>
13670: <tr>
1.244 gutterid 13671: <td>RPM2PKG_STAGE</td>
1.241 rillig 13672: <td>RPM2PKG_STRIP</td>
1.217 rillig 13673: </tr>
13674: <tr>
1.244 gutterid 13675: <td>RPM2PKG_SUBPREFIX</td>
1.241 rillig 13676: <td>RPMFILES</td>
1.214 leot 13677: </tr>
13678: <tr>
1.244 gutterid 13679: <td>RPMIGNOREPATH</td>
1.241 rillig 13680: <td>RPM_DB_PREFIX</td>
1.212 wiz 13681: </tr>
13682: <tr>
1.244 gutterid 13683: <td>RSSH_CVS_PATH</td>
1.241 rillig 13684: <td>RSSH_RDIST_PATH</td>
1.156 leot 13685: </tr>
13686: <tr>
1.244 gutterid 13687: <td>RSSH_RSYNC_PATH</td>
1.241 rillig 13688: <td>RSSH_SCP_PATH</td>
1.197 leot 13689: </tr>
13690: <tr>
1.244 gutterid 13691: <td>RSSH_SFTP_SERVER_PATH</td>
1.241 rillig 13692: <td>RUBY</td>
1.156 leot 13693: </tr>
13694: <tr>
1.244 gutterid 13695: <td>RUBYGEM</td>
1.241 rillig 13696: <td>RUBYGEM_MANPAGES</td>
1.156 leot 13697: </tr>
13698: <tr>
1.244 gutterid 13699: <td>RUBYGEM_NAME</td>
1.241 rillig 13700: <td>RUBYGEM_OPTIONS</td>
1.156 leot 13701: </tr>
13702: <tr>
1.244 gutterid 13703: <td>RUBYGEM_USE_MANPAGES</td>
1.241 rillig 13704: <td>RUBYGEM_VERBOSE</td>
1.231 jnemeth 13705: </tr>
13706: <tr>
1.244 gutterid 13707: <td>RUBY_ABI_VERSION</td>
1.241 rillig 13708: <td>RUBY_ARCH</td>
1.156 leot 13709: </tr>
13710: <tr>
1.244 gutterid 13711: <td>RUBY_ARCHINC</td>
1.241 rillig 13712: <td>RUBY_ARCHLIB</td>
1.156 leot 13713: </tr>
13714: <tr>
1.244 gutterid 13715: <td>RUBY_BASE</td>
1.241 rillig 13716: <td>RUBY_BASERIDIR</td>
1.156 leot 13717: </tr>
13718: <tr>
1.244 gutterid 13719: <td>RUBY_BUILD_DOCUMENT</td>
1.241 rillig 13720: <td>RUBY_DLEXT</td>
1.156 leot 13721: </tr>
13722: <tr>
1.244 gutterid 13723: <td>RUBY_DOC</td>
1.241 rillig 13724: <td>RUBY_DYNAMIC_DIRS</td>
1.156 leot 13725: </tr>
13726: <tr>
1.244 gutterid 13727: <td>RUBY_EG</td>
1.241 rillig 13728: <td>RUBY_ENCODING_ARG</td>
1.156 leot 13729: </tr>
13730: <tr>
1.244 gutterid 13731: <td>RUBY_EXTCONF</td>
1.241 rillig 13732: <td>RUBY_EXTCONF_CHECK</td>
1.156 leot 13733: </tr>
13734: <tr>
1.244 gutterid 13735: <td>RUBY_EXTCONF_DEBUG</td>
1.241 rillig 13736: <td>RUBY_EXTCONF_MAKEFILE</td>
1.198 leot 13737: </tr>
13738: <tr>
1.244 gutterid 13739: <td>RUBY_GEM_ARCH</td>
1.241 rillig 13740: <td>RUBY_GEM_BASE</td>
1.156 leot 13741: </tr>
13742: <tr>
1.244 gutterid 13743: <td>RUBY_INC</td>
1.241 rillig 13744: <td>RUBY_LIB</td>
1.156 leot 13745: </tr>
13746: <tr>
1.244 gutterid 13747: <td>RUBY_LIB_BASE</td>
1.241 rillig 13748: <td>RUBY_NAME</td>
1.156 leot 13749: </tr>
13750: <tr>
1.244 gutterid 13751: <td>RUBY_NOVERSION</td>
1.241 rillig 13752: <td>RUBY_PKGPREFIX</td>
1.156 leot 13753: </tr>
13754: <tr>
1.244 gutterid 13755: <td>RUBY_RAILS</td>
13756: <td>RUBY_RAILS61_VERSION</td>
1.223 nia 13757: </tr>
13758: <tr>
1.242 gutterid 13759: <td>RUBY_RAILS70_VERSION</td>
1.244 gutterid 13760: <td>RUBY_RAILS_ACCEPTED</td>
1.156 leot 13761: </tr>
13762: <tr>
1.242 gutterid 13763: <td>RUBY_RAILS_DEFAULT</td>
1.244 gutterid 13764: <td>RUBY_RAILS_REQD</td>
1.156 leot 13765: </tr>
13766: <tr>
1.242 gutterid 13767: <td>RUBY_RAILS_STRICT_DEP</td>
1.244 gutterid 13768: <td>RUBY_RIDIR</td>
1.156 leot 13769: </tr>
13770: <tr>
1.242 gutterid 13771: <td>RUBY_SETUP</td>
1.244 gutterid 13772: <td>RUBY_SHLIB</td>
1.156 leot 13773: </tr>
13774: <tr>
1.242 gutterid 13775: <td>RUBY_SHLIBALIAS</td>
1.244 gutterid 13776: <td>RUBY_SHLIBVER</td>
1.156 leot 13777: </tr>
13778: <tr>
1.242 gutterid 13779: <td>RUBY_SIMPLE_INSTALL</td>
1.244 gutterid 13780: <td>RUBY_SITEARCHLIB</td>
1.156 leot 13781: </tr>
13782: <tr>
1.242 gutterid 13783: <td>RUBY_SITELIB</td>
1.244 gutterid 13784: <td>RUBY_SITELIB_BASE</td>
1.156 leot 13785: </tr>
13786: <tr>
1.242 gutterid 13787: <td>RUBY_SITERIDIR</td>
1.244 gutterid 13788: <td>RUBY_SLEXT</td>
1.156 leot 13789: </tr>
13790: <tr>
1.242 gutterid 13791: <td>RUBY_SRCDIR</td>
1.244 gutterid 13792: <td>RUBY_STATICLIB</td>
1.156 leot 13793: </tr>
13794: <tr>
1.242 gutterid 13795: <td>RUBY_SUFFIX</td>
1.244 gutterid 13796: <td>RUBY_SYSRIDIR</td>
1.174 leot 13797: </tr>
13798: <tr>
1.242 gutterid 13799: <td>RUBY_USE_PTHREAD</td>
1.244 gutterid 13800: <td>RUBY_VENDORARCHLIB</td>
1.156 leot 13801: </tr>
13802: <tr>
1.242 gutterid 13803: <td>RUBY_VENDORLIB</td>
1.244 gutterid 13804: <td>RUBY_VENDORLIB_BASE</td>
1.156 leot 13805: </tr>
13806: <tr>
1.242 gutterid 13807: <td>RUBY_VER</td>
1.244 gutterid 13808: <td>RUBY_VERSION</td>
1.156 leot 13809: </tr>
13810: <tr>
1.242 gutterid 13811: <td>RUBY_VERSIONS_ACCEPTED</td>
1.244 gutterid 13812: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.156 leot 13813: </tr>
13814: <tr>
1.242 gutterid 13815: <td>RUBY_VERSION_DEFAULT</td>
1.244 gutterid 13816: <td>RUBY_VERSION_REQD</td>
1.156 leot 13817: </tr>
13818: <tr>
1.242 gutterid 13819: <td>RUBY_VER_DIR</td>
1.244 gutterid 13820: <td>RUN</td>
1.156 leot 13821: </tr>
13822: <tr>
1.242 gutterid 13823: <td>RUN_LDCONFIG</td>
1.244 gutterid 13824: <td>RUST_TYPE</td>
1.156 leot 13825: </tr>
13826: <tr>
1.242 gutterid 13827: <td>SCO</td>
1.244 gutterid 13828: <td>SCREWS_GROUP</td>
1.156 leot 13829: </tr>
13830: <tr>
1.242 gutterid 13831: <td>SCREWS_USER</td>
1.244 gutterid 13832: <td>SCRIPTS_ENV</td>
1.156 leot 13833: </tr>
13834: <tr>
1.242 gutterid 13835: <td>SCROLLKEEPER_DATADIR</td>
1.244 gutterid 13836: <td>SCROLLKEEPER_REBUILDDB</td>
1.156 leot 13837: </tr>
13838: <tr>
1.242 gutterid 13839: <td>SCROLLKEEPER_UPDATEDB</td>
1.244 gutterid 13840: <td>SDIST_PAWD</td>
1.156 leot 13841: </tr>
13842: <tr>
1.242 gutterid 13843: <td>SDL12_TYPE</td>
1.244 gutterid 13844: <td>SERIAL_DEVICES</td>
1.156 leot 13845: </tr>
13846: <tr>
1.242 gutterid 13847: <td>SETGIDGAME</td>
1.244 gutterid 13848: <td>SETGID_GAMES_PERMS</td>
1.156 leot 13849: </tr>
13850: <tr>
1.242 gutterid 13851: <td>SETUID_ROOT_PERMS</td>
1.244 gutterid 13852: <td>SH</td>
1.156 leot 13853: </tr>
13854: <tr>
1.238 wiz 13855: <td>SHLIB</td>
1.244 gutterid 13856: <td>SIGN_PACKAGES</td>
1.233 wiz 13857: </tr>
13858: <tr>
1.239 dholland 13859: <td>SILC_CLIENT_WITH_PERL</td>
1.244 gutterid 13860: <td>SITE_SPECIFIC_PKGS</td>
1.156 leot 13861: </tr>
13862: <tr>
1.239 dholland 13863: <td>SKIP_DEPENDS</td>
1.244 gutterid 13864: <td>SMF_INSTANCES</td>
1.227 wiz 13865: </tr>
13866: <tr>
1.239 dholland 13867: <td>SMF_MANIFEST</td>
1.244 gutterid 13868: <td>SMF_METHODS</td>
1.156 leot 13869: </tr>
13870: <tr>
1.239 dholland 13871: <td>SMF_METHOD_SHELL</td>
1.244 gutterid 13872: <td>SMF_METHOD_SRC</td>
1.156 leot 13873: </tr>
13874: <tr>
1.239 dholland 13875: <td>SMF_NAME</td>
1.244 gutterid 13876: <td>SMF_PREFIX</td>
1.177 leot 13877: </tr>
13878: <tr>
1.239 dholland 13879: <td>SMF_SRCDIR</td>
1.244 gutterid 13880: <td>SNIPROXY_GROUP</td>
1.156 leot 13881: </tr>
13882: <tr>
1.239 dholland 13883: <td>SNIPROXY_USER</td>
1.244 gutterid 13884: <td>SOURCE_BUFFSIZE</td>
1.217 rillig 13885: </tr>
13886: <tr>
1.239 dholland 13887: <td>SPECIAL_PERMS</td>
1.244 gutterid 13888: <td>SPECIFIC_PKGS</td>
1.156 leot 13889: </tr>
13890: <tr>
1.239 dholland 13891: <td>SSH_SUID</td>
1.244 gutterid 13892: <td>SSP_SUPPORTED</td>
1.159 rillig 13893: </tr>
13894: <tr>
1.239 dholland 13895: <td>SSYNC_PAWD</td>
1.244 gutterid 13896: <td>STEP_MSG</td>
1.156 leot 13897: </tr>
13898: <tr>
1.239 dholland 13899: <td>STRIP</td>
1.244 gutterid 13900: <td>STRIP_DBG</td>
1.156 leot 13901: </tr>
13902: <tr>
1.239 dholland 13903: <td>STRIP_DEBUG</td>
1.244 gutterid 13904: <td>STRIP_DEBUG_SUPPORTED</td>
1.156 leot 13905: </tr>
13906: <tr>
1.239 dholland 13907: <td>STRIP_FILES_SKIP</td>
1.244 gutterid 13908: <td>SU</td>
1.156 leot 13909: </tr>
13910: <tr>
1.239 dholland 13911: <td>SUBDIR</td>
1.244 gutterid 13912: <td>SUBST</td>
1.156 leot 13913: </tr>
13914: <tr>
1.239 dholland 13915: <td>SUBST_CLASSES</td>
1.244 gutterid 13916: <td>SUBST_FILES</td>
1.156 leot 13917: </tr>
13918: <tr>
1.239 dholland 13919: <td>SUBST_FILTER_CMD</td>
1.244 gutterid 13920: <td>SUBST_MESSAGE</td>
1.156 leot 13921: </tr>
13922: <tr>
1.239 dholland 13923: <td>SUBST_NOOP_OK</td>
1.244 gutterid 13924: <td>SUBST_SED</td>
1.156 leot 13925: </tr>
13926: <tr>
1.239 dholland 13927: <td>SUBST_SHOW_DIFF</td>
1.244 gutterid 13928: <td>SUBST_SKIP_TEXT_CHECK</td>
1.156 leot 13929: </tr>
13930: <tr>
1.239 dholland 13931: <td>SUBST_STAGE</td>
1.244 gutterid 13932: <td>SUBST_VARS</td>
1.156 leot 13933: </tr>
13934: <tr>
1.239 dholland 13935: <td>SUNWSPROBASE</td>
1.244 gutterid 13936: <td>SUSE_PREFER</td>
1.156 leot 13937: </tr>
13938: <tr>
1.237 gutterid 13939: <td>SU_CMD</td>
1.244 gutterid 13940: <td>SYSCONFBASE</td>
1.238 wiz 13941: </tr>
13942: <tr>
1.239 dholland 13943: <td>TARGET_ARCH</td>
1.244 gutterid 13944: <td>TBL</td>
1.156 leot 13945: </tr>
13946: <tr>
1.239 dholland 13947: <td>TERMCAP_TYPE</td>
1.244 gutterid 13948: <td>TERMINFO_DEFAULT</td>
1.227 wiz 13949: </tr>
13950: <tr>
1.239 dholland 13951: <td>TERMINFO_TYPE</td>
1.244 gutterid 13952: <td>TEST</td>
1.156 leot 13953: </tr>
13954: <tr>
1.239 dholland 13955: <td>TEST_DEPENDS</td>
1.244 gutterid 13956: <td>TEST_DIRS</td>
1.217 rillig 13957: </tr>
13958: <tr>
1.239 dholland 13959: <td>TEST_ENV</td>
1.244 gutterid 13960: <td>TEST_ENV_SHELL</td>
1.212 wiz 13961: </tr>
13962: <tr>
1.239 dholland 13963: <td>TEST_MAKE_CMD</td>
1.244 gutterid 13964: <td>TEST_MAKE_FLAGS</td>
1.217 rillig 13965: </tr>
13966: <tr>
1.239 dholland 13967: <td>TEST_TARGET</td>
1.244 gutterid 13968: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.205 wiz 13969: </tr>
13970: <tr>
1.239 dholland 13971: <td>TEXLIVE_REV</td>
1.244 gutterid 13972: <td>TEXLIVE_UNVERSIONED</td>
1.189 bacon 13973: </tr>
13974: <tr>
1.239 dholland 13975: <td>TEXMFSITE</td>
1.244 gutterid 13976: <td>TEX_FORMATS</td>
1.161 leot 13977: </tr>
13978: <tr>
1.239 dholland 13979: <td>TEX_HYPHEN_DAT</td>
1.244 gutterid 13980: <td>TEX_HYPHEN_DEF</td>
1.159 rillig 13981: </tr>
13982: <tr>
1.239 dholland 13983: <td>TEX_TEXMF_DIRS</td>
1.244 gutterid 13984: <td>THTTPD_LOG_FACILITY</td>
1.156 leot 13985: </tr>
13986: <tr>
1.239 dholland 13987: <td>TINYDYN_USER</td>
1.244 gutterid 13988: <td>TLSWRAPPER_CHROOT</td>
1.156 leot 13989: </tr>
13990: <tr>
1.239 dholland 13991: <td>TO</td>
1.244 gutterid 13992: <td>TOOLS_ALIASES</td>
1.156 leot 13993: </tr>
13994: <tr>
1.239 dholland 13995: <td>TOOLS_ALWAYS_WRAP</td>
1.244 gutterid 13996: <td>TOOLS_ARGS</td>
1.156 leot 13997: </tr>
13998: <tr>
1.239 dholland 13999: <td>TOOLS_BROKEN</td>
1.244 gutterid 14000: <td>TOOLS_CMD</td>
1.156 leot 14001: </tr>
14002: <tr>
1.239 dholland 14003: <td>TOOLS_CMDLINE_SED</td>
1.244 gutterid 14004: <td>TOOLS_CREATE</td>
1.156 leot 14005: </tr>
14006: <tr>
1.239 dholland 14007: <td>TOOLS_CROSS_DESTDIR</td>
1.244 gutterid 14008: <td>TOOLS_DIR</td>
1.156 leot 14009: </tr>
14010: <tr>
1.239 dholland 14011: <td>TOOLS_FAIL</td>
1.244 gutterid 14012: <td>TOOLS_GNU_MISSING</td>
1.156 leot 14013: </tr>
14014: <tr>
1.239 dholland 14015: <td>TOOLS_LDCONFIG</td>
1.244 gutterid 14016: <td>TOOLS_NOOP</td>
1.156 leot 14017: </tr>
14018: <tr>
1.239 dholland 14019: <td>TOOLS_PATH</td>
1.244 gutterid 14020: <td>TOOLS_SCRIPT</td>
1.156 leot 14021: </tr>
14022: <tr>
1.239 dholland 14023: <td>TOOLS_USE_CROSS_COMPILE</td>
1.244 gutterid 14024: <td>TOOL_DEPENDS</td>
1.156 leot 14025: </tr>
14026: <tr>
1.242 gutterid 14027: <td>TTF_FONTS_DIR</td>
1.244 gutterid 14028: <td>TYPE</td>
1.241 rillig 14029: </tr>
14030: <tr>
1.242 gutterid 14031: <td>UAC_REQD_EXECS</td>
1.244 gutterid 14032: <td>UCSPI_SSL_GROUP</td>
1.238 wiz 14033: </tr>
14034: <tr>
1.242 gutterid 14035: <td>UCSPI_SSL_USER</td>
1.244 gutterid 14036: <td>UNLIMIT_RESOURCES</td>
1.156 leot 14037: </tr>
14038: <tr>
1.242 gutterid 14039: <td>UNPRIVILEGED</td>
1.244 gutterid 14040: <td>UNPRIVILEGED_GROUP</td>
1.223 nia 14041: </tr>
14042: <tr>
1.242 gutterid 14043: <td>UNPRIVILEGED_GROUPS</td>
1.244 gutterid 14044: <td>UNPRIVILEGED_USER</td>
1.156 leot 14045: </tr>
14046: <tr>
1.242 gutterid 14047: <td>UNWRAP_FILES</td>
1.244 gutterid 14048: <td>UNWRAP_PATTERNS</td>
1.212 wiz 14049: </tr>
14050: <tr>
1.242 gutterid 14051: <td>UPDATE_GEMSPEC</td>
1.244 gutterid 14052: <td>UPDATE_TARGET</td>
1.156 leot 14053: </tr>
14054: <tr>
1.242 gutterid 14055: <td>URI</td>
1.244 gutterid 14056: <td>USERGROUP_PHASE</td>
1.156 leot 14057: </tr>
14058: <tr>
1.242 gutterid 14059: <td>USERPPP_GROUP</td>
1.244 gutterid 14060: <td>USER_SPECIFIC_PKGS</td>
1.156 leot 14061: </tr>
14062: <tr>
1.242 gutterid 14063: <td>USE_ABI_DEPENDS</td>
1.244 gutterid 14064: <td>USE_APR</td>
1.156 leot 14065: </tr>
14066: <tr>
1.242 gutterid 14067: <td>USE_BSD_MAKEFILE</td>
1.244 gutterid 14068: <td>USE_BUILTIN</td>
1.156 leot 14069: </tr>
14070: <tr>
1.243 gutterid 14071: <td>USE_CC_FEATURES</td>
1.244 gutterid 14072: <td>USE_CROSS_COMPILE</td>
1.243 gutterid 14073: </tr>
14074: <tr>
14075: <td>USE_CURSES</td>
1.244 gutterid 14076: <td>USE_CWRAPPERS</td>
1.156 leot 14077: </tr>
14078: <tr>
1.243 gutterid 14079: <td>USE_CXX_FEATURES</td>
1.244 gutterid 14080: <td>USE_DB185</td>
1.156 leot 14081: </tr>
14082: <tr>
1.242 gutterid 14083: <td>USE_FEATURES</td>
1.244 gutterid 14084: <td>USE_GAMESGROUP</td>
1.156 leot 14085: </tr>
14086: <tr>
1.242 gutterid 14087: <td>USE_GCC_RUNTIME</td>
1.244 gutterid 14088: <td>USE_IMAKE</td>
1.156 leot 14089: </tr>
14090: <tr>
1.242 gutterid 14091: <td>USE_JAVA</td>
1.244 gutterid 14092: <td>USE_JAVA2</td>
1.205 wiz 14093: </tr>
14094: <tr>
1.242 gutterid 14095: <td>USE_LANGUAGES</td>
1.244 gutterid 14096: <td>USE_LIBTOOL</td>
1.156 leot 14097: </tr>
14098: <tr>
1.242 gutterid 14099: <td>USE_NATIVE_GCC</td>
1.244 gutterid 14100: <td>USE_NETBSD_REPO</td>
1.156 leot 14101: </tr>
14102: <tr>
1.242 gutterid 14103: <td>USE_PKGSRC_GCC</td>
1.244 gutterid 14104: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.156 leot 14105: </tr>
14106: <tr>
1.242 gutterid 14107: <td>USE_PKGTASKS</td>
1.244 gutterid 14108: <td>USE_PKG_ADMIN_DIGEST</td>
1.156 leot 14109: </tr>
14110: <tr>
1.242 gutterid 14111: <td>USE_RUBY_EXTCONF</td>
1.244 gutterid 14112: <td>USE_RUBY_INSTALL</td>
1.156 leot 14113: </tr>
14114: <tr>
1.242 gutterid 14115: <td>USE_RUBY_SETUP</td>
1.244 gutterid 14116: <td>USE_RUBY_SETUP_PKG</td>
1.156 leot 14117: </tr>
14118: <tr>
1.242 gutterid 14119: <td>USE_TOOLS</td>
1.244 gutterid 14120: <td>UUCP_GROUP</td>
1.156 leot 14121: </tr>
14122: <tr>
1.242 gutterid 14123: <td>UUCP_USER</td>
1.244 gutterid 14124: <td>VARBASE</td>
1.156 leot 14125: </tr>
14126: <tr>
1.242 gutterid 14127: <td>VARNAME</td>
1.244 gutterid 14128: <td>VIM_EXTRA_OPTS</td>
1.156 leot 14129: </tr>
14130: <tr>
1.242 gutterid 14131: <td>WARNING_MSG</td>
1.244 gutterid 14132: <td>WCALC_CGIDIR</td>
1.156 leot 14133: </tr>
14134: <tr>
1.242 gutterid 14135: <td>WCALC_CGIPATH</td>
1.244 gutterid 14136: <td>WCALC_HTMLDIR</td>
1.156 leot 14137: </tr>
14138: <tr>
1.242 gutterid 14139: <td>WCALC_HTMLPATH</td>
1.244 gutterid 14140: <td>WDM_MANAGERS</td>
1.156 leot 14141: </tr>
14142: <tr>
1.242 gutterid 14143: <td>WRAPPER_CC</td>
1.244 gutterid 14144: <td>WRAPPER_REORDER_CMDS</td>
1.156 leot 14145: </tr>
14146: <tr>
1.242 gutterid 14147: <td>WRKDIR</td>
1.244 gutterid 14148: <td>WRKDIR_BASENAME</td>
1.156 leot 14149: </tr>
14150: <tr>
1.242 gutterid 14151: <td>WRKDIR_LOCKTYPE</td>
1.244 gutterid 14152: <td>WRKLOG</td>
1.156 leot 14153: </tr>
14154: <tr>
1.242 gutterid 14155: <td>WRKOBJDIR</td>
1.244 gutterid 14156: <td>WRKSRC</td>
1.156 leot 14157: </tr>
14158: <tr>
1.242 gutterid 14159: <td>X10_PORT</td>
1.244 gutterid 14160: <td>X11</td>
1.156 leot 14161: </tr>
14162: <tr>
1.242 gutterid 14163: <td>X11BASE</td>
1.244 gutterid 14164: <td>X11_PKGSRCDIR</td>
1.156 leot 14165: </tr>
14166: <tr>
1.242 gutterid 14167: <td>X11_TYPE</td>
1.244 gutterid 14168: <td>X509_CERTIFICATE</td>
1.156 leot 14169: </tr>
14170: <tr>
1.242 gutterid 14171: <td>X509_KEY</td>
1.244 gutterid 14172: <td>XAW_TYPE</td>
1.189 bacon 14173: </tr>
14174: <tr>
1.242 gutterid 14175: <td>XLOCK_DEFAULT_MODE</td>
1.244 gutterid 14176: <td>XMKMF</td>
1.156 leot 14177: </tr>
14178: <tr>
1.242 gutterid 14179: <td>XMKMF_FLAGS</td>
1.244 gutterid 14180: <td>XXX</td>
1.156 leot 14181: </tr>
14182: <tr>
1.239 dholland 14183: <td>YES</td>
1.244 gutterid 14184: <td>ZSH_STATIC</td>
1.233 wiz 14185: </tr>
14186: <tr>
1.239 dholland 14187: <td>__stdc__</td>
1.244 gutterid 14188: <td>_vargroups</td>
1.156 leot 14189: </tr>
14190: <tr>
1.239 dholland 14191: <td>accept</td>
1.244 gutterid 14192: <td>acquire-localbase-lock</td>
1.227 wiz 14193: </tr>
14194: <tr>
1.239 dholland 14195: <td>acquire-lock</td>
1.244 gutterid 14196: <td>add</td>
1.156 leot 14197: </tr>
14198: <tr>
1.239 dholland 14199: <td>added</td>
1.244 gutterid 14200: <td>administrator</td>
1.159 rillig 14201: </tr>
14202: <tr>
1.239 dholland 14203: <td>alloca</td>
1.244 gutterid 14204: <td>alternatives</td>
1.217 rillig 14205: </tr>
14206: <tr>
1.239 dholland 14207: <td>aslr</td>
1.244 gutterid 14208: <td>asprintf</td>
1.156 leot 14209: </tr>
14210: <tr>
1.239 dholland 14211: <td>atlas</td>
1.244 gutterid 14212: <td>autoconf</td>
1.201 cirnatda 14213: </tr>
14214: <tr>
1.239 dholland 14215: <td>automake</td>
1.244 gutterid 14216: <td>autoreconf</td>
1.174 leot 14217: </tr>
14218: <tr>
1.239 dholland 14219: <td>awk</td>
1.244 gutterid 14220: <td>bash</td>
1.156 leot 14221: </tr>
14222: <tr>
1.239 dholland 14223: <td>big-endian</td>
1.244 gutterid 14224: <td>bin-install</td>
1.156 leot 14225: </tr>
14226: <tr>
1.239 dholland 14227: <td>bind</td>
1.244 gutterid 14228: <td>binpkg-list</td>
1.174 leot 14229: </tr>
14230: <tr>
1.239 dholland 14231: <td>blas</td>
1.244 gutterid 14232: <td>bootstrap-depends</td>
1.156 leot 14233: </tr>
14234: <tr>
1.239 dholland 14235: <td>broken</td>
1.244 gutterid 14236: <td>broken_on_platform</td>
1.161 leot 14237: </tr>
14238: <tr>
1.239 dholland 14239: <td>bsd</td>
1.244 gutterid 14240: <td>bsd.prog.mk</td>
1.156 leot 14241: </tr>
14242: <tr>
1.239 dholland 14243: <td>build</td>
1.244 gutterid 14244: <td>build-env</td>
1.156 leot 14245: </tr>
14246: <tr>
1.239 dholland 14247: <td>buildlink-directories</td>
1.244 gutterid 14248: <td>buildlink-oss-soundcard-h</td>
1.156 leot 14249: </tr>
14250: <tr>
1.242 gutterid 14251: <td>built-in</td>
1.244 gutterid 14252: <td>builtin</td>
1.242 gutterid 14253: </tr>
14254: <tr>
1.239 dholland 14255: <td>c</td>
1.244 gutterid 14256: <td>c++</td>
1.177 leot 14257: </tr>
14258: <tr>
1.239 dholland 14259: <td>ccache</td>
1.244 gutterid 14260: <td>cce</td>
1.159 rillig 14261: </tr>
14262: <tr>
1.239 dholland 14263: <td>cdefs</td>
1.244 gutterid 14264: <td>ceil</td>
1.156 leot 14265: </tr>
14266: <tr>
1.239 dholland 14267: <td>changes</td>
1.244 gutterid 14268: <td>changes-entry</td>
1.174 leot 14269: </tr>
14270: <tr>
1.239 dholland 14271: <td>changes-entry-noupdate</td>
1.244 gutterid 14272: <td>check</td>
1.156 leot 14273: </tr>
14274: <tr>
1.239 dholland 14275: <td>check-clean</td>
1.244 gutterid 14276: <td>check-files</td>
1.156 leot 14277: </tr>
14278: <tr>
1.239 dholland 14279: <td>check-files-clean</td>
1.244 gutterid 14280: <td>check-vulnerable</td>
1.156 leot 14281: </tr>
14282: <tr>
1.239 dholland 14283: <td>checksum</td>
1.244 gutterid 14284: <td>checksum-phase</td>
1.156 leot 14285: </tr>
14286: <tr>
1.239 dholland 14287: <td>clean</td>
1.244 gutterid 14288: <td>clean-depends</td>
1.174 leot 14289: </tr>
14290: <tr>
1.239 dholland 14291: <td>cleandir</td>
1.244 gutterid 14292: <td>commit</td>
1.156 leot 14293: </tr>
14294: <tr>
1.239 dholland 14295: <td>commit-changes-entry</td>
1.244 gutterid 14296: <td>compact</td>
1.156 leot 14297: </tr>
14298: <tr>
1.239 dholland 14299: <td>compiler</td>
1.244 gutterid 14300: <td>conf</td>
1.156 leot 14301: </tr>
14302: <tr>
1.239 dholland 14303: <td>config.guess</td>
1.244 gutterid 14304: <td>config.sub</td>
1.156 leot 14305: </tr>
14306: <tr>
1.239 dholland 14307: <td>configuration</td>
1.244 gutterid 14308: <td>configure</td>
1.156 leot 14309: </tr>
14310: <tr>
1.239 dholland 14311: <td>configure-env</td>
1.244 gutterid 14312: <td>configure-help</td>
1.156 leot 14313: </tr>
14314: <tr>
1.239 dholland 14315: <td>configure_args</td>
1.244 gutterid 14316: <td>connect</td>
1.156 leot 14317: </tr>
14318: <tr>
1.239 dholland 14319: <td>cos</td>
1.244 gutterid 14320: <td>cpe</td>
1.156 leot 14321: </tr>
14322: <tr>
1.239 dholland 14323: <td>cputime</td>
1.244 gutterid 14324: <td>create-usergroup</td>
1.156 leot 14325: </tr>
14326: <tr>
1.239 dholland 14327: <td>csh</td>
1.244 gutterid 14328: <td>ctf</td>
1.156 leot 14329: </tr>
14330: <tr>
1.242 gutterid 14331: <td>debug</td>
1.244 gutterid 14332: <td>declaration</td>
1.241 rillig 14333: </tr>
14334: <tr>
1.242 gutterid 14335: <td>declare</td>
1.244 gutterid 14336: <td>defined</td>
1.238 wiz 14337: </tr>
14338: <tr>
1.242 gutterid 14339: <td>depend</td>
1.244 gutterid 14340: <td>dependencies</td>
1.223 nia 14341: </tr>
14342: <tr>
1.242 gutterid 14343: <td>depends</td>
1.244 gutterid 14344: <td>depends-checksum</td>
1.174 leot 14345: </tr>
14346: <tr>
1.242 gutterid 14347: <td>depends-fetch</td>
1.244 gutterid 14348: <td>deps</td>
1.214 leot 14349: </tr>
14350: <tr>
1.242 gutterid 14351: <td>describe</td>
1.244 gutterid 14352: <td>destdir</td>
1.205 wiz 14353: </tr>
14354: <tr>
1.242 gutterid 14355: <td>disable</td>
1.244 gutterid 14356: <td>distclean</td>
1.161 leot 14357: </tr>
14358: <tr>
1.242 gutterid 14359: <td>distinfo</td>
1.244 gutterid 14360: <td>dl</td>
1.197 leot 14361: </tr>
14362: <tr>
1.242 gutterid 14363: <td>dlopen</td>
1.244 gutterid 14364: <td>do-buildlink</td>
1.156 leot 14365: </tr>
14366: <tr>
1.242 gutterid 14367: <td>do-clean</td>
1.244 gutterid 14368: <td>do-configure</td>
1.156 leot 14369: </tr>
14370: <tr>
1.242 gutterid 14371: <td>do-configure-post-hook</td>
1.244 gutterid 14372: <td>do-extract</td>
1.156 leot 14373: </tr>
14374: <tr>
1.242 gutterid 14375: <td>do-fetch</td>
1.244 gutterid 14376: <td>do-install</td>
1.156 leot 14377: </tr>
14378: <tr>
1.242 gutterid 14379: <td>emul</td>
1.244 gutterid 14380: <td>emul-distinfo</td>
1.156 leot 14381: </tr>
14382: <tr>
1.242 gutterid 14383: <td>emul-fetch</td>
1.244 gutterid 14384: <td>emulation</td>
1.162 rillig 14385: </tr>
14386: <tr>
1.242 gutterid 14387: <td>emulator</td>
1.244 gutterid 14388: <td>enable</td>
1.156 leot 14389: </tr>
14390: <tr>
1.238 wiz 14391: <td>endian</td>
1.244 gutterid 14392: <td>enomem</td>
1.233 wiz 14393: </tr>
14394: <tr>
1.239 dholland 14395: <td>ensurepip</td>
1.244 gutterid 14396: <td>err</td>
1.156 leot 14397: </tr>
14398: <tr>
1.239 dholland 14399: <td>errx</td>
1.244 gutterid 14400: <td>etc</td>
1.227 wiz 14401: </tr>
14402: <tr>
1.239 dholland 14403: <td>exp</td>
1.244 gutterid 14404: <td>extract-rpm</td>
1.214 leot 14405: </tr>
14406: <tr>
1.239 dholland 14407: <td>fabs</td>
1.244 gutterid 14408: <td>feature</td>
1.156 leot 14409: </tr>
14410: <tr>
1.239 dholland 14411: <td>features</td>
1.244 gutterid 14412: <td>fetch</td>
1.205 wiz 14413: </tr>
14414: <tr>
1.239 dholland 14415: <td>fetch-list</td>
1.244 gutterid 14416: <td>follows</td>
1.197 leot 14417: </tr>
14418: <tr>
1.239 dholland 14419: <td>forbids</td>
1.244 gutterid 14420: <td>form</td>
1.156 leot 14421: </tr>
14422: <tr>
1.239 dholland 14423: <td>format</td>
1.244 gutterid 14424: <td>fortify</td>
1.156 leot 14425: </tr>
14426: <tr>
1.237 gutterid 14427: <td>fortify_source</td>
1.244 gutterid 14428: <td>friend</td>
1.238 wiz 14429: </tr>
14430: <tr>
1.242 gutterid 14431: <td>fts</td>
1.244 gutterid 14432: <td>fts_close</td>
1.241 rillig 14433: </tr>
14434: <tr>
1.242 gutterid 14435: <td>fts_open</td>
1.244 gutterid 14436: <td>fts_read</td>
1.217 rillig 14437: </tr>
14438: <tr>
1.242 gutterid 14439: <td>fts_set</td>
1.244 gutterid 14440: <td>gcc</td>
1.223 nia 14441: </tr>
14442: <tr>
1.242 gutterid 14443: <td>gethostbyaddr</td>
1.244 gutterid 14444: <td>gethostbyname</td>
1.156 leot 14445: </tr>
14446: <tr>
1.242 gutterid 14447: <td>gethostbyname2</td>
1.244 gutterid 14448: <td>getopt_long</td>
1.156 leot 14449: </tr>
14450: <tr>
1.242 gutterid 14451: <td>getprogname</td>
1.244 gutterid 14452: <td>getservbyname</td>
1.156 leot 14453: </tr>
14454: <tr>
1.242 gutterid 14455: <td>getservbyport</td>
1.244 gutterid 14456: <td>getservent</td>
1.156 leot 14457: </tr>
14458: <tr>
1.238 wiz 14459: <td>gettext</td>
1.244 gutterid 14460: <td>github</td>
1.233 wiz 14461: </tr>
14462: <tr>
1.239 dholland 14463: <td>gitlab</td>
1.244 gutterid 14464: <td>glob</td>
1.174 leot 14465: </tr>
14466: <tr>
1.239 dholland 14467: <td>gnu</td>
1.244 gutterid 14468: <td>gnu_configure_strict</td>
1.227 wiz 14469: </tr>
14470: <tr>
1.239 dholland 14471: <td>go</td>
1.244 gutterid 14472: <td>go-deps</td>
1.223 nia 14473: </tr>
14474: <tr>
1.239 dholland 14475: <td>golang</td>
1.244 gutterid 14476: <td>guess-license</td>
1.217 rillig 14477: </tr>
14478: <tr>
1.239 dholland 14479: <td>hashbang</td>
1.244 gutterid 14480: <td>heimdal</td>
1.156 leot 14481: </tr>
14482: <tr>
1.237 gutterid 14483: <td>help</td>
1.244 gutterid 14484: <td>imake</td>
1.238 wiz 14485: </tr>
14486: <tr>
1.242 gutterid 14487: <td>in-tree</td>
1.244 gutterid 14488: <td>increment</td>
1.241 rillig 14489: </tr>
14490: <tr>
14491: <td>indirect</td>
1.244 gutterid 14492: <td>inet_aton</td>
1.156 leot 14493: </tr>
14494: <tr>
1.241 rillig 14495: <td>interp</td>
1.244 gutterid 14496: <td>interpreter</td>
1.214 leot 14497: </tr>
14498: <tr>
1.241 rillig 14499: <td>intl</td>
1.244 gutterid 14500: <td>ip4</td>
1.156 leot 14501: </tr>
14502: <tr>
1.241 rillig 14503: <td>ip6</td>
1.244 gutterid 14504: <td>ipv4</td>
1.205 wiz 14505: </tr>
14506: <tr>
1.241 rillig 14507: <td>ipv6</td>
1.244 gutterid 14508: <td>iso</td>
1.197 leot 14509: </tr>
14510: <tr>
1.241 rillig 14511: <td>kerberos</td>
1.244 gutterid 14512: <td>krb</td>
1.161 leot 14513: </tr>
14514: <tr>
1.241 rillig 14515: <td>krb5</td>
1.244 gutterid 14516: <td>ksh</td>
1.156 leot 14517: </tr>
14518: <tr>
1.241 rillig 14519: <td>lapack</td>
1.244 gutterid 14520: <td>latex</td>
1.156 leot 14521: </tr>
14522: <tr>
1.241 rillig 14523: <td>libintl_bindtextdomain</td>
1.244 gutterid 14524: <td>libintl_gettext</td>
1.156 leot 14525: </tr>
14526: <tr>
1.241 rillig 14527: <td>libintl_textdomain</td>
1.244 gutterid 14528: <td>libnbcompat</td>
1.189 bacon 14529: </tr>
14530: <tr>
1.241 rillig 14531: <td>libs</td>
1.244 gutterid 14532: <td>libtool</td>
1.189 bacon 14533: </tr>
14534: <tr>
1.241 rillig 14535: <td>licence</td>
1.244 gutterid 14536: <td>license</td>
1.156 leot 14537: </tr>
14538: <tr>
1.241 rillig 14539: <td>lintl</td>
1.244 gutterid 14540: <td>little-endian</td>
1.177 leot 14541: </tr>
14542: <tr>
1.241 rillig 14543: <td>lock</td>
1.244 gutterid 14544: <td>locking</td>
1.156 leot 14545: </tr>
14546: <tr>
1.241 rillig 14547: <td>lua</td>
1.244 gutterid 14548: <td>lvalue</td>
1.174 leot 14549: </tr>
14550: <tr>
1.241 rillig 14551: <td>make</td>
1.244 gutterid 14552: <td>makesum</td>
1.159 rillig 14553: </tr>
14554: <tr>
1.241 rillig 14555: <td>memory</td>
1.244 gutterid 14556: <td>meta</td>
1.156 leot 14557: </tr>
14558: <tr>
1.242 gutterid 14559: <td>meta-package</td>
1.244 gutterid 14560: <td>meta_package</td>
1.233 wiz 14561: </tr>
14562: <tr>
1.242 gutterid 14563: <td>mit-krb5</td>
1.244 gutterid 14564: <td>mk.conf</td>
1.227 wiz 14565: </tr>
14566: <tr>
1.242 gutterid 14567: <td>mkl</td>
1.244 gutterid 14568: <td>mount</td>
1.156 leot 14569: </tr>
14570: <tr>
1.242 gutterid 14571: <td>move</td>
1.244 gutterid 14572: <td>moved</td>
1.156 leot 14573: </tr>
14574: <tr>
1.242 gutterid 14575: <td>mprotect</td>
1.244 gutterid 14576: <td>mremap</td>
1.177 leot 14577: </tr>
14578: <tr>
1.242 gutterid 14579: <td>native</td>
1.244 gutterid 14580: <td>nb</td>
1.159 rillig 14581: </tr>
14582: <tr>
1.239 dholland 14583: <td>nbcompat</td>
1.244 gutterid 14584: <td>netlib</td>
1.226 gutterid 14585: </tr>
14586: <tr>
1.239 dholland 14587: <td>node</td>
1.244 gutterid 14588: <td>node.js</td>
1.156 leot 14589: </tr>
14590: <tr>
1.239 dholland 14591: <td>nodejs</td>
1.244 gutterid 14592: <td>obstack</td>
1.156 leot 14593: </tr>
14594: <tr>
1.239 dholland 14595: <td>obstack_ptr_grow</td>
1.244 gutterid 14596: <td>occurs</td>
1.218 nia 14597: </tr>
14598: <tr>
1.239 dholland 14599: <td>only</td>
1.244 gutterid 14600: <td>openblas</td>
1.218 nia 14601: </tr>
14602: <tr>
1.239 dholland 14603: <td>options</td>
1.244 gutterid 14604: <td>options.mk</td>
1.205 wiz 14605: </tr>
14606: <tr>
1.239 dholland 14607: <td>order</td>
1.244 gutterid 14608: <td>override</td>
1.156 leot 14609: </tr>
14610: <tr>
1.239 dholland 14611: <td>override-intltool</td>
1.244 gutterid 14612: <td>override-message-intltool</td>
1.161 leot 14613: </tr>
14614: <tr>
1.239 dholland 14615: <td>package</td>
1.244 gutterid 14616: <td>parallel</td>
1.156 leot 14617: </tr>
14618: <tr>
1.239 dholland 14619: <td>path</td>
1.244 gutterid 14620: <td>pax</td>
1.156 leot 14621: </tr>
14622: <tr>
1.239 dholland 14623: <td>paxctl</td>
1.244 gutterid 14624: <td>pbulk-index</td>
1.156 leot 14625: </tr>
14626: <tr>
1.239 dholland 14627: <td>pc</td>
1.244 gutterid 14628: <td>perl</td>
1.156 leot 14629: </tr>
14630: <tr>
1.239 dholland 14631: <td>perl5</td>
1.244 gutterid 14632: <td>perms</td>
1.156 leot 14633: </tr>
14634: <tr>
1.239 dholland 14635: <td>php</td>
1.244 gutterid 14636: <td>pkg-build-options</td>
1.156 leot 14637: </tr>
14638: <tr>
1.239 dholland 14639: <td>pkg-config</td>
1.244 gutterid 14640: <td>pkg_build_options</td>
1.156 leot 14641: </tr>
14642: <tr>
1.242 gutterid 14643: <td>pkgsrc</td>
1.244 gutterid 14644: <td>platform</td>
1.156 leot 14645: </tr>
14646: <tr>
1.229 gutterid 14647: <td>plist</td>
1.244 gutterid 14648: <td>post-extract</td>
1.156 leot 14649: </tr>
14650: <tr>
1.229 gutterid 14651: <td>post-fetch</td>
1.244 gutterid 14652: <td>post-wrapper</td>
1.156 leot 14653: </tr>
14654: <tr>
1.229 gutterid 14655: <td>pre-build-checks-hook</td>
1.244 gutterid 14656: <td>pre-configure-checks-hook</td>
1.156 leot 14657: </tr>
14658: <tr>
1.233 wiz 14659: <td>pre-extract</td>
1.244 gutterid 14660: <td>pre-fetch</td>
1.156 leot 14661: </tr>
14662: <tr>
1.233 wiz 14663: <td>print-go-deps</td>
1.244 gutterid 14664: <td>print-plist</td>
1.156 leot 14665: </tr>
14666: <tr>
1.233 wiz 14667: <td>print-summary-data</td>
1.244 gutterid 14668: <td>privileged-install-hook</td>
1.174 leot 14669: </tr>
14670: <tr>
1.233 wiz 14671: <td>pypi</td>
1.244 gutterid 14672: <td>python</td>
1.156 leot 14673: </tr>
14674: <tr>
1.233 wiz 14675: <td>r</td>
1.244 gutterid 14676: <td>readme-all</td>
1.156 leot 14677: </tr>
14678: <tr>
1.233 wiz 14679: <td>recursive</td>
1.244 gutterid 14680: <td>recv</td>
1.156 leot 14681: </tr>
14682: <tr>
1.233 wiz 14683: <td>recvfrom</td>
1.244 gutterid 14684: <td>regcomp</td>
1.156 leot 14685: </tr>
14686: <tr>
1.233 wiz 14687: <td>release-localbase-lock</td>
1.244 gutterid 14688: <td>release-lock</td>
1.156 leot 14689: </tr>
14690: <tr>
1.233 wiz 14691: <td>relro</td>
1.244 gutterid 14692: <td>remove</td>
1.174 leot 14693: </tr>
14694: <tr>
1.233 wiz 14695: <td>removed</td>
1.244 gutterid 14696: <td>rename</td>
1.174 leot 14697: </tr>
14698: <tr>
1.233 wiz 14699: <td>renamed</td>
1.244 gutterid 14700: <td>reorder</td>
1.156 leot 14701: </tr>
14702: <tr>
1.233 wiz 14703: <td>replace</td>
1.244 gutterid 14704: <td>replace_interpreter</td>
1.226 gutterid 14705: </tr>
14706: <tr>
1.233 wiz 14707: <td>reproducible</td>
1.244 gutterid 14708: <td>resolv</td>
1.226 gutterid 14709: </tr>
14710: <tr>
1.233 wiz 14711: <td>root</td>
1.244 gutterid 14712: <td>ruby</td>
1.156 leot 14713: </tr>
14714: <tr>
1.233 wiz 14715: <td>send</td>
1.244 gutterid 14716: <td>sendfile</td>
1.156 leot 14717: </tr>
14718: <tr>
1.233 wiz 14719: <td>sendto</td>
1.244 gutterid 14720: <td>setenv</td>
1.156 leot 14721: </tr>
14722: <tr>
1.233 wiz 14723: <td>setgid</td>
1.244 gutterid 14724: <td>setprogname</td>
1.174 leot 14725: </tr>
14726: <tr>
1.233 wiz 14727: <td>setuid</td>
1.244 gutterid 14728: <td>sh</td>
1.156 leot 14729: </tr>
14730: <tr>
1.233 wiz 14731: <td>shebang</td>
1.244 gutterid 14732: <td>show</td>
1.156 leot 14733: </tr>
14734: <tr>
1.233 wiz 14735: <td>show-all</td>
1.244 gutterid 14736: <td>show-build-defs</td>
1.156 leot 14737: </tr>
14738: <tr>
1.233 wiz 14739: <td>show-depends</td>
1.244 gutterid 14740: <td>show-depends-dirs</td>
1.156 leot 14741: </tr>
14742: <tr>
1.233 wiz 14743: <td>show-depends-pkgpaths</td>
1.244 gutterid 14744: <td>show-depends-recursive</td>
1.181 rillig 14745: </tr>
14746: <tr>
1.233 wiz 14747: <td>show-deps</td>
1.244 gutterid 14748: <td>show-distfiles</td>
1.156 leot 14749: </tr>
14750: <tr>
1.233 wiz 14751: <td>show-downlevel</td>
1.244 gutterid 14752: <td>show-subdir-var</td>
1.222 gutterid 14753: </tr>
14754: <tr>
1.233 wiz 14755: <td>show-tools</td>
1.244 gutterid 14756: <td>show-var</td>
1.223 nia 14757: </tr>
14758: <tr>
1.233 wiz 14759: <td>show-vars</td>
1.244 gutterid 14760: <td>snprintf</td>
1.156 leot 14761: </tr>
14762: <tr>
1.233 wiz 14763: <td>socket</td>
1.244 gutterid 14764: <td>ssp</td>
1.156 leot 14765: </tr>
14766: <tr>
1.233 wiz 14767: <td>st_mode</td>
1.244 gutterid 14768: <td>stage-install</td>
1.156 leot 14769: </tr>
14770: <tr>
1.233 wiz 14771: <td>strcasestr</td>
1.244 gutterid 14772: <td>strict</td>
1.156 leot 14773: </tr>
14774: <tr>
1.233 wiz 14775: <td>strip</td>
1.244 gutterid 14776: <td>strndup</td>
1.174 leot 14777: </tr>
14778: <tr>
1.233 wiz 14779: <td>strnlen</td>
1.244 gutterid 14780: <td>strsep</td>
1.156 leot 14781: </tr>
14782: <tr>
1.233 wiz 14783: <td>subst</td>
1.244 gutterid 14784: <td>substitutions</td>
1.238 wiz 14785: </tr>
14786: <tr>
1.226 gutterid 14787: <td>sun</td>
1.244 gutterid 14788: <td>sunpro</td>
1.241 rillig 14789: </tr>
14790: <tr>
14791: <td>sunwspro</td>
1.244 gutterid 14792: <td>symlink</td>
1.214 leot 14793: </tr>
14794: <tr>
1.242 gutterid 14795: <td>test</td>
1.244 gutterid 14796: <td>test-env</td>
1.212 wiz 14797: </tr>
14798: <tr>
1.242 gutterid 14799: <td>tex</td>
1.244 gutterid 14800: <td>texlive</td>
1.227 wiz 14801: </tr>
14802: <tr>
1.242 gutterid 14803: <td>tmp</td>
1.244 gutterid 14804: <td>todo</td>
1.223 nia 14805: </tr>
14806: <tr>
1.242 gutterid 14807: <td>tool</td>
1.244 gutterid 14808: <td>tools</td>
1.161 leot 14809: </tr>
14810: <tr>
1.242 gutterid 14811: <td>tools-libtool-m4-override</td>
1.244 gutterid 14812: <td>transitive</td>
1.156 leot 14813: </tr>
14814: <tr>
1.242 gutterid 14815: <td>type</td>
1.244 gutterid 14816: <td>ulimit</td>
1.156 leot 14817: </tr>
14818: <tr>
1.242 gutterid 14819: <td>undefined</td>
1.244 gutterid 14820: <td>undo-replace</td>
1.156 leot 14821: </tr>
14822: <tr>
1.242 gutterid 14823: <td>unlimit</td>
1.244 gutterid 14824: <td>unprivileged</td>
1.156 leot 14825: </tr>
14826: <tr>
1.242 gutterid 14827: <td>unprivileged-install-hook</td>
1.244 gutterid 14828: <td>unstripped</td>
1.156 leot 14829: </tr>
14830: <tr>
1.242 gutterid 14831: <td>update</td>
1.244 gutterid 14832: <td>updated</td>
1.156 leot 14833: </tr>
14834: <tr>
1.242 gutterid 14835: <td>upload</td>
1.244 gutterid 14836: <td>upload-distfiles</td>
1.156 leot 14837: </tr>
14838: <tr>
1.242 gutterid 14839: <td>use_tools</td>
1.244 gutterid 14840: <td>user</td>
1.156 leot 14841: </tr>
14842: <tr>
1.242 gutterid 14843: <td>utimes</td>
1.244 gutterid 14844: <td>vasprintf</td>
1.156 leot 14845: </tr>
14846: <tr>
1.242 gutterid 14847: <td>verbose</td>
1.244 gutterid 14848: <td>vsnprintf</td>
1.156 leot 14849: </tr>
14850: <tr>
1.242 gutterid 14851: <td>warn</td>
1.244 gutterid 14852: <td>warning</td>
1.156 leot 14853: </tr>
14854: <tr>
1.242 gutterid 14855: <td>warnings</td>
1.244 gutterid 14856: <td>warnx</td>
1.156 leot 14857: </tr>
14858: <tr>
1.242 gutterid 14859: <td>wattr_off</td>
1.244 gutterid 14860: <td>wattr_on</td>
1.156 leot 14861: </tr>
14862: <tr>
1.242 gutterid 14863: <td>work</td>
1.244 gutterid 14864: <td>wrapper</td>
1.156 leot 14865: </tr>
14866: <tr>
1.174 leot 14867: <td>wrkdir</td>
1.244 gutterid 14868: <td> </td>
1.156 leot 14869: </tr>
14870: </table>
1.154 rillig 14871: </div>
14872: <div class="appendix">
14873: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 14874: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 14875: <div class="toc">
14876: <p><b>Table of Contents</b></p>
1.100 leot 14877: <dl class="toc">
1.207 leot 14878: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
14879: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 14880: </dl>
14881: </div>
14882: <p>This section contains information on editing the pkgsrc
14883: guide itself.</p>
1.41 asau 14884: <div class="sect1">
1.1 dsieger 14885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 14886: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.1 dsieger 14887: <p>The pkgsrc guide's source code is stored in
14888: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
14889: are created from it:</p>
1.41 asau 14890: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 14891: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
14892: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174 leot 14893: <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>
14894: <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 14895: The PDF version of the pkgsrc guide.</p></li>
1.174 leot 14896: <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 14897: PostScript version of the pkgsrc guide.</p></li>
14898: </ul></div>
14899: </div>
1.41 asau 14900: <div class="sect1">
1.1 dsieger 14901: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 14902: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.1 dsieger 14903: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 14904: <div class="procedure"><ol class="procedure" type="1">
1.190 bacon 14905: <li class="step"><p>Make sure you have checked out the htdocs repository
14906: into a sibling directory of your pkgsrc directory. You will need
14907: the ability to commit from both pkgsrc and htdocs.</p></li>
1.41 asau 14908: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 14909: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 14910: documentation) installed. These are automatically installed when
1.207 leot 14911: you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/index.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.41 asau 14912: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 14913: right directory. All further steps will take place
14914: here.</p></li>
1.41 asau 14915: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 14916: <code class="filename">files/</code>.</p></li>
1.41 asau 14917: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 14918: guide for valid XML and to build the final output files. If you
14919: get any errors at this stage, you can just edit the files, as
14920: there are only symbolic links in the working directory, pointing
14921: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 14922: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 14923: commit)</strong></span></p></li>
1.41 asau 14924: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 14925: regenerate the output files with the proper RCS
14926: Ids.</p></li>
1.41 asau 14927: <li class="step">
1.10 hubertf 14928: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 14929: commit the files in both <code class="filename">pkgsrc/doc</code> and
14930: <code class="filename">htdocs</code>.</p>
1.41 asau 14931: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 14932: <h3 class="title">Note</h3>
14933: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 14934: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
14935: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 14936: directory.</p>
14937: </div>
14938: </li>
14939: </ol></div>
14940: </div>
14941: </div>
14942: </div></body>
14943: </html>
CVSweb <webmaster@jp.NetBSD.org>