Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.255
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.252 jnemeth 33: <div><p class="copyright">Copyright © 1994-2024 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.43 2024/01/02 07:26:32 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.254 wiz 364: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
365: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
366: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
367: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
368: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
369: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
370: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
371: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
372: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
373: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 374: emulation</a></span></dt>
1.254 wiz 375: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
376: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 377: </dl></dd>
1.154 rillig 378: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 379: </dl></dd>
1.184 rillig 380: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
381: <dd><dl>
382: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
383: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
384: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
385: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
386: </dl></dd>
1.154 rillig 387: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 388: <dd><dl>
1.154 rillig 389: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
390: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
391: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
392: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
393: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
394: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
395: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
396: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
397: </dl></dd>
398: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 399: </dl></dd>
400: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
401: <dd><dl>
1.184 rillig 402: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 403: <dd><dl>
1.184 rillig 404: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
406: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 407: <dd><dl>
1.184 rillig 408: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
409: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 410: </dl></dd>
1.184 rillig 411: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
412: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 413: <dd><dl>
1.184 rillig 414: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
415: <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 416: </dl></dd>
1.184 rillig 417: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 418: <dd><dl>
1.184 rillig 419: <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>
420: <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 421: </dl></dd>
422: </dl></dd>
1.184 rillig 423: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 424: <dd><dl>
1.184 rillig 425: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
426: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 427: <dd><dl>
1.184 rillig 428: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
429: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 430: </dl></dd>
431: </dl></dd>
1.184 rillig 432: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
433: <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 434: </dl></dd>
435: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
436: <dd><dl>
437: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
438: <dd><dl>
439: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
440: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
441: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 442: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 443: </dl></dd>
444: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
445: </dl></dd>
1.207 leot 446: <dt><span class="appendix"><a href="#hardening">B. Security hardening</a></span></dt>
1.1 dsieger 447: <dd><dl>
1.207 leot 448: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
449: <dd><dl>
450: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
451: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
452: </dl></dd>
453: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
454: <dd><dl>
455: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
456: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
457: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
458: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
459: </dl></dd>
460: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
461: <dd><dl>
462: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
463: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
464: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
465: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
466: </dl></dd>
467: </dl></dd>
468: <dt><span class="appendix"><a href="#logs">C. Build logs</a></span></dt>
469: <dd><dl>
470: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
471: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
1.1 dsieger 472: </dl></dd>
1.207 leot 473: <dt><span class="appendix"><a href="#ftp-layout">D. Directory layout of the pkgsrc FTP server</a></span></dt>
1.1 dsieger 474: <dd><dl>
1.207 leot 475: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
476: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
477: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
478: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
479: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
1.148 leot 480: <code class="filename">stable</code>,
1.23 wiz 481: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 482: source packages</a></span></dt>
483: </dl></dd>
1.207 leot 484: <dt><span class="appendix"><a href="#help-topics">E. Help topics</a></span></dt>
485: <dt><span class="appendix"><a href="#editing">F. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1 dsieger 486: <dd><dl>
1.207 leot 487: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
488: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 489: </dl></dd>
490: </dl>
491: </div>
492: <div class="list-of-tables">
493: <p><b>List of Tables</b></p>
494: <dl>
495: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
496: </dt>
1.184 rillig 497: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 498: </dt>
1.184 rillig 499: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 500: </dt>
501: </dl>
502: </div>
1.41 asau 503: <div class="chapter">
504: <div class="titlepage"><div><div><h1 class="title">
505: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 506: <div class="toc">
507: <p><b>Table of Contents</b></p>
1.100 leot 508: <dl class="toc">
1.1 dsieger 509: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
510: <dd><dl>
511: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
512: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
513: </dl></dd>
514: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
515: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
516: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
517: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
518: </dl>
519: </div>
1.41 asau 520: <div class="sect1">
1.1 dsieger 521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
522: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
523: <p>There is a lot of software freely available for Unix-based
524: systems, which is usually available in form of the source code. Before
525: such software can be used, it needs to be configured to the local
526: system, compiled and installed, and this is exactly what The NetBSD
527: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
528: to handle binary packages, so that not every user has to build the
529: packages for himself, which is a time-costly task.</p>
530: <p>pkgsrc currently contains several thousand packages,
531: including:</p>
1.41 asau 532: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 533: <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 534: web server</p></li>
1.207 leot 535: <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 536: web browser</p></li>
1.207 leot 537: <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 538: Desktop Environment</p></li>
1.207 leot 539: <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 540: Desktop Environment</p></li>
541: </ul></div>
1.108 rillig 542: <p>… just to name a few.</p>
1.1 dsieger 543: <p>pkgsrc has built-in support for handling varying dependencies,
544: such as pthreads and X11, and extended features such as IPv6 support on
545: a range of platforms.</p>
1.41 asau 546: <div class="sect2">
1.1 dsieger 547: <div class="titlepage"><div><div><h3 class="title">
548: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
549: <p>
550: pkgsrc provides the following key features:
551: </p>
1.41 asau 552: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 553: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 554: and installation of binary packages. The source and latest
555: patches are retrieved from a master or mirror download site, checksum
556: verified, then built on your system. Support for binary-only
557: distributions is available for both native platforms and NetBSD
558: emulated platforms.</p></li>
1.23 wiz 559: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 560: including binaries, libraries, man pages and other
561: documentation.</p></li>
1.104 sevan 562: <li class="listitem"><p>Tracking of package dependencies automatically, including when
563: performing updates, to ensure required packages are installed. The
564: configuration files of various packages are handled automatically during
565: updates, so local changes are preserved.</p></li>
1.23 wiz 566: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 567: consists of highly portable code. This allows the greatest speed of
1.25 spz 568: development when porting to a new platform. This portability also
1.1 dsieger 569: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
570: platforms</em></span>.</p></li>
1.23 wiz 571: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 572: international encryption requirements and build-time options for a
573: large number of packages are all set in a simple, central
574: configuration file.</p></li>
1.23 wiz 575: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 576: freely available under a BSD license, so you may extend and adapt
577: pkgsrc to your needs. Support for local packages and patches is
578: available right out of the box, so you can configure it specifically
579: for your environment.</p></li>
580: </ul></div>
581: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 582: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 583: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 584: — That means, if a package contains bugs, it's better to find
1.1 dsieger 585: them and to complain about them rather than to just install the package
586: and hope that it works. There are numerous checks in pkgsrc that try to
1.207 leot 587: 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 588: of shell scripts), and post-installation checks (installed files,
589: references to shared libraries, script interpreters).</p></li>
1.23 wiz 590: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 591: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 592: pkgsrc has been ported to many operating systems. Care is taken that
593: packages behave the same on all platforms.</p></li>
594: </ul></div>
595: </div>
1.41 asau 596: <div class="sect2">
1.1 dsieger 597: <div class="titlepage"><div><div><h3 class="title">
598: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
599: <p>pkgsrc consists of both a source distribution and a binary
600: distribution for these operating systems. After retrieving the required
601: source or binaries, you can be up and running with pkgsrc in just
602: minutes!</p>
603: <p>pkgsrc was derived from FreeBSD's ports system, and
604: initially developed for NetBSD only. Since then, pkgsrc has
605: grown a lot, and now supports the following platforms:</p>
606: <div class="table">
607: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106 tnn 608: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1 dsieger 609: <colgroup>
610: <col>
611: <col>
1.92 sevan 612: <col>
1.1 dsieger 613: </colgroup>
614: <thead><tr>
615: <th>Platform</th>
616: <th>Date Support Added</th>
1.92 sevan 617: <th>Notes</th>
1.1 dsieger 618: </tr></thead>
619: <tbody>
620: <tr>
1.174 leot 621: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 622: <td align="center">Aug 1997</td>
1.92 sevan 623: <td class="auto-generated"> </td>
1.1 dsieger 624: </tr>
625: <tr>
1.10 hubertf 626: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 627: <td align="center">Mar 1999</td>
1.151 sevan 628: <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 629: </tr>
630: <tr>
1.174 leot 631: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 632: <td align="center">Jun 1999</td>
1.151 sevan 633: <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 634: </tr>
635: <tr>
636: <td>
1.118 sevan 637: <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1 dsieger 638: </td>
639: <td align="center">Oct 2001</td>
1.191 bacon 640: <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 641: </tr>
642: <tr>
1.174 leot 643: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 644: <td align="center">Nov 2002</td>
1.151 sevan 645: <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 646: </tr>
647: <tr>
1.174 leot 648: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 649: <td align="center">Nov 2002</td>
1.151 sevan 650: <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 651: </tr>
652: <tr>
1.174 leot 653: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 654: <td align="center">Dec 2002</td>
1.92 sevan 655: <td>
1.151 sevan 656: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
1.92 sevan 657: </td>
1.1 dsieger 658: </tr>
659: <tr>
660: <td>BSD/OS</td>
661: <td align="center">Dec 2003</td>
1.92 sevan 662: <td class="auto-generated"> </td>
1.1 dsieger 663: </tr>
664: <tr>
1.174 leot 665: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 666: <td align="center">Dec 2003</td>
1.151 sevan 667: <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 668: </tr>
669: <tr>
670: <td>
1.174 leot 671: <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 672: (Microsoft Windows Services for Unix)
673: </td>
674: <td align="center">Mar 2004</td>
1.151 sevan 675: <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 676: </tr>
677: <tr>
1.174 leot 678: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 679: <td align="center">Oct 2004</td>
1.92 sevan 680: <td class="auto-generated"> </td>
1.1 dsieger 681: </tr>
682: <tr>
1.10 hubertf 683: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 684: <td align="center">Nov 2004</td>
1.151 sevan 685: <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 686: </tr>
687: <tr>
1.174 leot 688: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 689: <td align="center">Apr 2007</td>
1.151 sevan 690: <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 691: </tr>
1.23 wiz 692: <tr>
1.174 leot 693: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23 wiz 694: <td align="center">Sep 2010</td>
1.151 sevan 695: <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 696: </tr>
1.45 obache 697: <tr>
1.174 leot 698: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 bsiegert 699: <td align="center">Jan 2011</td>
1.92 sevan 700: <td class="auto-generated"> </td>
1.45 obache 701: </tr>
702: <tr>
1.174 leot 703: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45 obache 704: <td align="center">Nov 2011</td>
1.151 sevan 705: <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 706: </tr>
707: <tr>
1.174 leot 708: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45 obache 709: <td align="center">Mar 2013</td>
1.151 sevan 710: <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 711: </tr>
1.58 ryoon 712: <tr>
1.174 leot 713: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58 ryoon 714: <td align="center">Jul 2013</td>
1.151 sevan 715: <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 716: </tr>
1.104 sevan 717: <tr>
1.174 leot 718: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104 sevan 719: <td align="center">Jun 2014</td>
1.229 gutterid 720: <td>Removed from pkgsrc Sep 2022</td>
1.104 sevan 721: </tr>
1.1 dsieger 722: </tbody>
723: </table></div>
724: </div>
725: <br class="table-break">
726: </div>
727: </div>
1.41 asau 728: <div class="sect1">
1.1 dsieger 729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
730: <a name="overview"></a>1.2. Overview</h2></div></div></div>
731: <p>This document is divided into three parts. The first,
1.10 hubertf 732: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 733: describes how one can use one of the packages in the Package
734: Collection, either by installing a precompiled binary package,
735: or by building one's own copy using the NetBSD package system.
1.10 hubertf 736: 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 737: package so it can be easily built by other NetBSD users without
738: knowing about the package's building details. The third part,
1.10 hubertf 739: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 740: is intended for those who want to understand how pkgsrc is
741: implemented.</p>
742: <p>This document is available in various formats:
1.10 hubertf 743: <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 744: </div>
1.41 asau 745: <div class="sect1">
1.1 dsieger 746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
747: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 748: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
749: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 750: terminology used within this document.</p>
1.41 asau 751: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 752: <dt><span class="term">Package</span></dt>
753: <dd><p>A set of files and building instructions
754: that describe what's necessary
755: to build a certain piece of software using
756: pkgsrc. Packages are traditionally stored under
1.123 wiz 757: <code class="filename">/usr/pkgsrc</code>,
758: but may be stored in any location,
759: referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1 dsieger 760: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 761: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 762: is part of the NetBSD operating system and can be bootstrapped
763: to run on non-NetBSD operating systems as well. It handles
764: building (compiling), installing, and removing of
765: packages.</p></dd>
766: <dt><span class="term">Distfile</span></dt>
767: <dd><p>This term describes the file or files that are
768: provided by the author of the piece of software to
769: distribute his work. All the changes necessary to build on
770: NetBSD are reflected in the corresponding package. Usually
771: the distfile is in the form of a compressed tar-archive,
772: but other types are possible, too. Distfiles are usually
773: stored below
774: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
775: <dt><span class="term">Port</span></dt>
776: <dd><p>This is the term used by FreeBSD and OpenBSD people
777: for what we call a package.
1.23 wiz 778: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 779: architecture.</p></dd>
780: <dt><span class="term">Precompiled/binary package</span></dt>
781: <dd>
782: <p>A set of binaries built with pkgsrc from a distfile
783: and stuffed together in a single <code class="filename">.tgz</code>
784: file so it can be installed on machines of the same
785: machine architecture without the need to
786: recompile. Packages are usually generated in
787: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 788: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 789: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 790: especially in the context of precompiled packages.</p>
791: </dd>
792: <dt><span class="term">Program</span></dt>
793: <dd><p>The piece of software to be installed which will be
794: constructed from all the files in the distfile by the
795: actions defined in the corresponding package.</p></dd>
796: </dl></div>
1.41 asau 797: <div class="sect2">
1.1 dsieger 798: <div class="titlepage"><div><div><h3 class="title">
799: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 800: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 801: <dt><span class="term">pkgsrc users</span></dt>
802: <dd>
803: <p>The
804: pkgsrc users are people who use the packages provided by pkgsrc.
805: Typically they are system administrators. The people using the
1.23 wiz 806: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
807: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 808: <p>There are two kinds of pkgsrc users: Some only want to
809: install pre-built binary packages. Others build the pkgsrc
810: packages from source, either for installing them directly or for
1.10 hubertf 811: 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 812: documentation.</p>
813: </dd>
814: <dt><span class="term">package maintainers</span></dt>
815: <dd><p>A
1.10 hubertf 816: 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 817: <dt><span class="term">infrastructure developers</span></dt>
818: <dd><p>These people are involved in all those files
819: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 820: 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 821: too.</p></dd>
822: </dl></div>
823: </div>
824: </div>
1.41 asau 825: <div class="sect1">
1.1 dsieger 826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
827: <a name="typography"></a>1.4. Typography</h2></div></div></div>
828: <p>When giving examples for commands, shell prompts are used to
829: show if the command should/can be issued as root, or if
1.23 wiz 830: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.115 sevan 831: <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
832: shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
1.229 gutterid 833: Bourne shell and derivatives.</p>
1.1 dsieger 834: </div>
835: </div>
1.41 asau 836: <div class="part">
1.1 dsieger 837: <div class="titlepage"><div><div><h1 class="title">
838: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
839: <div class="toc">
840: <p><b>Table of Contents</b></p>
1.100 leot 841: <dl class="toc">
1.154 rillig 842: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
843: <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 844: <dd><dl>
1.154 rillig 845: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 846: <dd><dl>
1.154 rillig 847: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
848: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 849: </dl></dd>
1.154 rillig 850: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 851: <dd><dl>
1.154 rillig 852: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
853: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 854: </dl></dd>
855: </dl></dd>
1.154 rillig 856: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1 dsieger 857: <dd><dl>
1.154 rillig 858: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
859: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 860: </dl></dd>
1.154 rillig 861: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1 dsieger 862: <dd><dl>
1.154 rillig 863: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 864: <dd><dl>
1.154 rillig 865: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
866: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 867: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
868: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
869: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
870: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
871: <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>
872: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1 dsieger 873: </dl></dd>
1.154 rillig 874: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1 dsieger 875: <dd><dl>
1.154 rillig 876: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
877: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
878: <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 879: </dl></dd>
880: </dl></dd>
1.154 rillig 881: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1 dsieger 882: <dd><dl>
1.154 rillig 883: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
884: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 885: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
886: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
887: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
888: <dd><dl>
889: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
890: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
891: <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 892: </dl></dd>
1.241 rillig 893: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
894: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 895: </dl></dd>
1.154 rillig 896: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1 dsieger 897: <dd><dl>
1.154 rillig 898: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
899: <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 900: </dl></dd>
1.154 rillig 901: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 902: builds)</a></span></dt>
1.1 dsieger 903: <dd><dl>
1.154 rillig 904: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 905: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 906: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
907: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 908: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
909: <dd><dl>
1.179 rillig 910: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
911: <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 912: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
913: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
914: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
915: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
916: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
917: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
918: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
919: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 920: </dl></dd>
921: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
922: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154 rillig 923: </dl></dd>
924: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
925: <dd><dl>
926: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
927: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
928: </dl></dd>
929: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
930: <dd><dl>
931: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
932: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
933: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
934: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
935: <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>
936: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
937: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
938: <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>
939: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
940: <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 941: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 942: <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 943: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 944: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
945: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
946: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
947: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
948: <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 949: </dl></dd>
950: </dl>
951: </div>
1.41 asau 952: <div class="chapter">
1.1 dsieger 953: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 954: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
955: <p>
956: To get help when using pkgsrc, the definitive source is this
957: document, the pkgsrc guide. If you don't find anything here,
958: there are alternatives:
959: </p>
960: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
961: <li class="listitem">
962: <p>
963: The built-in pkgsrc help, which is available after bootstrapping
964: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
965: help for any topic, such as a variable name like
966: <code class="varname">BUILD_DEFS</code>, a make target like
967: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
968: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207 leot 969: <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 970: </li>
971: <li class="listitem"><p>
1.163 rillig 972: To see the value of a single variable, run <span class="command"><strong>bmake
973: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
974: </p></li>
975: <li class="listitem"><p>
976: To see the values of the most common variables, run
977: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
978: topic. To see the variables for a single topic, run
979: <span class="command"><strong>bmake
980: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
981: <span class="command"><strong>bmake show-all-fetch</strong></span>.
982: </p></li>
983: <li class="listitem"><p>
1.154 rillig 984: The pkgsrc-users mailing list, to which
985: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
986: can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
987: questions</a>.</p></li>
988: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
989: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
990: or by using a specialized chat program such as
991: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
992: Pick any user name and join the channel #pkgsrc.</p></li>
993: </ul></div>
994: </div>
995: <div class="chapter">
996: <div class="titlepage"><div><div><h2 class="title">
997: <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 998: <div class="toc">
999: <p><b>Table of Contents</b></p>
1.100 leot 1000: <dl class="toc">
1.154 rillig 1001: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1 dsieger 1002: <dd><dl>
1.154 rillig 1003: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
1004: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 1005: </dl></dd>
1.154 rillig 1006: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1 dsieger 1007: <dd><dl>
1.154 rillig 1008: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
1009: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1 dsieger 1010: </dl></dd>
1011: </dl>
1012: </div>
1013: <p>Before you download and extract the files, you need to decide
1014: where you want to extract them. When using pkgsrc as root user, pkgsrc
1015: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
1016: free to install the sources and binary packages wherever you want in
1017: your filesystem, provided that the pathname does not contain white-space
1018: or other characters that are interpreted specially by the shell and some
1019: other programs. A safe bet is to use only letters, digits, underscores
1020: and dashes.</p>
1.41 asau 1021: <div class="sect1">
1.1 dsieger 1022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1023: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1 dsieger 1024: <p>Before you download any pkgsrc files, you should decide
1025: whether you want the <span class="emphasis"><em>current</em></span> branch or the
1026: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
1027: quarterly basis from the current branch and only gets modified
1028: for security updates. The names of the stable branches are built
1029: from the year and the quarter, for example
1.246 leot 1030: <code class="literal">2023Q3</code>.</p>
1.1 dsieger 1031: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 1032: want to download pkgsrc. You can get it as a tar file or via CVS.
1033: Both ways are described here.</p>
1.51 asau 1034: <p>Note that tar archive contains CVS working copy.
1035: Thus you can switch to using CVS at any later time.</p>
1.41 asau 1036: <div class="sect2">
1.1 dsieger 1037: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1038: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 1039: <p>The primary download location for all pkgsrc files is
1.151 sevan 1040: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51 asau 1041: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
1042: (it points to the same location).
1043: There are a number of subdirectories for different purposes,
1.207 leot 1044: 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 1045: <p>The tar archive for the current branch is in the directory
1.151 sevan 1046: <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 1047: It is autogenerated weekly.</p>
1.51 asau 1048: <p>To save download time we provide bzip2- and
1049: xz-compressed archives which are published at
1.151 sevan 1050: <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 1051: and
1.151 sevan 1052: <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 1053: respectively.
1054: </p>
1055: <p>You can fetch the same files using FTP.</p>
1.246 leot 1056: <p>The tar file for the stable branch 2023Q3 is in the
1057: directory <code class="filename">pkgsrc-2023Q3</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2023Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136 leot 1058: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12 weinem 1059: <pre class="screen">
1.246 leot 1060: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2023Q3/pkgsrc.tar.gz</code></strong></pre>
1.78 snj 1061: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51 asau 1062: or your web browser.</p>
1.12 weinem 1063: <p>Then, extract it with:</p>
1.78 snj 1064: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12 weinem 1065: <p>This will create the directory <code class="filename">pkgsrc/</code>
1066: in <code class="filename">/usr/</code> and all the package source will be
1067: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1068: <p>To download pkgsrc-current, run:</p>
1069: <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 1070: </div>
1.41 asau 1071: <div class="sect2">
1.1 dsieger 1072: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1073: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23 wiz 1074: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.246 leot 1075: <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-2023Q3 -P pkgsrc</code></strong>
1.23 wiz 1076: </pre>
1077: <p>This will create the directory <code class="filename">pkgsrc/</code>
1078: in your <code class="filename">/usr/</code> directory and all the package source
1079: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1080: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1081: <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 1082: </pre>
1.174 leot 1083: <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 1084: <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 1085: <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 1086: </pre>
1087: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1088: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1089: or better globally in <code class="filename">/etc/profile</code>:</p>
1090: <pre class="programlisting">
1091: # set CVS remote shell command
1092: CVS_RSH=ssh
1093: export CVS_RSH
1094: </pre>
1095: <p>By default, CVS doesn't do things like most people would expect it to do.
1096: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1097: in your home directory and saving the following lines to it.
1098: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1099: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1100: <pre class="programlisting">
1101: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 1102: cvs -q
1.2 rillig 1103: checkout -P
1.4 rillig 1104: update -dP
1105: diff -upN
1.2 rillig 1106: rdiff -u
1.23 wiz 1107: release -d
1.2 rillig 1108: </pre>
1.1 dsieger 1109: </div>
1110: </div>
1.41 asau 1111: <div class="sect1">
1.1 dsieger 1112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1113: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1 dsieger 1114: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1115: (which also works if you have first installed it via a tar
1116: file). It saves bandwidth and hard disk activity, compared to
1117: downloading the tar file again.</p>
1.41 asau 1118: <div class="sect2">
1.1 dsieger 1119: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1120: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41 asau 1121: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1122: <h3 class="title">Warning</h3>
1123: <p>When updating from a tar file, you first need to
1124: completely remove the old pkgsrc directory. Otherwise those
1125: files that have been removed from pkgsrc in the mean time will
1126: not be removed on your local disk, resulting in inconsistencies.
1127: When removing the old files, any changes that you have done to
1128: the pkgsrc files will be lost after updating. Therefore updating
1129: via CVS is strongly recommended.</p>
1130: </div>
1131: <p>Note that by default the distfiles and the binary packages
1132: are saved in the pkgsrc tree, so don't forget to rescue them
1.78 snj 1133: before updating. You can also configure pkgsrc to store distfiles
1134: and packages in directories outside the pkgsrc tree by setting the
1.1 dsieger 1135: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154 rillig 1136: 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 1137: <p>To update pkgsrc from a tar file, download the tar file as
1138: explained above. Then, make sure that you have not made any
1139: changes to the files in the pkgsrc directory. Remove the pkgsrc
1140: directory and extract the new tar file. Done.</p>
1141: </div>
1.41 asau 1142: <div class="sect2">
1.1 dsieger 1143: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1144: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25 spz 1145: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1146: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1147: </pre>
1148: <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>
1149: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1150: </pre>
1.41 asau 1151: <div class="sect3">
1.1 dsieger 1152: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1153: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1 dsieger 1154: <p>When updating pkgsrc, the CVS program keeps track of the
1155: branch you selected. But if you, for whatever reason, want to
1156: switch from the stable branch to the current one, you can do it
1.23 wiz 1157: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1158: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1159: back to the stable branch, add the
1.246 leot 1160: <span class="quote">“<span class="quote">-rpkgsrc-2023Q3</span>”</span> option.</p>
1.1 dsieger 1161: </div>
1.41 asau 1162: <div class="sect3">
1.1 dsieger 1163: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 1164: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1 dsieger 1165: <p>When you update pkgsrc, the CVS program will only touch
1166: those files that are registered in the CVS repository. That
1167: means that any packages that you created on your own will stay
1168: unmodified. If you change files that are managed by CVS, later
1169: updates will try to merge your changes with those that have been
1170: done by others. See the CVS manual, chapter
1.23 wiz 1171: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1172: </div>
1173: </div>
1174: </div>
1175: </div>
1.41 asau 1176: <div class="chapter">
1.1 dsieger 1177: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1178: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1 dsieger 1179: <div class="toc">
1180: <p><b>Table of Contents</b></p>
1.100 leot 1181: <dl class="toc">
1.154 rillig 1182: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
1183: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1 dsieger 1184: </dl>
1185: </div>
1.41 asau 1186: <div class="sect1">
1.1 dsieger 1187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1188: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
1189: <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 1190: </div>
1.41 asau 1191: <div class="sect1">
1.1 dsieger 1192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1193: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1194: <p>pkgsrc can be bootstrapped for use in two different modes:
1195: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1196: to privileged one all programs are installed under one particular user
1.43 asau 1197: and cannot utilise privileged operations (packages don't create
1198: special users and all special file permissions like setuid are ignored).
1199: </p>
1.1 dsieger 1200: <p>Installing the bootstrap kit from source should be as simple as:</p>
1201: <pre class="screen">
1.60 asau 1202: <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 1203: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1204: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1205: </pre>
1.43 asau 1206: <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>
1207: <p>By default, in privileged mode pkgsrc uses
1208: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1209: where programs will be installed in,
1.118 sevan 1210: and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43 asau 1211: directory where pkgsrc will do its internal bookkeeping,
1212: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1213: where packages install their persistent data.
1214: In unprivileged mode pkgsrc uses
1215: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118 sevan 1216: <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43 asau 1217: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1218: </p>
1219: <p>You can change default layout using command-line arguments.
1220: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1221: </p>
1.41 asau 1222: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1223: <h3 class="title">Note</h3>
1.10 hubertf 1224: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1225: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1226: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1227: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1228: </div>
1.43 asau 1229: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1230: <h3 class="title">Note</h3>
1231: <p>It is possible to bootstrap multiple instances of pkgsrc
1232: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1233: corresponding to the installation you're working with to build
1234: and install packages.
1235: </p>
1236: </div>
1.1 dsieger 1237: </div>
1238: </div>
1.41 asau 1239: <div class="chapter">
1.1 dsieger 1240: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1241: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1 dsieger 1242: <div class="toc">
1243: <p><b>Table of Contents</b></p>
1.100 leot 1244: <dl class="toc">
1.154 rillig 1245: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1 dsieger 1246: <dd><dl>
1.154 rillig 1247: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
1248: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202 nia 1249: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
1250: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
1251: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
1252: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
1253: <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>
1254: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.154 rillig 1255: </dl></dd>
1256: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1257: <dd><dl>
1258: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
1259: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
1260: <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 1261: </dl></dd>
1262: </dl>
1263: </div>
1264: <p>Basically, there are two ways of using pkgsrc. The first
1265: is to only install the package tools and to use binary packages
1.23 wiz 1266: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1267: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1268: of pkgsrc, too. Then you are able to build your own packages,
1269: and you can still use binary packages from someone else.</p>
1.41 asau 1270: <div class="sect1">
1.1 dsieger 1271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1272: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.202 nia 1273: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151 sevan 1274: site and mirrors, there are collections of binary packages,
1.9 rillig 1275: ready to be installed. These binary packages have been built using the
1276: default settings for the directories, that is:</p>
1.41 asau 1277: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1278: <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>
1279: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1280: <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 1281: </ul></div>
1282: <p>If you cannot use these directories for whatever reasons (maybe
1283: because you're not root), you cannot use these binary packages, but
1.154 rillig 1284: 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 1285: <div class="sect2">
1.1 dsieger 1286: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1287: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1288: <p>To install binary packages, you first need to know from where
1289: to get them. The first place where you should look is on the main
1.202 nia 1290: 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 1291: <p>This directory contains binary packages for multiple
1.226 gutterid 1292: platforms. First, select your operating system. Then, select your
1293: hardware architecture, and in the third step, the OS version and
1294: the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1295: <p>In this directory, you may find a file called
1.9 rillig 1296: <code class="filename">bootstrap.tar.gz</code> which contains the package
1297: management tools. If the file is missing, it is likely that your
1298: operating system already provides those tools. Download the file and
1299: extract it in the <code class="filename">/</code> directory. It will create
1300: the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118 sevan 1301: for managing binary packages and the database of installed packages).</p>
1.1 dsieger 1302: </div>
1.41 asau 1303: <div class="sect2">
1.1 dsieger 1304: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1305: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1306: <p>In the directory from the last section, there is a
1.85 wiz 1307: subdirectory called <code class="filename">All/</code>, which contains all the
1.9 rillig 1308: binary packages that are available for the platform, excluding those
1.202 nia 1309: that may not be distributed via HTTP or FTP.</p>
1.9 rillig 1310: <p>To install packages directly from an FTP or HTTP server, run
1311: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1312: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1313: <pre class="screen">
1.202 nia 1314: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
1315: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169 rillig 1316: <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 1317: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.202 nia 1318: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.9 rillig 1319: </pre>
1320: <p>Instead of URLs, you can also use local paths, for example if
1321: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1322: repository. If you want to install packages from multiple sources,
1323: you can separate them by a semicolon in
1324: <code class="varname">PKG_PATH</code>.</p>
1325: <p>After these preparations, installing a package is very
1326: easy:</p>
1327: <pre class="screen">
1.202 nia 1328: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
1329: nginx-1.19.6 Lightweight HTTP server and mail proxy server
1330: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
1331: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
1332: </pre>
1333: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
1334: to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
1335: <p>Any prerequisite packages needed to run the
1.1 dsieger 1336: package in question will be installed, too, assuming they are
1.202 nia 1337: present in the repository.</p>
1.1 dsieger 1338: <p>After you've installed packages, be sure to have
1339: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1340: <code class="varname">PATH</code> so you can actually start the just
1341: installed program.</p>
1342: </div>
1.41 asau 1343: <div class="sect2">
1.1 dsieger 1344: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1345: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
1346: <p>To update binary packages, it is recommended that you use
1347: <span class="command"><strong>pkgin upgrade</strong></span>. This will compare the remote
1348: package repository to your locally installed packages and safely
1349: replace any older packages.</p>
1350: <p>Note that pkgsrc is released as quarterly branches.
1351: If you are updating to a newer quarterly branch of pkgsrc, you may
1352: need to adjust the repository in
1353: <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
1354: </div>
1355: <div class="sect2">
1356: <div class="titlepage"><div><div><h3 class="title">
1357: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.1 dsieger 1358: <p>To deinstall a package, it does not matter whether it was
1.202 nia 1359: installed from source code or from a binary package. Neither the
1360: <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
1361: command need to know.</p>
1362: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.1 dsieger 1363: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.202 nia 1364: name can be given with or without version number.</p>
1.1 dsieger 1365: </div>
1.41 asau 1366: <div class="sect2">
1.1 dsieger 1367: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1368: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1369: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.202 nia 1370: installed packages or binary package files.
1371: As with other management tools, it works with packages installed
1372: from source or binaries.</p>
1.1 dsieger 1373: </div>
1.41 asau 1374: <div class="sect2">
1.1 dsieger 1375: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1376: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1 dsieger 1377: <p>
1.164 leot 1378: The pkgsrc Security Team and Packages Groups maintain a list of
1.202 nia 1379: known vulnerabilities to packages which are (or have been)
1.1 dsieger 1380: included in pkgsrc. The list is available from the NetBSD
1.202 nia 1381: 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>.
1382: </p>
1383: <p>
1384: Please note that not every "vulnerability" with a CVE assignment is
1385: exploitable in every configuration.
1386: Some bugs are marked as active simply because an fix was not
1387: marked as such.
1388: Operating system specific hardening and mitigation features may also
1389: reduce the impact of bugs.
1.1 dsieger 1390: </p>
1391: <p>
1.22 jakllsch 1392: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1393: this list can be downloaded
1394: automatically, and a security audit of all packages installed on a system
1395: can take place.
1396: </p>
1397: <p>
1.22 jakllsch 1398: There are two components to auditing. The first
1399: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1400: is for downloading
1.1 dsieger 1401: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1402: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1403: installed packages are vulnerable. If a package is vulnerable, you
1404: will see output similar to the following:
1405: </p>
1406: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1407: https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1 dsieger 1408: <p>
1.22 jakllsch 1409: You may wish to have the
1.202 nia 1410: <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1411: file downloaded daily so that
1412: it remains current. This may be done by adding an appropriate entry
1.246 leot 1413: to the root users <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1414: </p>
1415: <pre class="screen">
1.121 sevan 1416: # Download vulnerabilities file
1.118 sevan 1417: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1418: # Audit the installed packages and email results to root
1419: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1420: root >/dev/null 2>&1
1.22 jakllsch 1421: </pre>
1422: <p>
1.118 sevan 1423: will update the vulnerability list every day at 3AM, followed by an audit
1424: at 3:09AM. The result of the audit are then emailed to root.
1.22 jakllsch 1425:
1.118 sevan 1426: On NetBSD this may be accomplished instead by adding the following
1427: line to <code class="filename">/etc/daily.conf</code>:
1428: </p>
1429: <pre class="screen">
1430: fetch_pkg_vulnerabilities=YES
1431: </pre>
1432: <p>
1433: to fetch the vulnerability list from the daily security script. The system
1434: is set to audit the packages by default but can be set explicitly, if
1.123 wiz 1435: desired (not required), by adding the following line to
1.118 sevan 1436: <code class="filename">/etc/security.conf</code>:
1.22 jakllsch 1437: </p>
1438: <pre class="screen">
1.118 sevan 1439: check_pkg_vulnerabilities=YES
1.22 jakllsch 1440: </pre>
1441: <p>
1.246 leot 1442: see <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1 dsieger 1443: </p>
1444: </div>
1.41 asau 1445: <div class="sect2">
1.1 dsieger 1446: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1447: <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 1448: <p>
1.207 leot 1449: 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 1450: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.202 nia 1451: argument to check if any packages are stale, e.g.
1.1 dsieger 1452: </p>
1453: <pre class="screen">
1454: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1455: ...
1456: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1457: </pre>
1458: </div>
1.41 asau 1459: <div class="sect2">
1.1 dsieger 1460: <div class="titlepage"><div><div><h3 class="title">
1.202 nia 1461: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.10 hubertf 1462: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1463: administrative functions on the package system.</p>
1464: </div>
1465: </div>
1.41 asau 1466: <div class="sect1">
1.1 dsieger 1467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1468: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1 dsieger 1469: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1470: directory now contains a set of packages, organized into
1471: categories. You can browse the online index of packages, or run
1.10 hubertf 1472: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1473: directory to build local <code class="filename">README.html</code> files for
1.207 leot 1474: 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 1475: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1476: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1477: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1478: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1479: different <code class="varname">LOCALBASE</code> definitions on the same
1480: system (inside a chroot is an exception). </p>
1481: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1482: 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 1483: instructions how to create your own packages.</p>
1.41 asau 1484: <div class="sect2">
1.1 dsieger 1485: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1486: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1 dsieger 1487: <p>To build packages from source, you need a working C
1488: compiler. On NetBSD, you need to install the
1.23 wiz 1489: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1490: sets. If you want to build X11-related packages, the
1.23 wiz 1491: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1492: sets are required, too.</p>
1493: </div>
1.41 asau 1494: <div class="sect2">
1.1 dsieger 1495: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1496: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1 dsieger 1497: <p>The first step for building a package is downloading the
1498: distfiles (i.e. the unmodified source). If they have not yet been
1499: downloaded, pkgsrc will fetch them automatically.</p>
1500: <p>If you have all files that you need in the
1501: <code class="filename">distfiles</code> directory,
1502: you don't need to connect. If the distfiles are on CD-ROM, you can
1503: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1504: </p>
1505: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1506: <p>
1.10 hubertf 1507: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1508: <p>By default a list of distribution sites will be randomly
1509: intermixed to prevent huge load on servers which holding popular
1510: packages (for example, SourceForge.net mirrors). Thus, every
1511: time when you need to fetch yet another distfile all the mirrors
1512: will be tried in new (random) order. You can turn this feature
1513: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1514: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1515: <p>You can overwrite some of the major distribution sites to
1516: fit to sites that are close to your own. By setting one or two
1517: variables you can modify the order in which the master sites are
1518: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1519: delimited list of domain suffixes.
1520: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1521: contains a whitespace delimited list of regular expressions. It
1522: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1523: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1524: some examples. This may save some of your bandwidth and
1525: time.</p>
1526: <p>You can change these settings either in your shell's environment, or,
1527: if you want to keep the settings, by editing the
1.10 hubertf 1528: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1529: and adding the definitions there.</p>
1530: <p>
1531: If a package depends on many other packages (such as
1.207 leot 1532: <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 1533: alternate between periods of
1534: downloading source, and compiling. To ensure you have all the source
1535: downloaded initially you can run the command:
1536: </p>
1537: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1538: <p>
1539: which will output and run a set of shell commands to fetch the
1540: necessary files into the <code class="filename">distfiles</code> directory. You can
1541: also choose to download the files manually.
1542: </p>
1543: </div>
1.41 asau 1544: <div class="sect2">
1.1 dsieger 1545: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 1546: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1 dsieger 1547: <p>
1548: Once the software has downloaded, any patches will be applied, then it
1549: will be compiled for you. This may take some time depending on your
1550: computer, and how many other packages the software depends on and their
1551: compile time.
1552: </p>
1.41 asau 1553: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1554: <h3 class="title">Note</h3>
1555: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1556: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1557: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1558: </div>
1559: <p>For example, type</p>
1560: <pre class="screen">
1561: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1562: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1563: </pre>
1564: <p>at the shell prompt to build the various components of the
1565: package.</p>
1566: <p>The next stage is to actually install the newly compiled
1567: program onto your system. Do this by entering:
1568:
1569: </p>
1570: <pre class="screen">
1571: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1572: </pre>
1573: <p>
1574:
1575: while you are still in the directory for whatever package you
1576: are installing.</p>
1577: <p>Installing the package on your system may require you to
1578: be root. However, pkgsrc has a
1579: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1580: to only become root for the actual installation step.</p>
1581: <p>That's it, the software should now be installed and setup for use.
1582: You can now enter:
1583:
1584: </p>
1585: <pre class="screen">
1586: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1587: </pre>
1588: <p>
1589:
1590: to remove the compiled files in the work directory, as you shouldn't need
1591: them any more. If other packages were also added to your system
1592: (dependencies) to allow your program to compile, you can tidy these up
1593: also with the command:</p>
1594: <pre class="screen">
1595: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1596: </pre>
1597: <p>Taking the figlet utility as an example, we can install it on our
1.207 leot 1598: 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 1599: <p>The program is installed under the default root of the
1600: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1601: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1602: variable in your environment, and it will use that value as the
1603: root of your packages tree. So, to use
1604: <code class="filename">/usr/local</code>, set
1605: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1606: Please note that you should use a directory which is dedicated to
1607: packages and not shared with other programs (i.e., do not try and
1608: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1609: to add any of your own files or directories (such as
1610: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1611: <code class="filename">pkgsrc/</code>) below the
1612: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1613: conflicts between programs and other files installed by the
1614: package system and whatever else may have been installed
1615: there.</p>
1.10 hubertf 1616: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1617: alter some configuration options at build time. Have a look at
1618: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1619: of what will be set there by default. Environment variables such
1620: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1621: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1622: set them each time you want to use pkgsrc.</p>
1.23 wiz 1623: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1624: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1625: or being installed. This may be for debugging purposes, or out of
1626: simple curiosity. A number of utility values have been added to
1627: help with this.</p>
1.23 wiz 1628: <div class="orderedlist"><ol class="orderedlist" type="1">
1629: <li class="listitem">
1.246 leot 1630: <p>If you invoke the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1631: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1632: information will be displayed. For example,</p>
1633: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1634: <p>will show all the commands that are invoked, up to and
1.23 wiz 1635: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1636: </li>
1.23 wiz 1637: <li class="listitem">
1.246 leot 1638: <p>If you want to know the value of a certain <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1639: definition, then the <code class="varname">VARNAME</code> definition
1640: should be used, in conjunction with the show-var
1.246 leot 1641: target. e.g. to show the expansion of the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 1642: variable <code class="varname">LOCALBASE</code>:</p>
1643: <pre class="screen">
1644: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1645: /usr/pkg
1646: <code class="prompt">%</code>
1647: </pre>
1648: </li>
1649: </ol></div>
1650: <p>If you want to install a binary package that you've either
1651: created yourself (see next section), that you put into
1652: pkgsrc/packages manually or that is located on a remote FTP
1653: server, you can use the "bin-install" target. This target will
1.246 leot 1654: install a binary package - if available - via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 1655: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 1656: sites searched is kept in the variable
1657: <code class="varname">BINPKG_SITES</code>, which defaults to
1.246 leot 1658: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 1659: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
1660: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1661: details.</p>
1662: <p>A final word of warning: If you set up a system that has a
1663: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
1664: set that before any packages are installed, as you cannot use
1665: several directories for the same purpose. Doing so will result in
1666: pkgsrc not being able to properly detect your installed packages,
1667: and fail miserably. Note also that precompiled binary packages are
1668: usually built with the default <code class="varname">LOCALBASE</code> of
1669: <code class="filename">/usr/pkg</code>, and that you should
1670: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
1671: <code class="varname">LOCALBASE</code>.</p>
1672: </div>
1673: </div>
1674: </div>
1.41 asau 1675: <div class="chapter">
1.1 dsieger 1676: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 1677: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1 dsieger 1678: <div class="toc">
1679: <p><b>Table of Contents</b></p>
1.100 leot 1680: <dl class="toc">
1.154 rillig 1681: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
1682: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
1.241 rillig 1683: <dt><span class="sect1"><a href="#native-or-pkgsrc-preference">6.3. Preferences for native or pkgsrc software</a></span></dt>
1684: <dt><span class="sect1"><a href="#variables-affecting-installation">6.4. Variables affecting the installation process</a></span></dt>
1685: <dt><span class="sect1"><a href="#conf.compiler">6.5. Selecting and configuring the compiler</a></span></dt>
1686: <dd><dl>
1687: <dt><span class="sect2"><a href="#selecting-the-compiler">6.5.1. Selecting the compiler</a></span></dt>
1688: <dt><span class="sect2"><a href="#conf.cflags">6.5.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
1689: <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 1690: </dl></dd>
1.241 rillig 1691: <dt><span class="sect1"><a href="#developer-advanced-settings">6.6. Developer/advanced settings</a></span></dt>
1692: <dt><span class="sect1"><a href="#selecting-build-options">6.7. Selecting Build Options</a></span></dt>
1.1 dsieger 1693: </dl>
1694: </div>
1.4 rillig 1695: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 1696: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
1697: that file depends on the installation. On NetBSD, when you use
1.246 leot 1698: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 1699: <code class="filename">/etc/</code>. In all other cases the default location is
1700: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
1701: bootstrap program to install the binary packages.</p>
1702: <p>The format of the configuration file is that of the usual
1703: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
1704: is done by setting variables in this file. Note that you can define all
1705: kinds of variables, and no special error checking (for example for
1.112 rillig 1706: spelling mistakes) takes place.</p>
1.41 asau 1707: <div class="sect1">
1.1 dsieger 1708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1709: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112 rillig 1710: <p>The following variables apply to all
1.1 dsieger 1711: pkgsrc packages. A complete list of the variables that can be
1712: configured by the user is available in
1713: <code class="filename">mk/defaults/mk.conf</code>, together with some
1714: comments that describe each variable's intent.</p>
1.41 asau 1715: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1716: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 1717: packages will be installed. The default is
1718: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1719: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 1720: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
1721: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 1722: installed. The default is
1723: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 1724: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 1725: X11 is installed on the system. The default is
1.84 wiz 1726: <code class="filename">/usr/X11R7</code>.</p></li>
1.23 wiz 1727: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 1728: downloaded copies of the original source distributions used
1729: for building pkgsrc packages. The default is
1730: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 1731: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 1732: database about installed packages is stored. The default is
1.118 sevan 1733: <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23 wiz 1734: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 1735: If set, override the packages'
1736: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 1737: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 1738: Backup location(s) for distribution files and patch files
1739: if not found locally or in
1740: <code class="filename">${MASTER_SITES}</code> or
1741: <code class="filename">${PATCH_SITES}</code> respectively.
1.118 sevan 1742: The defaults is
1743: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 1744: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 1745: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
1746: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 1747: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
1748: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
1749: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 1750: List of acceptable licenses. License names are case-sensitive.
1751: Whenever you try to build a package whose license is not in this
1752: list, you will get an error message. If the license condition is
1753: simple enough, the error message will include specific
1754: instructions on how to change this variable.</p></li>
1.1 dsieger 1755: </ul></div>
1756: </div>
1.41 asau 1757: <div class="sect1">
1.1 dsieger 1758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 1759: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108 rillig 1760: <p>
1.1 dsieger 1761: </p>
1.41 asau 1762: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1763: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 1764: directory for the binary packages. The default is
1765: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 1766: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 1767: The top level directory where, if defined, the separate
1768: working directories will get created, and symbolically
1769: linked to from <code class="filename">${WRKDIR}</code> (see below).
1770: This is useful for building packages on several
1771: architectures, then <code class="filename">${PKGSRCDIR}</code>
1772: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1773: is local to every architecture. (It should be noted that
1774: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 1775: — it is an internal definition which refers to the
1.1 dsieger 1776: root of the pkgsrc tree. It is possible to have many
1777: pkgsrc tree instances.)</p></li>
1.23 wiz 1778: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 1779: Directory for local patches that aren't part of pkgsrc.
1.184 rillig 1780: 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 1781: information.</p></li>
1.23 wiz 1782: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 1783: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 1784: BSD-style Makefile. If this is not set,
1785: <code class="varname">MAKECONF</code> is set to
1786: <code class="filename">/dev/null</code> to avoid picking up
1787: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1788: </ul></div>
1789: </div>
1.41 asau 1790: <div class="sect1">
1.1 dsieger 1791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 1792: <a name="native-or-pkgsrc-preference"></a>6.3. Preferences for native or pkgsrc software</h2></div></div></div>
1793: <p>Whenever a package depends on a package that has a
1794: <code class="filename">builtin.mk</code> file, the dependent package can
1795: either use the built-in (native) version from the base system or the
1796: pkgsrc-provided version. This only affects dependencies, so it is
1797: 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
1798: on the native pcre++ version instead.</p>
1799: <p>To force using the pkgsrc-provided version for a particular
1800: package, define <span class="quote">“<span class="quote"><code class="varname">PREFER_PKGSRC</code> =
1801: <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
1802: using the native package, define
1803: <span class="quote">“<span class="quote"><code class="varname">PREFER_NATIVE</code> =
1804: <em class="replaceable"><code>package-ID</code></em></span>”</span>. In both cases, the
1805: <em class="replaceable"><code>package-ID</code></em> is the one from the
1806: <code class="filename">buildlink3.mk</code> of the package. In most cases,
1807: this ID is the same as the directory name of the package, but for
1808: example, <code class="filename">devel/pcre++</code> has the
1809: package ID <span class="quote">“<span class="quote">pcrexx</span>”</span>.</p>
1810: <p>For the packages that are not listed by their package ID,
1811: pkgsrc uses the pkgsrc-provided version if
1812: <code class="varname">PREFER_PKGSRC</code> contains the word
1813: <span class="quote">“<span class="quote">yes</span>”</span>. Otherwise, if <code class="varname">PREFER_NATIVE</code>
1814: contains the word <span class="quote">“<span class="quote">yes</span>”</span>, pkgsrc uses the native
1815: version. For example, to require using the pkgsrc-provided versions
1816: for all but the most basic bits on a NetBSD system, you can
1817: set:</p>
1818: <pre class="programlisting">
1819: PREFER_PKGSRC= yes
1820: PREFER_NATIVE= getopt skey tcp_wrappers
1821: </pre>
1822: <p>A package <span class="emphasis"><em>must</em></span> have a
1823: <code class="filename">builtin.mk</code> file to be listed in
1824: <code class="varname">PREFER_NATIVE</code>, otherwise it is simply ignored in
1825: that list.</p>
1826: <p><code class="varname">PREFER_PKGSRC</code> and
1827: <code class="varname">PREFER_NATIVE</code> should be set during bootstrap to
1828: ensure that the bootstrap process does not use inapropriate native
1829: tools as dependencies for core packages.</p>
1830: <pre class="screen">
1831: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
1832: </pre>
1833: <p>Switching between settings globally at a later date can
1834: introduce complications with dependency resolution. This is caused
1835: by packages built with the opposite preference being installed
1836: alongside each other. Hence, when changing any of these variables
1837: after bootstrap, you need to rebuild all packages depending on those
1838: whose preference has been changed. This is not trivial and should
1839: be avoided.</p>
1840: <p>When using pkgsrc on Linux systems, there is high risk of
1841: <span class="quote">“<span class="quote">leakage</span>”</span>, where programs installed by pkgsrc may
1842: inadvertently use a command or library not installed by pkgsrc, e.g.
1843: those installed by yum or apt. Such foreign dependencies may be
1844: installed, removed, or upgraded to a version incompatible with the
1845: pkgsrc package at any time, causing pkgsrc packages to subsequently
1846: malfunction. Pkgsrc cannot prevent this, as it has no control over
1847: other package managers. Another potential problem is that under
1848: Redhat Enterprise and related Linux systems, yum packages are only
1849: patched and never upgraded, so eventually they may become too
1850: outdated for use by pkgsrc. Even intentionally using foreign
1851: dependencies, not considered leakage, can lead to these problems, so
1852: it is generally discouraged. In order to minimize such problems,
1853: PREFER_PKGSRC defaults to <span class="quote">“<span class="quote">yes</span>”</span> on Linux systems. This ensures that
1854: pkgsrc is aware of any changes to dependency packages and can
1855: rebuild or upgrade the entire dependency tree as needed. This
1856: default can be overridden by setting --prefer-pkgsrc to a
1857: list of packages and --prefer-native to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1858: </div>
1859: <div class="sect1">
1860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1861: <a name="variables-affecting-installation"></a>6.4. Variables affecting the installation process</h2></div></div></div>
1.198 leot 1862: <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 1863: By default, binary packages of built packages are
1.150 leot 1864: preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143 maya 1865: this variable to "no" prevents this.</p></li></ul></div>
1.107 jnemeth 1866: <p>Packages have to support installation into a
1.4 rillig 1867: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
1868: to be built, before the actual filesystem is touched. DESTDIR
1869: support exists in two variations:</p>
1.41 asau 1870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1871: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 1872: installation and packaging is still run as root.</p></li>
1873: <li class="listitem"><p>Full DESTDIR support can run the complete
1874: build, installation and packaging as normal user. Root
1875: privileges are only needed to add packages.</p></li>
1876: </ul></div>
1.4 rillig 1877: <p>With basic DESTDIR support, <strong class="userinput"><code>make
1878: clean</code></strong> needs to be run as root.</p>
1.17 imil 1879: <p>Considering the <code class="filename">foo/bar</code> package,
1880: DESTDIR full support can be tested using the following commands
1881:
1882: </p>
1883: <pre class="programlisting">
1884: <code class="prompt">$</code> id
1885: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1886: <code class="prompt">$</code> mkdir $HOME/packages
1887: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
1888: </pre>
1889: <p>
1890:
1891: Verify <code class="varname">DESTDIR</code> full support, no root privileges
1892: should be needed
1893:
1894: </p>
1895: <pre class="programlisting">
1.66 asau 1896: <code class="prompt">$</code> make stage-install
1.17 imil 1897: </pre>
1898: <p>
1899:
1900: Create a package without root privileges
1901:
1902: </p>
1903: <pre class="programlisting">
1.66 asau 1904: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17 imil 1905: </pre>
1906: <p>
1907:
1908: For the following command, you must be able to gain root
1.246 leot 1909: privileges using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 1910:
1911: </p>
1912: <pre class="programlisting">
1.66 asau 1913: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17 imil 1914: </pre>
1915: <p>
1916:
1917: Then, as a simple user
1918:
1919: </p>
1920: <pre class="programlisting">
1921: <code class="prompt">$</code> make clean
1922: </pre>
1923: <p>
1924:
1925: </p>
1.4 rillig 1926: </div>
1.41 asau 1927: <div class="sect1">
1.4 rillig 1928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 1929: <a name="conf.compiler"></a>6.5. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 1930: <div class="sect2">
1.1 dsieger 1931: <div class="titlepage"><div><div><h3 class="title">
1.241 rillig 1932: <a name="selecting-the-compiler"></a>6.5.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 1933: <p>By default, pkgsrc will use GCC to build packages. This may be
1934: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 1935: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 1936: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
1937: <dd>
1938: <p>This is a list of values specifying the chain of
1939: compilers to invoke when building packages. Valid values
1940: are:</p>
1.41 asau 1941: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66 asau 1942: <li class="listitem"><p><code class="varname">ccc</code>:
1943: Compaq C Compilers (Tru64)</p></li>
1944: <li class="listitem"><p><code class="varname">ccache</code>:
1945: compiler cache (chainable)</p></li>
1946: <li class="listitem"><p><code class="varname">clang</code>:
1947: Clang C and Objective-C compiler</p></li>
1.23 wiz 1948: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 1949: distributed C/C++ (chainable)</p></li>
1.66 asau 1950: <li class="listitem"><p><code class="varname">f2c</code>:
1951: Fortran 77 to C compiler (chainable)</p></li>
1952: <li class="listitem"><p><code class="varname">icc</code>:
1953: Intel C++ Compiler (Linux)</p></li>
1954: <li class="listitem"><p><code class="varname">ido</code>:
1955: SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23 wiz 1956: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 1957: GNU C/C++ Compiler</p></li>
1.66 asau 1958: <li class="listitem"><p><code class="varname">hp</code>:
1959: HP-UX C/aC++ compilers</p></li>
1.23 wiz 1960: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 1961: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66 asau 1962: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1 dsieger 1963: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 1964: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 1965: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66 asau 1966: <li class="listitem"><p><code class="varname">xlc</code>:
1.118 sevan 1967: IBM's XL C/C++ compiler suite</p></li>
1.1 dsieger 1968: </ul></div>
1969: <p>The default is
1.23 wiz 1970: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 1971: <code class="varname">ccache</code> and/or
1972: <code class="varname">distcc</code> with an appropriate
1973: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 1974: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 1975: variable should always be terminated with a value for
1976: a real compiler. Note that only one real compiler
1.23 wiz 1977: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 1978: is not allowed).</p>
1979: </dd>
1980: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
1981: <dd><p>This specifies the minimum version of GCC to use
1982: when building packages. If the system GCC doesn't
1983: satisfy this requirement, then pkgsrc will build and
1984: install one of the GCC packages to use instead.</p></dd>
1.153 leot 1985: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114 maya 1986: <dd><p>Specifies which version of python to use when several
1987: options are available.</p></dd>
1988: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.176 gutterid 1989: <dd><p>Specifies the Fortran compiler to use.
1990: The default is <code class="varname">gfortran</code>.</p></dd>
1.114 maya 1991: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
1992: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
1993: <code class="varname">gfortran</code> is used, this option specifies which
1994: version to use.</p></dd>
1.1 dsieger 1995: </dl></div>
1996: </div>
1.41 asau 1997: <div class="sect2">
1.1 dsieger 1998: <div class="titlepage"><div><div><h3 class="title">
1.241 rillig 1999: <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 2000: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2001: please make sure to use the <code class="literal">+=</code> operator
2002: instead of the <code class="literal">=</code> operator:</p>
2003: <pre class="programlisting">
2004: CFLAGS+= -your -flags
2005: </pre>
2006: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 2007: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2008: need to add their own flags. You may want to take a look
1.207 leot 2009: 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 2010: package if you're interested in optimization specifically
2011: for the current CPU. </p>
1.1 dsieger 2012: </div>
1.41 asau 2013: <div class="sect2">
1.1 dsieger 2014: <div class="titlepage"><div><div><h3 class="title">
1.241 rillig 2015: <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 2016: <p>If you want to pass flags to the linker, both in the configure
2017: step and the build step, you can do this in two ways. Either set
2018: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2019: between the two is that <code class="varname">LIBS</code> will be appended to
2020: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2021: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2022: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2023: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2024: <code class="varname">CFLAGS</code>, if you do not wish to override these
2025: settings, use the <code class="literal">+=</code> operator:</p>
2026: <pre class="programlisting">
2027: LDFLAGS+= -your -linkerflags
2028: </pre>
2029: </div>
2030: </div>
1.41 asau 2031: <div class="sect1">
1.1 dsieger 2032: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 2033: <a name="developer-advanced-settings"></a>6.6. Developer/advanced settings</h2></div></div></div>
1.84 wiz 2034: <p>
1.1 dsieger 2035: </p>
1.41 asau 2036: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2037: <li class="listitem">
1.1 dsieger 2038: <p><code class="varname">PKG_DEVELOPER</code>:
1.232 gutterid 2039: Run some sanity checks that package developers want:
2040: </p>
1.41 asau 2041: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2042: <li class="listitem"><p>make sure patches apply with zero
1.232 gutterid 2043: fuzz</p></li>
1.23 wiz 2044: <li class="listitem"><p>run check-shlibs to see that all
1.232 gutterid 2045: binaries will find their shared libs.</p></li>
1.1 dsieger 2046: </ul></div>
2047: </li>
1.232 gutterid 2048: <li class="listitem"><p><code class="varname">CHECK_FILES_STRICT</code>:
2049: Also check <code class="varname">VARBASE</code> and <code class="varname">PKG_SYSCONFDIR
2050: </code> values in PLIST entries.
2051: </p></li>
1.23 wiz 2052: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.232 gutterid 2053: of debugging output which is displayed whilst making and
2054: installing the package. The default value for this is 0,
2055: which will not display the commands as they are executed
2056: (normal, default, quiet operation); the value 1 will display
2057: all shell commands before their invocation, and the value 2
2058: will display both the shell commands before their invocation,
2059: as well as their actual execution progress with <span class="command"><strong>set
2060: -x</strong></span>.</p></li>
1.1 dsieger 2061: </ul></div>
2062: <p>
2063: </p>
2064: </div>
1.41 asau 2065: <div class="sect1">
1.1 dsieger 2066: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.241 rillig 2067: <a name="selecting-build-options"></a>6.7. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2068: <p>Some packages have build time options, usually to select
2069: between different dependencies, enable optional support for big
2070: dependencies or enable experimental features.</p>
2071: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2072: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2073: show-options</strong></span>, for example:</p>
2074: <pre class="programlisting">
2075: The following options are supported by this package:
2076: ssl Enable SSL support.
2077: Exactly one of the following gecko options is required:
2078: firefox Use firefox as gecko rendering engine.
2079: mozilla Use mozilla as gecko rendering engine.
2080: At most one of the following database options may be selected:
2081: mysql Enable support for MySQL database.
2082: pgsql Enable support for PostgreSQL database.
2083:
2084: These options are enabled by default: firefox
2085: These options are currently enabled: mozilla ssl
2086: </pre>
2087: <p>The following variables can be defined in
1.10 hubertf 2088: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2089: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2090: which can be used to select or disable options for all packages
2091: that support them, and
2092: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2093: which can be used to select or disable options specifically for
2094: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2095: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2096: are disabled. A few examples:</p>
2097: <pre class="screen">
1.10 hubertf 2098: <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 2099: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2100: PKG_OPTIONS.kdebase= debug -sasl
2101: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2102: <p>It is important to note that options that were specifically
1.18 snj 2103: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2104: you do not wish to include the option. If you are unsure you can view
2105: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2106: <p>The following settings are consulted in the order given, and
2107: the last setting that selects or disables an option is
2108: used:</p>
1.23 wiz 2109: <div class="orderedlist"><ol class="orderedlist" type="1">
2110: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2111: maintainer</p></li>
1.23 wiz 2112: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2113: variables (see below)</p></li>
1.23 wiz 2114: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2115: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2116: </ol></div>
2117: <p>For groups of mutually exclusive options, the last option
2118: selected is used, all others are automatically disabled. If an
2119: option of the group is explicitly disabled, the previously
2120: selected option, if any, is used. It is an error if no option
2121: from a required group of options is selected, and building the
2122: package will fail.</p>
2123: <p>Before the options framework was introduced, build options
2124: were selected by setting a variable (often named
2125: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2126: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2127: transition to the options framework for the user, these legacy
2128: variables are converted to the appropriate options setting
2129: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2130: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2131: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2132: directly. Support for the legacy variables will be removed
2133: eventually.</p>
2134: </div>
2135: </div>
1.41 asau 2136: <div class="chapter">
1.1 dsieger 2137: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2138: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1 dsieger 2139: <div class="toc">
2140: <p><b>Table of Contents</b></p>
1.100 leot 2141: <dl class="toc">
1.154 rillig 2142: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
2143: <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 2144: </dl>
2145: </div>
1.41 asau 2146: <div class="sect1">
1.1 dsieger 2147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2148: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1 dsieger 2149: <p>Once you have built and installed a package, you can create
2150: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.246 leot 2151: another system with <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2152: the same package on a group of hosts and wasting CPU time. It also
2153: provides a simple means for others to install your package, should
2154: you distribute it.</p>
2155: <p>To create a binary package, change into the appropriate
1.10 hubertf 2156: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2157: package</strong></span>:</p>
2158: <pre class="screen">
1.112 rillig 2159: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2160: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
2161: </pre>
1.242 gutterid 2162: <p>This will build your package (if not already done) and package
2163: it into a binary package. You can then use the
2164: <span class="command"><strong>pkg_*</strong></span> tools to manipulate it. Binary packages are
2165: created in <code class="varname">PACKAGES</code>, which defaults to
2166: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a compressed
2167: tar file. See <a class="xref" href="#logs.package" title="C.2. Packaging figlet">Section C.2, “Packaging figlet”</a> for a continuation of
2168: 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>
2169: example.</p>
1.154 rillig 2170: <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 2171: such a binary package.</p>
2172: </div>
1.41 asau 2173: <div class="sect1">
1.1 dsieger 2174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2175: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.184 rillig 2176: <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 2177: </div>
2178: </div>
1.41 asau 2179: <div class="chapter">
1.6 rillig 2180: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2181: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6 rillig 2182: builds)</h2></div></div></div>
2183: <div class="toc">
2184: <p><b>Table of Contents</b></p>
1.100 leot 2185: <dl class="toc">
1.154 rillig 2186: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180 rillig 2187: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154 rillig 2188: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
2189: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178 rillig 2190: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
2191: <dd><dl>
1.179 rillig 2192: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
2193: <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 2194: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
2195: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
2196: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
2197: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
2198: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
2199: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
2200: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
2201: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178 rillig 2202: </dl></dd>
2203: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2204: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.6 rillig 2205: </dl>
2206: </div>
1.175 gutterid 2207: <p>For a number of reasons, you may want to build binary packages
2208: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.71 wiz 2209: For instance, when you have multiple machines that should run the same software,
2210: it is wasted time if they all build their packages themselves from source.
2211: Or you may want to build a list of packages you want and check them before
1.175 gutterid 2212: deploying onto production systems.
1.71 wiz 2213: There is a way of getting a set of binary packages:
1.175 gutterid 2214: the bulk build system, or pbulk ("p" stands for "parallel").
1.112 rillig 2215: This chapter describes how to set it up.</p>
1.41 asau 2216: <div class="sect1">
1.6 rillig 2217: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2218: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71 wiz 2219: <p>First of all, you have to decide whether you build all packages
2220: or a limited set of them. Full bulk builds usually consume a lot more resources,
2221: both space and time, than builds for some practical sets of packages.
1.175 gutterid 2222: A number of particularly heavy packages exist that are not actually
2223: interesting to a wide audience. (The approximate resource consumption for a
2224: 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>.)
2225: For limited bulk builds you need to make a list of packages you want to build.
1.112 rillig 2226: Note that all their dependencies will be built, so you don't need to track them manually.
1.71 wiz 2227: </p>
2228: <p>During bulk builds various packages are installed and deinstalled
2229: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
2230: so make sure that you don't need any package during the builds.
1.112 rillig 2231: Essentially, you should provide a fresh system, either a chroot environment
1.71 wiz 2232: or something even more restrictive, depending on what the operating system provides,
2233: or dedicate the whole physical machine.
2234: As a useful side effect this makes sure that bulk builds cannot
2235: break anything in your system. There have been numerous cases where
1.6 rillig 2236: certain packages tried to install files outside the
2237: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71 wiz 2238: <code class="filename">/etc</code>.
2239: </p>
1.6 rillig 2240: </div>
1.41 asau 2241: <div class="sect1">
1.6 rillig 2242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180 rillig 2243: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
2244: <p>Running a bulk build works roughly as follows:</p>
1.41 asau 2245: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2246: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2247: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2248: </ul></div>
1.41 asau 2249: <div class="sect2">
1.15 rillig 2250: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 2251: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112 rillig 2252: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68 asau 2253: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
2254: Configure network access to fetch distribution files.
1.112 rillig 2255: Create a user with name "pbulk".</p>
1.68 asau 2256: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
2257: <pre class="screen">
1.151 sevan 2258: <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>
2259: <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 2260: <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 2261: </pre>
2262: <p>Or any other way that fits (e.g., curl, wget).</p>
2263: <p>Deploy and configure pbulk tools, e.g.:</p>
2264: <pre class="screen">
1.118 sevan 2265: <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 2266: <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>
2267: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
2268: </pre>
2269: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2270: <h3 class="title">Note</h3>
2271: <p><code class="filename">mk.conf.frag</code> is a fragment of
2272: <code class="filename">mk.conf</code> that contains settings you want to
2273: apply to packages you build. For instance,</p>
2274: <pre class="programlisting">
1.112 rillig 2275: PKG_DEVELOPER= yes # perform more checks
2276: X11_TYPE= modular # use pkgsrc X11
2277: SKIP_LICENSE_CHECK= yes # accept all licences (useful
2278: # when building all packages)
1.68 asau 2279: </pre>
2280: </div>
2281: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112 rillig 2282: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68 asau 2283: <pre class="programlisting">
2284: www/firefox
2285: mail/thunderbird
2286: misc/libreoffice4
2287: </pre>
1.69 asau 2288: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
2289: and make final amendments, if wanted.</p>
1.68 asau 2290: <p>Start it:</p>
2291: <pre class="screen">
2292: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
2293: </pre>
2294: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
2295: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
2296: </p>
2297: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2298: <h3 class="title">Note</h3>
2299: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
2300: While being ready to run, it serves as a good starting point to understand and build more complex setups.
2301: The script is kept small enough for better understanding.</p>
2302: </div>
2303: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2304: <h3 class="title">Note</h3>
2305: <p>The <code class="filename">pbulk.sh</code> script supports running
1.205 wiz 2306: unprivileged bulk build and helps configuring distributed bulk builds.
2307: Distributed bulk builds support either building in worker chroots
2308: (each node is a path to a different chroot)
2309: that replicate the target system, including the pbulk prefix,
2310: or remote machines (each node is
2311: an IP address that must be accessible over SSH without a password).</p>
1.68 asau 2312: </div>
1.6 rillig 2313: </div>
2314: </div>
1.41 asau 2315: <div class="sect1">
1.6 rillig 2316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2317: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71 wiz 2318: <p>A complete bulk build requires lots of disk space. Some of the
2319: disk space can be read-only, some other must be writable. Some can be on
2320: remote filesystems (such as NFS) and some should be local. Some can be
2321: temporary filesystems, others must survive a sudden reboot.</p>
2322: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.205 wiz 2323: <li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
2324: <li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
1.71 wiz 2325: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2326: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
2327: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
2328: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2329: </ul></div>
2330: </div>
2331: <div class="sect1">
2332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.178 rillig 2333: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
2334: <p>To ensure that pkgsrc packages work in different configurations, it
2335: makes sense to run non-default bulk builds from time to time. This
2336: section lists some ideas for bulk builds that intentionally let packages
2337: fail if they don't follow the pkgsrc style.</p>
2338: <div class="sect2">
2339: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2340: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.178 rillig 2341: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2342: <pre class="programlisting">
2343: GNU_CONFIGURE_STRICT= yes
2344: </pre>
2345: <p>When a package fails this additional check, the most common cause
2346: is that the configure option was valid for an older version of the
2347: package but does not apply anymore. In that case, just remove it.</p>
2348: </div>
2349: <div class="sect2">
2350: <div class="titlepage"><div><div><h3 class="title">
1.179 rillig 2351: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178 rillig 2352: <p>The job of a compiler is not restricted to producing executable
1.179 rillig 2353: code, most compilers also detect typical programming mistakes. The pkgsrc
2354: compiler wrappers make it easy to force compiler options when the package
2355: is built. This can be used to find typical bugs across all packages that
2356: are in pkgsrc. By reporting these bugs upstream, the packages will be
2357: more reliable with the next updates.</p>
2358: <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 2359: <pre class="programlisting">
2360: CFLAGS+= -Werror=char-subscripts
1.179 rillig 2361: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 2362: </pre>
1.179 rillig 2363: <p>When a package fails to build using these stricter compiler
2364: options, document the circumstances in which the compiler produced the
2365: error message. This includes:</p>
1.178 rillig 2366: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2367: <li class="listitem"><p>The platform
2368: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
2369: <li class="listitem"><p>The source file</p></li>
2370: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
2371: part of the diagnostic.</p></li>
1.179 rillig 2372: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178 rillig 2373: </ul></div>
2374: <p>If a package produces these error messages, but the package is
1.179 rillig 2375: 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
2376: in the next builds:</p>
1.178 rillig 2377: <pre class="programlisting">
1.179 rillig 2378: .if ${PKGPATH} == category/package
1.178 rillig 2379: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
2380: # error message
2381: # code
1.179 rillig 2382: # Reason why the code does not need to be fixed.
1.178 rillig 2383: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 2384: .endif
1.178 rillig 2385: </pre>
2386: <p>If the error messages from the compiler are valid and the code
1.179 rillig 2387: needs to be fixed, prepare a local patch (see
2388: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
2389: authors of the package, providing them with the information you collected
2390: above.</p>
2391: <p>Patches that are not essential for the package to work should only
2392: be reported upstream but not committed to pkgsrc, to make future updates
2393: easier.</p>
1.178 rillig 2394: </div>
2395: <div class="sect2">
2396: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2397: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
2398: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
2399: these apply to all phases of the package build process. Especially in the
2400: configure phase, adding <code class="literal">-Werror</code> leads to wrong
2401: decisions. The GNU configure scripts feed many small test programs to the
2402: C compiler to see whether certain headers are available, functions are
2403: defined in a library and programs can be run. In many cases these
2404: programs would not survive a strict compiler run with <code class="literal">-Wall
2405: -Wextra -Werror</code>.</p>
2406: <p>The pkgsrc infrastructure is flexible enough to support compiler
2407: options being added between the <code class="literal">configure</code> and
2408: <code class="literal">build</code> phases. It's a little more complicated than the
2409: other examples in this section but still easy enough.</p>
2410: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
2411: desired compiler options. The compiler wrapper's original task is to hide
2412: unwanted directories of include files and to normalize compiler options.
2413: It does this by wrapping the compiler command and rewriting the command
2414: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
2415: package directory and examine the
2416: <code class="filename">work/.cwrappers/config</code> directory. It contains
2417: individual configurations for the C compiler and the related tools. The
2418: plan is to find a hook between the configure and build phases, and to
2419: modify these configuration files at that point.</p>
2420: <p>To find this hook, have a look at
2421: <code class="filename">mk/build/build.mk</code>, which contains among others the
2422: <code class="literal">pre-build-checks-hook</code>. The word
2423: <code class="literal">checks</code> doesn't quite fit, but the
2424: <code class="literal">pre-build-hook</code> sounds good enough.</p>
2425: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
2426: <pre class="programlisting">
2427: # Just a few example options.
2428: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
2429:
2430: .if ${BUILD_ONLY_CFLAGS:U:M*}
2431: pre-build-checks-hook: add-build-only-cflags
2432:
2433: add-build-only-cflags: .PHONY
2434: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
2435: ${TEST} ! -f ${.TARGET} || exit 0; \
2436: for flag in ${BUILD_ONLY_CFLAGS}; do \
2437: ${ECHO} "append=$$flag" >> cc; \
2438: done; \
2439: > ${.TARGET}
2440: .endif
2441: </pre>
2442: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
2443: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
2444: not with spaces.)</p>
2445: <p>The condition in the <code class="literal">.if</code> statement contains the
2446: <code class="literal">:U</code> modifier to prevent parse errors if the variable
2447: should be undefined, possibly because it is only defined for a subset of
2448: the packages. The <code class="literal">:M*</code> modifier ensures that there is
2449: at least one compiler option, to prevent a syntax error in the shell
2450: parser.</p>
2451: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
2452: that the additional compiler options are only appended once, even if
2453: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
2454: creates a marker file.</p>
2455: <p>To verify that this setup works, run <span class="command"><strong>bmake
2456: configure</strong></span> in a package directory. Up to now, everything works
2457: as usual. Examine the directory
2458: <code class="filename">work/.cwrappers/config</code> to see that the compiler
2459: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
2460: the file <code class="filename">cc</code>. Examine the tail of the
2461: <code class="filename">work/.work.log</code> file to see that the normal compiler
2462: options are used.</p>
2463: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
2464: options to the file <code class="filename">cc</code> and will create the marker
2465: file in the same directory. After that, the build starts as usual, but
2466: with the added compiler options. Examine the tail of the file
2467: <code class="filename">work/.work.log</code> to see that the lines starting with
2468: <code class="literal">[*]</code> don't contain the compiler options, but the
2469: corresponding lines starting with <code class="literal"><.></code> do end
2470: with these options.</p>
2471: <p>Building packages using this setup variant and fixing the resulting
2472: 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>
2473: </div>
2474: <div class="sect2">
2475: <div class="titlepage"><div><div><h3 class="title">
2476: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.178 rillig 2477: <p>Some directories like <code class="varname">PREFIX</code>,
2478: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
2479: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
2480: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
2481: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2482: <pre class="programlisting">
2483: PREFIX= /a-random-uuid
2484: PKG_SYSCONFDIR= /a-random-uuid
2485: VARBASE= /a-random-uuid
2486: PKGMANDIR= a-random-uuid
2487: PKG_INFODIR= a-random-uuid
2488: </pre>
2489: </div>
2490: <div class="sect2">
2491: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2492: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.178 rillig 2493: <p>When building a package, warnings are typically ignored since they
2494: just flow by and do not cause the build to fail immediately. To find
2495: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2496: <pre class="programlisting">
2497: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
2498: WARNING_MSG= ${FAIL_MSG} "(was warning)"
2499: </pre>
2500: <p>(There are many more classes of warnings in pkgsrc, and most of
2501: them can be redefined with a simple definition like above.</p>
1.179 rillig 2502: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178 rillig 2503: the package Makefile, research whether the package actually needs Perl.
2504: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
2505: Makefile, and if it doesn't, add
2506: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
2507: </div>
2508: <div class="sect2">
2509: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2510: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178 rillig 2511: <p>Using pkglint as part of the regular build process is mostly a
2512: waste of time. If you want to fix some of the warnings, just run pkglint
2513: recursively on the whole pkgsrc tree. This will take a few minutes (up to
2514: 10), which is much faster than a complete bulk build.</p>
2515: </div>
2516: <div class="sect2">
2517: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2518: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.178 rillig 2519: <p>To ensure that the binary packages don't contain references to the
2520: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
2521: that variable includes the item <code class="literal">extra</code>, it is
2522: possible to define additional patterns that must not appear in any
2523: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2524: <pre class="programlisting">
2525: CHECK_WRKREF= extra
2526: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
2527: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
2528: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
2529: </pre>
2530: <p>The above patterns will probably generate many false positives,
2531: therefore the results need to be taken with a grain of salt.</p>
2532: </div>
2533: <div class="sect2">
2534: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2535: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.178 rillig 2536: <p>To run the test suites that come with each package, add this line
2537: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2538: <pre class="programlisting">
2539: PKGSRC_RUN_TEST= yes
2540: </pre>
2541: <p>Be prepared that even the most basic packages fail this test. When
2542: doing a bulk build with this, it will often abort in the early phase
2543: where the packages are scanned for their dependencies since there are
2544: cyclic dependencies. There is still a lot to do in this area.</p>
2545: </div>
2546: <div class="sect2">
2547: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2548: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.178 rillig 2549: <p>To catch typos in the shell snippets from the Makefile fragments,
2550: add the <code class="literal">-u</code> flag to most of the commands by adding this
2551: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2552: <pre class="programlisting">
2553: RUN= @set -eu;
2554: </pre>
1.181 rillig 2555: <p>After that, ensure that none of the bulk build log files (even
2556: those for successfully built packages) contains the string
2557: <code class="literal">parameter not set</code> or whatever error message the
2558: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.178 rillig 2559: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
2560: definition.</p>
2561: </div>
2562: <div class="sect2">
2563: <div class="titlepage"><div><div><h3 class="title">
1.181 rillig 2564: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.178 rillig 2565: <p>The build logs of a package are often quite long. This allows error
2566: messages or other interesting details to hide between the noise. To make
2567: the actual error message stand out more, add these lines to
2568: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
2569: <pre class="programlisting">
2570: GNU_CONFIGURE_QUIET= yes
2571: MAKE_FLAGS+= -s
2572: </pre>
2573: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
2574: Make. On exotic platforms with their own make, it may be a little
2575: different.</p>
2576: </div>
2577: </div>
2578: <div class="sect1">
2579: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2580: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2581: <p>After your pkgsrc bulk-build has completed, you may wish to
2582: create a CD-ROM set of the resulting binary packages to assist
2583: in installing packages on other machines. The
1.207 leot 2584: <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 2585: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2586: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2587: way that keeps all the dependencies for a given package on the same
2588: CD as that package.</p>
1.41 asau 2589: <div class="sect2">
1.1 dsieger 2590: <div class="titlepage"><div><div><h3 class="title">
1.178 rillig 2591: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2592: <p>Complete documentation for cdpack is found in the cdpack(1)
2593: man page. The following short example assumes that the binary
2594: packages are left in
2595: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2596: sufficient disk space exists in <code class="filename">/u2</code> to
2597: hold the ISO 9660 images.</p>
2598: <pre class="screen">
2599: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2600: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2601: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2602: </pre>
2603: <p>If you wish to include a common set of files
2604: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2605: etc.) on each CD in the collection, then you need to create a
1.175 gutterid 2606: directory which contains these files, e.g.:</p>
1.1 dsieger 2607: <pre class="screen">
2608: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2609: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2610: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2611: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2612: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2613: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2614: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2615: </pre>
2616: <p>Now create the images:</p>
2617: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2618: <p>Each image will contain <code class="filename">README</code>,
2619: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2620: in their root directories.</p>
2621: </div>
2622: </div>
2623: </div>
1.41 asau 2624: <div class="chapter">
1.1 dsieger 2625: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2626: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2627: <div class="toc">
2628: <p><b>Table of Contents</b></p>
1.100 leot 2629: <dl class="toc">
1.154 rillig 2630: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2631: <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 2632: </dl>
2633: </div>
2634: <p>The files that are installed by pkgsrc are organized in a way that
2635: is similar to what you find in the <code class="filename">/usr</code> directory
2636: of the base system. But some details are different. This is because
2637: pkgsrc initially came from FreeBSD and had adopted its file system
2638: hierarchy. Later it was largely influenced by NetBSD. But no matter
2639: which operating system you are using pkgsrc with, you can expect the
2640: same layout for pkgsrc.</p>
2641: <p>There are mainly four root directories for pkgsrc, which are all
2642: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
2643: When pkgsrc has been installed as root, the default locations
2644: are:</p>
2645: <pre class="programlisting">
2646: LOCALBASE= /usr/pkg
2647: PKG_SYSCONFBASE= /usr/pkg/etc
2648: VARBASE= /var
1.119 sevan 2649: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2650: </pre>
2651: <p>In unprivileged mode (when pkgsrc has been installed as any other
2652: user), the default locations are:</p>
2653: <pre class="programlisting">
2654: LOCALBASE= ${HOME}/pkg
2655: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2656: VARBASE= ${HOME}/pkg/var
1.119 sevan 2657: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2658: </pre>
2659: <p>What these four directories are for, and what they look like is
2660: explained below.</p>
1.41 asau 2661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2662: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 2663: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 2664: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 2665: the well-known subdirectories like <code class="filename">bin</code>,
2666: <code class="filename">include</code>, <code class="filename">lib</code>,
2667: <code class="filename">share</code> and
2668: <code class="filename">sbin</code>.</p></li>
1.23 wiz 2669: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 2670: <code class="filename">/var</code> in the base system. Some programs (especially
2671: games, network daemons) need write access to it during normal
2672: operation.</p></li>
1.23 wiz 2673: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 2674: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 2675: 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 2676: itself.</p></li>
2677: </ul></div>
1.41 asau 2678: <div class="sect1">
1.1 dsieger 2679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2680: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 2681: </h2></div></div></div>
2682: <p>The following directories exist in a typical pkgsrc installation
2683: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 2684: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2685: <dt><span class="term"><code class="filename">bin</code></span></dt>
2686: <dd><p>Contains executable programs that are intended to be
2687: directly used by the end user.</p></dd>
2688: <dt><span class="term"><code class="filename">emul</code></span></dt>
2689: <dd><p>Contains files for the emulation layers of various other
2690: operating systems, especially for
2691: NetBSD.</p></dd>
2692: <dt><span class="term"><code class="filename">etc</code> (the usual location of
2693: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
2694: <dd><p>Contains
2695: the configuration files.</p></dd>
2696: <dt><span class="term"><code class="filename">include</code></span></dt>
2697: <dd><p>Contains headers for the C and C++ programming
2698: languages.</p></dd>
2699: <dt><span class="term"><code class="filename">info</code></span></dt>
2700: <dd><p>Contains GNU info files of various
2701: packages.</p></dd>
2702: <dt><span class="term"><code class="filename">lib</code></span></dt>
2703: <dd><p>Contains shared and static
2704: libraries.</p></dd>
2705: <dt><span class="term"><code class="filename">libdata</code></span></dt>
2706: <dd><p>Contains data files that don't change after
2707: installation. Other data files belong into
2708: <code class="filename">${VARBASE}</code>.</p></dd>
2709: <dt><span class="term"><code class="filename">libexec</code></span></dt>
2710: <dd><p>Contains programs that are not intended to be used by
2711: end users, such as helper programs or network
2712: daemons.</p></dd>
2713: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
2714: <dd><p>Contains programs that are intended to be executed as
2715: CGI scripts by a web server.</p></dd>
2716: <dt><span class="term"><code class="filename">man</code> (the usual value of
2717: <code class="filename">${PKGMANDIR}</code>)</span></dt>
2718: <dd><p>Contains brief
2719: documentation in form of manual pages.</p></dd>
2720: <dt><span class="term"><code class="filename">sbin</code></span></dt>
2721: <dd><p>Contains programs that are intended to be used only by
2722: the super-user.</p></dd>
2723: <dt><span class="term"><code class="filename">share</code></span></dt>
2724: <dd><p>Contains platform-independent data files that don't
2725: change after installation.</p></dd>
2726: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
2727: <dd><p>Contains documentation files provided by the
2728: packages.</p></dd>
2729: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
2730: <dd><p>Contains example files provided by the packages. Among
2731: others, the original configuration files are saved here and copied to
2732: <code class="filename">${PKG_SYSCONFDIR}</code> during
2733: installation.</p></dd>
2734: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
2735: <dd><p>Contains the original files for rc.d
2736: scripts.</p></dd>
2737: <dt><span class="term"><code class="filename">var</code> (the usual location of
2738: <code class="filename">${VARBASE}</code>)</span></dt>
2739: <dd><p>Contains files
2740: that may be modified after
2741: installation.</p></dd>
2742: </dl></div>
2743: </div>
1.41 asau 2744: <div class="sect1">
1.1 dsieger 2745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2746: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 2747: </h2></div></div></div>
1.41 asau 2748: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2749: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
2750: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
2751: <dd><p>Contains
2752: information about the currently installed
2753: packages.</p></dd>
2754: <dt><span class="term"><code class="filename">games</code></span></dt>
2755: <dd><p>Contains highscore
2756: files.</p></dd>
2757: <dt><span class="term"><code class="filename">log</code></span></dt>
2758: <dd><p>Contains log files.</p></dd>
2759: <dt><span class="term"><code class="filename">run</code></span></dt>
2760: <dd><p>Contains informational files about daemons that are
2761: currently running.</p></dd>
2762: </dl></div>
2763: </div>
2764: </div>
1.41 asau 2765: <div class="chapter">
1.1 dsieger 2766: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 2767: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 2768: <div class="toc">
2769: <p><b>Table of Contents</b></p>
1.100 leot 2770: <dl class="toc">
1.154 rillig 2771: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
2772: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
2773: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
2774: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
2775: <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>
2776: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
2777: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
2778: <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>
2779: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
2780: <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 2781: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
1.154 rillig 2782: <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 2783: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' or `priv` with pkgsrc</a></span></dt>
1.154 rillig 2784: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
2785: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
2786: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
2787: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build. What shall I do?</a></span></dt>
2788: <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 2789: </dl>
2790: </div>
2791: <p>This section contains hints, tips & tricks on special things in
2792: pkgsrc that we didn't find a better place for in the previous chapters, and
2793: it contains items for both pkgsrc users and developers.</p>
1.41 asau 2794: <div class="sect1">
1.1 dsieger 2795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2796: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 2797: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 2798: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2799: <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 2800: This is a general purpose list for most issues regarding
2801: pkgsrc, regardless of platform, e.g. soliciting user help
2802: for pkgsrc configuration, unexpected build failures, using
2803: particular packages, upgrading pkgsrc installations,
2804: questions regarding the pkgsrc release branches, etc. General announcements or
2805: proposals for changes that impact the pkgsrc user community,
2806: e.g. major infrastructure changes, new features, package
2807: removals, etc., may also be posted.</p></li>
1.174 leot 2808: <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 2809: A list where the results of pkgsrc bulk builds are sent and
2810: discussed.</p></li>
1.174 leot 2811: <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 2812: This list is for those who are interested in getting a
2813: commit message for every change committed to pkgsrc. It is
2814: also available in digest form, meaning one daily message
2815: containing all commit messages for changes to the package
2816: source tree in that 24 hour period.</p></li>
2817: </ul></div>
2818: <p>To subscribe, do:</p>
2819: <pre class="programlisting">
2820: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
2821: </pre>
2822: <p>Archives for all these mailing lists are available from
1.174 leot 2823: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 2824: </div>
1.41 asau 2825: <div class="sect1">
1.1 dsieger 2826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2827: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 2828: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
2829: a number of useful utilities for both users and developers of pkgsrc. This
1.121 sevan 2830: section attempts only to make the reader aware of some of the utilities and when
1.1 dsieger 2831: they might be useful, and not to duplicate the documentation that comes
2832: with each package.</p>
2833: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.207 leot 2834: <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 2835: Symlinks for use by buildlink.</p></li></ul></div>
2836: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 2837: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2838: <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 2839: Calculates various kinds of checksums (including SHA3).</p></li>
1.207 leot 2840: <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 2841: Compatibility library for pkgsrc tools.</p></li>
1.207 leot 2842: <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 2843: non-BSD systems due to lack of native mtree.</p></li>
1.207 leot 2844: <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 2845: Up-to-date replacement for
2846: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
2847: systems where pkg_install is not present.</p></li>
2848: </ul></div>
2849: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 2850: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2851: <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 2852: Create a binary package from an
1.10 hubertf 2853: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 2854: save the old package.</p></li>
1.207 leot 2855: <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 2856: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
2857: from multiple locations. It currently supports the following
2858: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.207 leot 2859: <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 2860: the best compiler flags to optimise code for your current
1.23 wiz 2861: CPU and compiler. </p></li>
1.1 dsieger 2862: </ul></div>
2863: <p>Utilities for keeping track of installed packages, being up to date,
2864: etc:</p>
1.41 asau 2865: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2866: <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 2867: update tool similar to apt(1). Download, install, and upgrade
2868: binary packages easily.</p></li>
1.207 leot 2869: <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 2870: packages whose installed versions do not match the latest pkgsrc
2871: entries.</p></li>
1.207 leot 2872: <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 2873: dependency graphs of packages, to aid in choosing a strategy for
2874: updating.</p></li>
1.207 leot 2875: <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
2876: 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>
2877: <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 2878: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.207 leot 2879: <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 2880: does various checks on the complete pkgsrc system.</p></li>
1.207 leot 2881: <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 2882: packages you have installed.</p></li>
2883: </ul></div>
2884: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 2885: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2886: <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 2887: making and maintaining patches for a package (includes pkgdiff,
2888: pkgvi, mkpatches, etc.).</p></li>
1.207 leot 2889: <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 2890: converting to pkgsrc.</p></li>
2891: </ul></div>
2892: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
2893: utilities)</p>
1.41 asau 2894: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 2895: <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 2896: packages in a chrooted area.</p></li>
1.207 leot 2897: <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 2898: kernel version for chrooted cross builds.</p></li>
2899: </ul></div>
2900: </div>
1.41 asau 2901: <div class="sect1">
1.1 dsieger 2902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2903: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108 rillig 2904: <p>To install packages from source as a non-root user, download
1.154 rillig 2905: 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 2906: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
2907: --unprivileged</strong></span>.</p>
2908: <p>This will install the binary part of pkgsrc to
2909: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2910: into <code class="filename">~/pkg/etc</code>.</p>
2911: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1 dsieger 2912: </div>
1.41 asau 2913: <div class="sect1">
1.1 dsieger 2914: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2915: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 2916: <p>By default, resuming transfers in pkgsrc is disabled, but you can
2917: enable this feature by adding the option
2918: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 2919: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 2920: distfile is found, pkgsrc will try to resume it.</p>
2921: <p>You can also
1.61 wiz 2922: use a different program than the platform default program by changing the
1.16 jnemeth 2923: <code class="varname">FETCH_USING</code> variable. You can specify the program by
2924: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
2925: by using the value manual. A value of custom disables the system defaults
2926: and dependency tracking for the fetch program. In that case you have to
2927: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
2928: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
2929: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 2930: <p>For example, if you want to use
1.16 jnemeth 2931: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 2932: like:</p>
2933: <pre class="programlisting">
1.112 rillig 2934: FETCH_USING= wget
1.1 dsieger 2935: </pre>
2936: </div>
1.41 asau 2937: <div class="sect1">
1.1 dsieger 2938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2939: <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 2940: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 2941: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
2942: you will have to add the following line into
1.10 hubertf 2943: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 2944: <pre class="programlisting">
1.4 rillig 2945: X11_TYPE=modular
1.1 dsieger 2946: </pre>
2947: </div>
1.41 asau 2948: <div class="sect1">
1.1 dsieger 2949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2950: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 2951: <p>If you are sitting behind a firewall which does not allow direct
2952: connections to Internet hosts (i.e. non-NAT), you may specify the
2953: relevant proxy hosts. This is done using an environment variable in the
2954: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 2955: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 2956: port 80 as the proxy port number. So the proxy environment variables
2957: are:</p>
2958: <pre class="programlisting">
2959: ftp_proxy=ftp://orpheus.amdahl.com:80/
2960: http_proxy=http://orpheus.amdahl.com:80/
2961: </pre>
2962: </div>
1.41 asau 2963: <div class="sect1">
1.1 dsieger 2964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2965: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65 wiz 2966: <p>Some fetch tools are not prepared to support HTTPS by default
2967: (for example, the one in NetBSD 6.0), or the one installed by the
2968: pkgsrc bootstrap (to avoid an openssl dependency that low in the
2969: dependency graph).</p>
2970: <p>Usually you won't notice, because distribution files are
2971: mirrored weekly to <span class="quote">“<span class="quote">ftp.NetBSD.org</span>”</span>, but that might not
2972: be often enough if you are following pkgsrc-current. In that case, set
2973: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
2974: <span class="quote">“<span class="quote">curl</span>”</span> or <span class="quote">“<span class="quote">wget</span>”</span>, which are both compiled
2975: with HTTPS support by default. Of course, these tools need to be
2976: installed before you can use them this way.</p>
2977: </div>
2978: <div class="sect1">
2979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 2980: <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 2981: <p>This depends on which utility is used to retrieve distfiles. From
2982: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
2983: the first available command from the following list:</p>
1.41 asau 2984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2985: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
2986: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 2987: </ul></div>
2988: <p>On a default NetBSD installation, this will be
2989: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
2990: connections first, and falls back to active connections if the server
2991: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 2992: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 2993: <code class="varname">PASSIVE_FETCH=1</code>.</p>
2994: <p>Having that option present will prevent
2995: <code class="filename">/usr/bin/ftp</code> from falling back to active
2996: transfers.</p>
2997: </div>
1.41 asau 2998: <div class="sect1">
1.1 dsieger 2999: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3000: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3001: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3002: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3003: 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 3004: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3005: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3006: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3007: resulting list to your machine at work/school and use it there. If you
1.246 leot 3008: don't have a NetBSD-compatible <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 3009: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3010: URL:</p>
3011: <p>At home:</p>
3012: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3013: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3014: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3015: <p>At work:</p>
3016: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3017: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3018: home.</p>
3019: <p>If you have a machine running NetBSD, and you want to get
3020: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3021: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3022: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3023: directly by running:</p>
3024: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3025: <p>If you even decide to ignore
3026: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3027: by running:</p>
3028: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3029: </div>
1.41 asau 3030: <div class="sect1">
1.1 dsieger 3031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3032: <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 3033: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.207 leot 3034: <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 3035: package, you get the error from make that it doesn't know how to make
3036: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 3037: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3038: the NetBSD base distribution on your machine. It is recommended to do
3039: that to format man pages.</p>
1.207 leot 3040: <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 3041: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3042: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3043: </div>
1.41 asau 3044: <div class="sect1">
1.1 dsieger 3045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3046: <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 3047: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3048: when you installed your NetBSD machine. Please get and install it, by
3049: extracting it in <code class="filename">/</code>:</p>
3050: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3051: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3052: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3053: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3054: -r</strong></span>).</p>
3055: </div>
1.41 asau 3056: <div class="sect1">
1.1 dsieger 3057: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.221 nia 3058: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' or `priv` with pkgsrc</h2></div></div></div>
1.1 dsieger 3059: <p>When installing packages as non-root user and using the just-in-time
1.246 leot 3060: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 3061: password for each required package installed. To avoid this, the sudo
3062: package can be used, which does password caching over a limited time. To
1.221 nia 3063: use it, install <span class="command"><strong>sudo</strong></span> or
3064: <span class="command"><strong>priv</strong></span> (either as binary package, from
3065: <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 3066: <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 3067: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3068: <span class="emphasis"><em>after</em></span> the definition of the
3069: <code class="varname">LOCALBASE</code> variable:</p>
3070: <pre class="programlisting">
3071: .if exists(${LOCALBASE}/bin/sudo)
3072: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3073: .endif
3074: </pre>
3075: </div>
1.41 asau 3076: <div class="sect1">
1.1 dsieger 3077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3078: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3079: <p>As the system administrator, you can choose where configuration files
3080: are installed. The default settings make all these files go into
3081: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3082: be suboptimal depending on your expectations (e.g., a read-only,
3083: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3084: configuration of the provided packages).</p>
3085: <p>In order to change the defaults, you can modify the
3086: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3087: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3088: directory; some common examples include <code class="filename">/etc</code> or
3089: <code class="filename">/etc/pkg</code>.</p>
3090: <p>Furthermore, you can change this value on a per-package basis by
3091: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3092: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3093: package you would like to modify, that is, the contents of
3094: <code class="varname">PKGBASE</code>.</p>
3095: <p>Note that after changing these settings, you must rebuild and
3096: reinstall any affected packages.</p>
3097: </div>
1.41 asau 3098: <div class="sect1">
1.1 dsieger 3099: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3100: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3101: <p>Please be aware that there can often be bugs in third-party software,
3102: and some of these bugs can leave a machine vulnerable to exploitation by
3103: attackers. In an effort to lessen the exposure, the NetBSD packages team
3104: maintains a database of known-exploits to packages which have at one time
3105: been included in pkgsrc. The database can be downloaded automatically, and
3106: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3107: do this, refer to the following two tools (installed as part of the
1.207 leot 3108: <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 3109: <div class="orderedlist"><ol class="orderedlist" type="1">
3110: <li class="listitem">
1.20 snj 3111: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3112: download a list of the security vulnerabilities information. This list
1.25 spz 3113: is kept up to date by the pkgsrc security team, and is distributed
3114: from the NetBSD ftp server:</p>
1.177 leot 3115: <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 3116: </li>
1.23 wiz 3117: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3118: current machine, checking each known vulnerability. If a
1.1 dsieger 3119: vulnerable package is installed, it will be shown by output to stdout,
3120: including a description of the type of vulnerability, and a URL
3121: containing more information.</p></li>
3122: </ol></div>
1.121 sevan 3123: <p>Use of these tools is strongly recommended!
1.202 nia 3124: 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 3125: reporting.</p>
3126: <p>If this database is installed, pkgsrc builds will use it to
3127: perform a security check before building any package.</p>
1.1 dsieger 3128: </div>
1.41 asau 3129: <div class="sect1">
1.1 dsieger 3130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3131: <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 3132: <p>When you add your own preferences to the
3133: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3134: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3135: environment variables to the <code class="filename">./configure</code>
1.246 leot 3136: scripts and to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 3137: <code class="varname">CFLAGS</code> from the environment variable by
3138: overriding them in the <code class="filename">Makefile</code>s of their
3139: package.</p>
3140: <p>Currently there is no solution to this problem. If you
3141: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3142: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3143: directory and then inspect any <code class="filename">Makefile</code> and
3144: <code class="filename">Makefile.in</code> for whether they define
3145: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3146: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3147: programmers write so bad code that it only works for the
3148: specific combination of <code class="varname">CFLAGS</code> they have
3149: chosen.</p>
1.172 rillig 3150: <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>
3151: <pre class="programlisting">
3152: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
3153: CFLAGS+= -Dpkgsrc___CFLAGS
3154: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
3155: </pre>
3156: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
3157: to see whether the above flags are passed to the actual build
3158: commands in general.</p>
3159: <p>To find out whether the flags are passed to individual compiler
3160: commands, have a look at the file <code class="filename">work/.work.log</code>. In
3161: most cases, the flags from the original command lines (the lines starting
3162: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
3163: (the lines starting with <code class="literal"><.></code>). If the flag is
3164: missing from the actual compiler command, it must have been removed by
1.184 rillig 3165: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1 dsieger 3166: </div>
1.41 asau 3167: <div class="sect1">
1.1 dsieger 3168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3169: <a name="ufaq-fail"></a>10.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3170: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3171: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3172: case that occurs often is that people only update pkgsrc in
3173: parts, because of performance reasons. Since pkgsrc is one large
3174: system, not a collection of many small systems, there are
3175: sometimes changes that only work when the whole pkgsrc tree is
3176: updated.</p></li>
1.41 asau 3177: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3178: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3179: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3180: files.</p></li>
1.41 asau 3181: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3182: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3183: verify this.</p></li>
1.108 rillig 3184: <li class="step"><p>If you are a package developer who wants to invest
1.154 rillig 3185: 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 3186: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3187: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3188: </ol></div>
3189: </div>
1.41 asau 3190: <div class="sect1">
1.1 dsieger 3191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 3192: <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 3193: <p>You have modified a file from pkgsrc, and someone else has
3194: modified that same file afterwards in the CVS repository. Both changes
3195: are in the same region of the file, so when you updated pkgsrc, the
3196: <code class="literal">cvs</code> command marked the conflicting changes in the
3197: file. Because of these markers, the file is no longer a valid
3198: <code class="filename">Makefile</code>.</p>
3199: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3200: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3201: -dP</strong></span> in that directory to download the current version.</p>
3202: </div>
3203: </div>
3204: </div>
1.41 asau 3205: <div class="part">
1.1 dsieger 3206: <div class="titlepage"><div><div><h1 class="title">
3207: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3208: <div class="partintro">
1.1 dsieger 3209: <div></div>
3210: <p>This part of the book deals with creating and
1.23 wiz 3211: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3212: guide on creating a new package. The remaining chapters are more
3213: like a reference manual for pkgsrc.</p>
3214: <div class="toc">
3215: <p><b>Table of Contents</b></p>
1.100 leot 3216: <dl class="toc">
1.154 rillig 3217: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184 rillig 3218: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1 dsieger 3219: <dd><dl>
1.184 rillig 3220: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3221: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3222: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1 dsieger 3223: <dd><dl>
1.184 rillig 3224: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3225: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3226: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3227: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3228: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1 dsieger 3229: </dl></dd>
1.184 rillig 3230: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3231: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3232: <dd><dl>
3233: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3234: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3235: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
3236: </dl></dd>
3237: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3238: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3239: </dl></dd>
1.184 rillig 3240: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6 rillig 3241: <dd><dl>
1.184 rillig 3242: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
3243: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
3244: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
3245: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
3246: <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 3247: <dd><dl>
1.184 rillig 3248: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
3249: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6 rillig 3250: </dl></dd>
1.184 rillig 3251: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3252: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3253: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3254: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3255: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3256: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3257: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3258: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3259: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3260: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3261: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
3262: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
3263: </dl></dd>
3264: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
3265: <dd><dl>
3266: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6 rillig 3267: <dd><dl>
1.219 nia 3268: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
3269: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
3270: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.6 rillig 3271: </dl></dd>
1.184 rillig 3272: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
3273: <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 3274: </dl></dd>
1.184 rillig 3275: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3276: <dd><dl>
1.184 rillig 3277: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
3278: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
3279: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
3280: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6 rillig 3281: <dd><dl>
1.184 rillig 3282: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
3283: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
3284: <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>
3285: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 3286: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.6 rillig 3287: </dl></dd>
3288: </dl></dd>
1.184 rillig 3289: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6 rillig 3290: <dd><dl>
1.184 rillig 3291: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3292: <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>
3293: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3294: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3295: </dl></dd>
1.184 rillig 3296: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6 rillig 3297: <dd><dl>
1.184 rillig 3298: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3299: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3300: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
3301: </dl></dd>
3302: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
3303: <dd><dl>
3304: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
3305: <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 3306: <dd><dl>
1.184 rillig 3307: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3308: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26 wiz 3309: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3310: and
3311: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3312: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3313: </dl></dd>
1.184 rillig 3314: <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 3315: <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 3316: </dl></dd>
3317: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6 rillig 3318: <dd><dl>
1.184 rillig 3319: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
3320: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3321: <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>
3322: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
3323: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
3324: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3325: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
3326: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
3327: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6 rillig 3328: </dl></dd>
1.184 rillig 3329: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
3330: <dd><dl>
3331: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
3332: <dd><dl>
3333: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
3334: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6 rillig 3335: </dl></dd>
1.184 rillig 3336: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6 rillig 3337: <dd><dl>
1.184 rillig 3338: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3339: <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 3340: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
3341: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
3342: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 3343: </dl></dd>
3344: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
3345: <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>
3346: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
3347: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
3348: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
3349: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
3350: <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 3351: </dl></dd>
3352: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
3353: <dd><dl>
3354: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
3355: <dd><dl>
3356: <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>
3357: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
3358: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
3359: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
3360: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
3361: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
3362: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
3363: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
3364: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
3365: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
3366: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3367: </dl></dd>
3368: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3369: <dd><dl>
3370: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3371: <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>
3372: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
3373: </dl></dd>
3374: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3375: <dd><dl>
3376: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
3377: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3378: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 3379: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 3380: </dl></dd>
3381: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
3382: <dd><dl>
3383: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
3384: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 3385: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 3386: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
3387: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
3388: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
3389: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 3390: </dl></dd>
3391: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3392: <dd><dl>
3393: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
3394: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 3395: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
3396: <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>
3397: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 3398: </dl></dd>
3399: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3400: <dd><dl>
3401: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
3402: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
3403: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
3404: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
3405: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 3406: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 3407: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
3408: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
3409: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
3410: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
3411: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
3412: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
3413: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
3414: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
3415: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
3416: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 3417: emulation</a></span></dt>
1.254 wiz 3418: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
3419: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 3420: </dl></dd>
1.154 rillig 3421: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3422: </dl></dd>
1.184 rillig 3423: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3424: <dd><dl>
3425: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3426: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3427: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3428: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
3429: </dl></dd>
1.154 rillig 3430: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1 dsieger 3431: <dd><dl>
1.154 rillig 3432: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
3433: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3434: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
3435: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
3436: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
3437: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
3438: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
3439: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
3440: </dl></dd>
3441: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1 dsieger 3442: </dl>
3443: </div>
3444: </div>
1.41 asau 3445: <div class="chapter">
1.1 dsieger 3446: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 3447: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
3448: <p>
3449: To get help when developing pkgsrc, the definitive source is this
3450: document, the pkgsrc guide. If you don't find anything here,
3451: there are alternatives:
3452: </p>
3453: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3454: <li class="listitem">
3455: <p>
3456: The built-in pkgsrc help, which is available after bootstrapping
3457: pkgsrc. Run <span class="command"><strong>bmake help topic=…</strong></span> to get
3458: help for any topic, such as a variable name like
3459: <code class="varname">BUILD_DEFS</code>, a make target like
3460: <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
3461: <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
1.207 leot 3462: <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 3463: </li>
3464: <li class="listitem"><p>
1.163 rillig 3465: To see the value of a single variable, run <span class="command"><strong>bmake
3466: show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
3467: </p></li>
3468: <li class="listitem"><p>
3469: To see the values of the most common variables, run
3470: <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
3471: topic. To see the variables for a single topic, run
3472: <span class="command"><strong>bmake
3473: show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
3474: <span class="command"><strong>bmake show-all-fetch</strong></span>.
3475: </p></li>
3476: <li class="listitem"><p>
1.154 rillig 3477: The tech-pkg mailing list, to which
3478: <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
3479: can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
3480: questions</a>.</p></li>
3481: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
3482: <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
3483: or by using a specialized chat program such as
3484: <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
3485: Pick any user name and join the channel #pkgsrc.</p></li>
3486: </ul></div>
3487: </div>
3488: <div class="chapter">
3489: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 3490: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 3491: <div class="toc">
3492: <p><b>Table of Contents</b></p>
1.100 leot 3493: <dl class="toc">
1.184 rillig 3494: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
3495: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
3496: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
3497: <dd><dl>
3498: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
3499: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
3500: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
3501: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
3502: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
3503: </dl></dd>
3504: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
3505: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
3506: <dd><dl>
3507: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
3508: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
3509: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 3510: </dl></dd>
1.184 rillig 3511: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
3512: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 3513: </dl>
3514: </div>
1.184 rillig 3515: <p>Whenever you're preparing a package, there are a number of
3516: files involved which are described in the following
3517: sections.</p>
3518: <div class="sect1">
3519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3520: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
3521: </h2></div></div></div>
3522: <p>Building, installation and creation of a binary package are all
3523: controlled by the package's <code class="filename">Makefile</code>.
3524: The <code class="filename">Makefile</code> describes various things about
3525: a package, for example from where to get it, how to configure,
3526: build, and install it.</p>
3527: <p>A package <code class="filename">Makefile</code> contains several
3528: sections that describe the package.</p>
3529: <p>In the first section there are the following variables, which
3530: should appear exactly in the order given here. The order and
3531: grouping of the variables is mostly historical and has no further
3532: meaning.</p>
3533: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3534: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
3535: distribution file to be downloaded from the package's
3536: website.</p></li>
3537: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
3538: package, as used by pkgsrc. You need to provide it if
3539: <code class="varname">DISTNAME</code> (which is the default) is not a good
3540: name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
3541: provided (no distribution file is required). Usually it is the pkgsrc
3542: directory name together with the version number. It must match the
3543: regular expression
3544: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
3545: starts with a letter or digit, and contains only letters, digits,
1.204 nia 3546: dashes, underscores, dots and plus signs.
3547: New packages should have entirely lower-case names, with the exception
3548: of some that must follow pre-existing conventions
3549: (e.g. R packages begin with <code class="varname">R-</code>).
3550: You can use the <code class="code">:tl</code> variable modifier to lower-case
3551: the package name.</p></li>
1.184 rillig 3552: <li class="listitem">
3553: <p><code class="varname">CATEGORIES</code> is a list of categories
3554: which the package fits in. You can choose any of the top-level
3555: directories of pkgsrc for it.</p>
3556: <p>Currently the following values are available for
3557: <code class="varname">CATEGORIES</code>. If more than
3558: one is used, they need to be separated by spaces:</p>
1.1 dsieger 3559: <pre class="programlisting">
1.184 rillig 3560: archivers cross geography meta-pkgs security
3561: audio databases graphics misc shells
3562: benchmarks devel ham multimedia sysutils
3563: biology editors inputmethod net textproc
3564: cad emulators lang news time
3565: chat finance mail parallel wm
3566: comms fonts math pkgtools www
3567: converters games mbone print x11
1.1 dsieger 3568: </pre>
3569: </li>
1.184 rillig 3570: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
3571: <code class="varname">DYNAMIC_MASTER_SITES</code>,
3572: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
3573: and <code class="varname">DISTFILES</code> are discussed in detail in
3574: <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>
3575: </ul></div>
3576: <p>The second section contains information about separately
3577: downloaded patches, if any.
3578: </p>
3579: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3580: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
3581: Name(s) of additional files that contain distribution patches.
3582: There is no default. pkgsrc will look for them at
3583: <code class="varname">PATCH_SITES</code>.
3584: They will automatically be uncompressed before patching if
3585: the names end with <code class="filename">.gz</code> or
3586: <code class="filename">.Z</code>.</p></li>
3587: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
3588: Primary location(s) for distribution patch files (see
3589: <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
3590: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.246 leot 3591: an argument to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.184 rillig 3592: help find the correct files to patch. It defaults to
3593: <span class="command"><strong>-p0</strong></span>.</p></li>
3594: </ul></div>
3595: <p>The third section contains the following variables.
3596: </p>
3597: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.253 gutterid 3598: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email address
3599: of the person who is currently responsible for this package. In
3600: theory, the maintainer will be aware of upstream release, keep it
3601: updated, and generally resolve problems. Others contemplating
3602: significant changes should ask the maintainer for advice or review
3603: of a proposed change. This is not necessary for micro updates,
3604: bug fixes, pkgsrc-wide changes affecting many packages, and other
3605: things expected to be uncontroversial. It goes with this "should
3606: ask" that the maintainer should respond to inquiries reasonably
3607: promptly (most of the time), and either approve changes or provide
3608: reasons why not. Typically, when packaging a new program, set
3609: <code class="varname">MAINTAINER</code> to yourself. If you don't intend to
3610: maintain the package (especially if you feel you have no special
3611: insight), set it to <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>. This
3612: special value is a code point indicating that there is no
3613: maintainer, but the variable is mandatory, absent
3614: <code class="varname">OWNER</code>.</p></li>
3615: <li class="listitem">
3616: <p><code class="varname">OWNER</code> can be used instead of
3617: <code class="varname">MAINTAINER</code> in relatively rare circumstances
3618: when the package is such that modifying it is riskier than normal.
3619: This is a stronger form of being the maintainer, with an
3620: expectation that others will ask for almost all changes, except
3621: revbumps and accommodating structural changes. Someone who becomes
3622: <code class="varname">OWNER</code> has a strong obligation to keep the
3623: package very well maintained, to answer queries promptly and to be
3624: a steward of the package on behalf of users. In this case,
3625: <code class="varname">MAINTAINER</code> should be omitted.</p>
3626: <p>Because of the friction that <code class="varname">OWNER</code> adds,
3627: PMC may downgrade it to <code class="varname">MAINTAINER</code> at any
3628: time.</p>
3629: </li>
1.184 rillig 3630: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
3631: find more information about the package.</p></li>
3632: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
3633: description of the package (should not include the package
3634: name).</p></li>
3635: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
3636: 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>
3637: </ul></div>
3638: <p>Other variables that affect the build:
3639: </p>
3640: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
3641: <p><code class="varname">WRKSRC</code>: The directory where the
3642: interesting distribution files of the package are found. The
3643: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
3644: works for most packages.</p>
3645: <p>If a package doesn't create a subdirectory for itself
3646: (most GNU software does, for instance), but extracts itself in
3647: the current directory, you should set
3648: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
3649: <p>If a package doesn't create a subdirectory with the
3650: name of <code class="varname">DISTNAME</code> but some different name,
3651: set <code class="varname">WRKSRC</code> to point to the proper name in
3652: <code class="filename">${WRKDIR}</code>, for example
3653: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.207 leot 3654: <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 3655: <p>The name of the working directory created by pkgsrc is
3656: taken from the <code class="varname">WRKDIR_BASENAME</code>
3657: variable. By default, its value is
3658: <code class="filename">work</code>. If you want to use the same
3659: pkgsrc tree for building different kinds of binary packages,
3660: you can change the variable according to your needs. Two
3661: other variables handle common cases of setting
3662: <code class="varname">WRKDIR_BASENAME</code> individually. If
3663: <code class="varname">OBJHOSTNAME</code> is defined in
3664: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
3665: the host's name is attached to the directory name. If
3666: <code class="varname">OBJMACHINE</code> is defined, the platform name
3667: is attached, which might look like
3668: <code class="filename">work.i386</code> or
3669: <code class="filename">work.sparc</code>.</p>
3670: </li></ul></div>
3671: <p>Please pay attention to the following gotchas:</p>
3672: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3673: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
3674: installed in compressed form by the package. For packages using
3675: BSD-style makefiles which honor MANZ, there is
3676: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
3677: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
3678: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
3679: below).</p></li>
1.254 wiz 3680: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.8. Packages installing info files">Section 21.6.8, “Packages installing info files”</a>.</p></li>
1.184 rillig 3681: </ul></div>
3682: </div>
1.41 asau 3683: <div class="sect1">
1.1 dsieger 3684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 3685: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
3686: </h2></div></div></div>
3687: <p>The <code class="filename">distinfo</code> file contains the message
3688: digest, or checksum, of each distfile needed for the package. This
3689: ensures that the distfiles retrieved from the Internet have not been
3690: corrupted during transfer or altered by a malign force to introduce
3691: a security hole. To provide maximum security, all distfiles are
1.243 gutterid 3692: protected using two different message digest algorithms (BLAKE2s
3693: and SHA512), as well as the file size.</p>
1.184 rillig 3694: <p>The <code class="filename">distinfo</code> file also contains the
3695: checksums for all the patches found in the
3696: <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
3697: are only applied intentionally and that they don't accidentally change,
3698: e.g. when merging different changes together. They also make sure that
3699: new patches are actually added to CVS and old ones are removed.
3700: Too see whether the patches and the <code class="filename">distinfo</code> file
3701: match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
3702: <p>To regenerate the <code class="filename">distinfo</code> file, use the
3703: <span class="command"><strong>make distinfo</strong></span> command.</p>
3704: <p>Some packages have different sets of distfiles depending on
1.207 leot 3705: 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 3706: <code class="filename">distinfo</code> file and care should be taken when
3707: upgrading such a package to ensure distfile information is not
3708: lost.</p>
3709: </div>
3710: <div class="sect1">
3711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3712: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
3713: </h2></div></div></div>
3714: <p>Some packages don't work out-of-the box on the various
3715: platforms that are supported by pkgsrc. These packages need
3716: to be patched to make them work. The patch files can be
3717: found in the <code class="filename">patches/</code> directory.</p>
3718: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
3719: applied to the files in <code class="varname">WRKSRC</code> directory after
3720: extracting them, in alphabetic order.</p>
1.41 asau 3721: <div class="sect2">
1.1 dsieger 3722: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3723: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
3724: <p>The <code class="filename">patch-*</code> files should be in
3725: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
3726: problems. (To force patches to apply with fuzz you can set
3727: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
3728: should contain only changes for a single file, and no file should be
3729: patched by more than one patch file. This helps to keep future
3730: modifications simple.</p>
3731: <p>Each patch file is structured as follows: In the first line,
3732: there is the RCS Id of the patch itself. The second line should be
3733: empty for aesthetic reasons. After that, there should be a comment for
3734: each change that the patch does. There are a number of standard
3735: cases:</p>
3736: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
3737: <li class="listitem"><p>Patches for commonly known vulnerabilities should
3738: mention the vulnerability ID (CAN, CVE).</p></li>
3739: <li class="listitem"><p>Patches that change source code should mention the
3740: platform and other environment (for example, the compiler) that the
3741: patch is needed for.</p></li>
3742: </ul></div>
3743: <p>The patch should be commented so that any
3744: developer who knows the code of the application can make some use of
3745: the patch. Special care should be taken for the upstream developers,
3746: since we generally want that they accept our patches, so we have less
3747: work in the future.</p>
1.1 dsieger 3748: </div>
1.41 asau 3749: <div class="sect2">
1.1 dsieger 3750: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3751: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
3752: <p>One important thing to mention is to pay attention that no RCS
3753: IDs get stored in the patch files, as these will cause problems when
3754: later checked into the NetBSD CVS tree. Use the
1.207 leot 3755: <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 3756: problems.</p>
3757: <p>For even more automation, we recommend using
3758: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.222 gutterid 3759: whole set of patches. You just have to back up files before you
3760: edit them to <code class="filename">filename.orig</code>, e.g., with
1.184 rillig 3761: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
3762: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
3763: you upgrade a package this way, you can easily compare the new
3764: set of patches with the previously existing one with
3765: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
3766: are replaced by new files, so carefully check if you want to take all
3767: the changes.</p>
3768: <p>When you have finished a package, remember to generate
3769: the checksums for the patch files by using the <span class="command"><strong>make
3770: 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>
3771: <p>When adding a patch that corrects a problem in the
3772: distfile (rather than e.g. enforcing pkgsrc's view of where
3773: man pages should go), send the patch as a bug report to the
3774: maintainer. This benefits non-pkgsrc users of the package,
3775: and usually makes it possible to remove the patch in future
3776: version.</p>
3777: <p>The file names of the patch files are usually of the form
3778: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
3779: Many packages still use the previous convention
3780: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
3781: but new patches should be of the form containing the filename.
1.207 leot 3782: <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 3783: automatically.</p>
1.222 gutterid 3784: <p>When updating pre-existing patch files, if a file uses the old
3785: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>
3786: convention, it's best not to change it to the new form, as that will
3787: just cause churn that makes it harder to track changes to patching
3788: over time. Similarly, if a patch now applies at different line offsets,
3789: but still applies cleanly as-is, there's no need to update it, as that
3790: also unnecessarily complicates the patch history.</p>
1.17 imil 3791: </div>
1.160 brook 3792: <div class="sect2">
3793: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3794: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
3795: <p>If you want to share patches between multiple packages
3796: in pkgsrc, e.g. because they use the same distfiles, set
3797: <code class="varname">PATCHDIR</code> to the path where the patch files
3798: can be found, e.g.:</p>
3799: <pre class="programlisting">
3800: PATCHDIR= ../../editors/xemacs/patches
3801: </pre>
3802: <p>Patch files that are distributed by the author or other
3803: maintainers can be listed in
3804: <code class="varname">PATCHFILES</code>.</p>
3805: <p>If it is desired to store any patches that should not be
3806: committed into pkgsrc, they can be kept outside the pkgsrc
3807: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
3808: directory tree there is expected to have the same
3809: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
3810: patches are expected to be stored inside these dirs (also
3811: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
3812: example, if you want to keep a private patch for
3813: <code class="filename">pkgsrc/graphics/png</code>, keep it in
3814: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
3815: files in the named directory are expected to be patch files,
3816: and <span class="emphasis"><em>they are applied after pkgsrc patches are
3817: applied</em></span>.</p>
1.160 brook 3818: </div>
3819: <div class="sect2">
3820: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 3821: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
3822: <p>When fixing a portability issue in the code do not use
3823: preprocessor magic to check for the current operating system nor
3824: platform. Doing so hurts portability to other platforms because
3825: the OS-specific details are not abstracted appropriately.</p>
3826: <p>The general rule to follow is: instead of checking for the
3827: operating system the application is being built on, check for the
3828: specific <span class="emphasis"><em>features</em></span> you need. For example,
3829: instead of assuming that kqueue is available under NetBSD and
3830: using the <code class="varname">__NetBSD__</code> macro to conditionalize
3831: kqueue support, add a check that detects kqueue itself —
3832: yes, this generally involves patching the
3833: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
3834: that prevents some OSes from adopting interfaces from other OSes
3835: (e.g. Linux implementing kqueue), something that the above checks
3836: cannot take into account.</p>
3837: <p>Of course, checking for features generally involves more
3838: work on the developer's side, but the resulting changes are
3839: cleaner and there are chances they will work on many other
3840: platforms. Not to mention that there are higher chances of being
3841: later integrated into the mainstream sources. Remember:
3842: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
3843: <p>Some typical examples:</p>
3844: <div class="table">
3845: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
3846: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
3847: <colgroup>
3848: <col>
3849: <col>
3850: <col>
3851: </colgroup>
3852: <thead><tr>
3853: <th>Where</th>
3854: <th>Incorrect</th>
3855: <th>Correct</th>
3856: </tr></thead>
3857: <tbody>
3858: <tr>
3859: <td>configure script</td>
3860: <td>
1.160 brook 3861: <pre class="programlisting">
1.184 rillig 3862: case ${target_os} in
3863: netbsd*) have_kvm=yes ;;
3864: *) have_kvm=no ;;
3865: esac
1.160 brook 3866: </pre>
1.184 rillig 3867: </td>
3868: <td>
1.160 brook 3869: <pre class="programlisting">
1.184 rillig 3870: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160 brook 3871: </pre>
1.184 rillig 3872: </td>
3873: </tr>
3874: <tr>
3875: <td>C source file</td>
3876: <td>
1.1 dsieger 3877: <pre class="programlisting">
1.184 rillig 3878: #if defined(__NetBSD__)
3879: # include <sys/event.h>
3880: #endif
1.1 dsieger 3881: </pre>
1.184 rillig 3882: </td>
3883: <td>
1.1 dsieger 3884: <pre class="programlisting">
1.184 rillig 3885: #if defined(HAVE_SYS_EVENT_H)
3886: # include <sys/event.h>
3887: #endif
1.1 dsieger 3888: </pre>
1.184 rillig 3889: </td>
3890: </tr>
3891: <tr>
3892: <td>C source file</td>
3893: <td>
1.1 dsieger 3894: <pre class="programlisting">
1.184 rillig 3895: int
3896: monitor_file(...)
3897: {
3898: #if defined(__NetBSD__)
3899: int fd = kqueue();
3900: ...
3901: #else
3902: ...
3903: #endif
3904: }
1.1 dsieger 3905: </pre>
1.184 rillig 3906: </td>
3907: <td>
1.1 dsieger 3908: <pre class="programlisting">
1.184 rillig 3909: int
3910: monitor_file(...)
3911: {
3912: #if defined(HAVE_KQUEUE)
3913: int fd = kqueue();
3914: ...
3915: #else
3916: ...
3917: #endif
3918: }
1.1 dsieger 3919: </pre>
1.184 rillig 3920: </td>
3921: </tr>
3922: </tbody>
3923: </table></div>
3924: </div>
3925: <br class="table-break">
3926: </div>
3927: <div class="sect2">
3928: <div class="titlepage"><div><div><h3 class="title">
3929: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
3930: <p>Always, always, <span class="strong"><strong>always</strong></span>
3931: feed back any <span class="emphasis"><em>portability fixes</em></span> or
3932: improvements you do to a package to the mainstream developers.
3933: This is the only way to get their attention on portability issues
3934: and to ensure that future versions can be built out-of-the box on
3935: NetBSD. Furthermore, any user that gets newer distfiles will get
3936: the fixes straight from the packaged code.</p>
3937: <p>This generally involves cleaning up the patches
3938: (because sometimes the patches that are
3939: added to pkgsrc are quick hacks), filing bug reports in the
3940: appropriate trackers for the projects and working with the
3941: mainstream authors to accept your changes. It is
3942: <span class="emphasis"><em>extremely important</em></span> that you do it so that
3943: the packages in pkgsrc are kept simple and thus further changes
3944: can be done without much hassle.</p>
3945: <p>When you have done this, please add a URL to the upstream
3946: bug report to the patch comment.</p>
3947: <p>Support the idea of free software!</p>
3948: </div>
1.1 dsieger 3949: </div>
1.184 rillig 3950: <div class="sect1">
3951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3952: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
3953: <div class="variablelist"><dl class="variablelist">
3954: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
3955: <dd><p>A multi-line description of the piece of software. This should include
3956: any credits where they are due. Please bear in mind that others do not
3957: share your sense of humour (or spelling idiosyncrasies), and that others
3958: will read everything that you write here.</p></dd>
3959: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
3960: <dd><p>This file governs the files that are installed on your
3961: system: all the binaries, manual pages, etc. There are other
3962: directives which may be entered in this file, to control the
3963: creation and deletion of directories, and the location of
3964: inserted files. See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
3965: information.</p></dd>
3966: </dl></div>
3967: </div>
3968: <div class="sect1">
3969: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3970: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
3971: <div class="sect2">
3972: <div class="titlepage"><div><div><h3 class="title">
3973: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
3974: <div class="variablelist"><dl class="variablelist">
3975: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
3976: <dd>
1.246 leot 3977: <p>This shell script is invoked twice by <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.184 rillig 3978: First time after package extraction and before files are
3979: moved in place, the second time after the files to install
3980: are moved in place. This can be used to do any custom
3981: procedures not possible with @exec commands in
1.246 leot 3982: <code class="filename">PLIST</code>. See <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
3983: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 3984: Please note that you can modify variables in it easily by using
3985: <code class="varname">FILES_SUBST</code> in the package's
3986: <code class="filename">Makefile</code>:</p>
1.1 dsieger 3987: <pre class="programlisting">
1.184 rillig 3988: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3989: </pre>
1.184 rillig 3990: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
3991: <code class="filename">INSTALL</code>. By default, substitution is
3992: performed for <code class="varname">PREFIX</code>,
3993: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
3994: <code class="varname">VARBASE</code>, and a few others, type
3995: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
3996: complete list.</p>
3997: </dd>
3998: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
3999: <dd><p>This script is executed before and after any files are removed. It is
4000: this script's responsibility to clean up any additional messy details
4001: around the package's installation, since all pkg_delete knows is how to
4002: delete the files created in the original distribution.
1.246 leot 4003: See <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4004: and <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.184 rillig 4005: The same methods to replace variables can be used as for
4006: the <code class="filename">INSTALL</code> file.</p></dd>
4007: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4008: <dd>
4009: <p>This file is displayed after installation of the package.
1.198 leot 4010: While this was used often in the past, it has two
4011: problems: the display will be missed if many packages are
4012: intalled at once, and the person installing the package
4013: and the one using or configuring it may be different. It
4014: should therefore be used only in exceptional circumstances
4015: where lasting negative consequences would result from
4016: someone not reading it.</p>
4017: <p>MESSAGE should not be used for:</p>
4018: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
4019: <li class="listitem"><p>exhortations to read the documentation</p></li>
4020: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
4021: <li class="listitem"><p>anything that should be explained in the
4022: installation/configuration documentation that should
4023: come with the package</p></li>
4024: </ul></div>
4025: <p>If the documentation provided by upstream needs
4026: enhancing, create e.g. files/README.pkgsrc and install it
4027: in the package's documentation directory.
4028: </p>
4029: <p>Note that MESSAGE is shown for all operating
4030: systems and all init systems. If a MESSAGE is necessary,
4031: it should be narrowed to only those operating systems and
4032: init systems to which it applies.</p>
4033: <p>Note that you can modify variables in it easily by using
1.184 rillig 4034: <code class="varname">MESSAGE_SUBST</code> in the package's
4035: <code class="filename">Makefile</code>:</p>
1.1 dsieger 4036: <pre class="programlisting">
1.184 rillig 4037: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 4038: </pre>
1.184 rillig 4039: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
4040: <code class="filename">MESSAGE</code>. By default, substitution is
4041: performed for <code class="varname">PKGNAME</code>,
4042: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4043: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4044: <code class="varname">PKG_SYSCONFDIR</code>,
4045: <code class="varname">ROOT_GROUP</code>, and
4046: <code class="varname">ROOT_USER</code>.</p>
4047: <p>You can display a different or additional files by
4048: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4049: default is <code class="filename">MESSAGE</code>, if the file
4050: exists.</p>
4051: </dd>
4052: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4053: <dd>
4054: <p>This file is used by the alternatives framework.
4055: It creates, configures, and destroys generic wrappers used to
4056: run programs with similar interfaces.
4057: See pkg_alternatives(8) from pkgtools/pkg_alternatives
4058: for more information.</p>
4059: <p>Each line of the file contains two filenames, first
4060: the wrapper and then the alternative provided by the package.
4061: Both paths are relative to <code class="varname">PREFIX</code>.</p>
4062: </dd>
4063: </dl></div>
4064: </div>
4065: <div class="sect2">
4066: <div class="titlepage"><div><div><h3 class="title">
4067: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
4068: <div class="variablelist"><dl class="variablelist">
4069: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4070: <dd><p>This file contains arbitrary things that could
4071: also go into a <code class="filename">Makefile</code>, but its purpose is
4072: to be used by more than one package. This file should only be
4073: used when the packages that will use the file are known in
4074: advance. For other purposes it is often better to write a
4075: <code class="filename">*.mk</code> file and give it a good name that
4076: describes what it does.</p></dd>
4077: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4078: <dd><p>This file contains the dependency information
4079: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
4080: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4081: <dd><p>This file contains workarounds for compiler bugs
4082: and similar things. It is included automatically by the pkgsrc
4083: infrastructure, so you don't need an extra
4084: <code class="literal">.include</code> line for
4085: it.</p></dd>
4086: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4087: <dd><p>This file contains the code for the
4088: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
4089: selected by the user. If a package has only one or two options,
4090: it is equally acceptable to put the code directly into the
4091: <code class="filename">Makefile</code>.</p></dd>
4092: </dl></div>
4093: </div>
4094: <div class="sect2">
4095: <div class="titlepage"><div><div><h3 class="title">
4096: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
4097: <div class="variablelist"><dl class="variablelist">
4098: <dt><span class="term"><code class="filename">README*</code></span></dt>
4099: <dd><p>These files do not take place in the creation of
4100: a package and thus are purely informative to the package
4101: developer.</p></dd>
4102: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4103: <dd><p>This file contains things that need to be done
4104: to make the package even
4105: better.</p></dd>
4106: </dl></div>
4107: </div>
4108: </div>
4109: <div class="sect1">
4110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4111: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
4112: </h2></div></div></div>
4113: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4114: unpacked into the directory denoted by
4115: <code class="varname">WRKDIR</code>. It can be removed by running
4116: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4117: directory is also used to keep various timestamp files.
4118: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4119: The default is <code class="filename">${.CURDIR}/work</code>
4120: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4121: if <code class="varname">OBJMACHINE</code> is set.</p>
1.1 dsieger 4122: </div>
1.184 rillig 4123: <div class="sect1">
4124: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4125: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
4126: </h2></div></div></div>
4127: <p>If you have any files that you wish to be placed in the package
4128: prior to configuration or building, you can place these files here
4129: and use a <span class="command"><strong>${CP}</strong></span> command in the
4130: <span class="quote">“<span class="quote">post-extract</span>”</span> target to achieve this.</p>
4131: <p>If you want to share files in this way with other
4132: packages, set the <code class="varname">FILESDIR</code> variable to point
4133: to the other package's <code class="filename">files</code> directory,
4134: e.g.:</p>
1.1 dsieger 4135: <pre class="programlisting">
1.184 rillig 4136: FILESDIR= ../../editors/xemacs/files
1.1 dsieger 4137: </pre>
4138: </div>
4139: </div>
1.41 asau 4140: <div class="chapter">
1.1 dsieger 4141: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 4142: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1 dsieger 4143: <div class="toc">
4144: <p><b>Table of Contents</b></p>
1.100 leot 4145: <dl class="toc">
1.184 rillig 4146: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
4147: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
4148: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
4149: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
4150: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
4151: <dd><dl>
4152: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
4153: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
4154: </dl></dd>
4155: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
4156: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
4157: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
4158: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
4159: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
4160: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
4161: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
4162: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
4163: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
4164: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
4165: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
4166: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1 dsieger 4167: </dl>
4168: </div>
1.41 asau 4169: <div class="sect1">
1.1 dsieger 4170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4171: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
4172: <p>This chapter gives a detailed description on how a package is
4173: built. Building a package is separated into different
4174: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
4175: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
4176: described in the following sections. Each phase is split into
4177: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
4178: containing phase, prefixed by one of <code class="varname">pre-</code>,
4179: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
4180: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
4181: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
4182: <p>Never override the regular targets (like
4183: <code class="varname">fetch</code>), if you have to, override the
4184: <code class="varname">do-*</code> ones instead.</p>
4185: <p>The basic steps for building a program are always the same. First
4186: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
4187: the local system and then extracted. After any pkgsrc-specific patches
4188: to compile properly are applied, the software can be configured, then
4189: built (usually by compiling), and finally the generated binaries, etc.
4190: can be put into place on the system.</p>
4191: <p>To get more details about what is happening at each step,
4192: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
4193: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
4194: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
4195: </div>
4196: <div class="sect1">
4197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4198: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
4199: <p>Before outlining the process performed by the NetBSD package system in
4200: the next section, here's a brief discussion on where programs are
4201: installed, and which variables influence this.</p>
4202: <p>The automatic variable <code class="varname">PREFIX</code> indicates
4203: where all files of the final program shall be installed. It is
4204: usually set to <code class="varname">LOCALBASE</code>
4205: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
4206: for pkgs in the <code class="filename">cross</code> category. The value of
4207: <code class="varname">PREFIX</code> needs to be put
4208: into the various places in the program's source where paths to
4209: 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>
4210: <p>When choosing which of these variables to use,
4211: follow the following rules:</p>
1.41 asau 4212: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 4213: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
4214: where the current pkg will be installed. When referring to a
4215: pkg's own installation path, use
4216: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
1.223 nia 4217: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all pkgs
1.184 rillig 4218: are installed. If you need to construct a -I or -L argument
4219: to the compiler to find includes and libraries installed by
1.223 nia 4220: another pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.184 rillig 4221: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
4222: installed all packages in <code class="filename">/usr/local</code>. As
4223: pkgsrc leaves <code class="filename">/usr/local</code> for the system
4224: administrator, this variable is a misnomer.</p></li>
4225: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
4226: distribution (from xsrc, etc.) is installed. When looking for
4227: <span class="emphasis"><em>standard</em></span> X11 includes (not those
4228: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
4229: <li class="listitem"><p>X11-based packages using imake must set
4230: <code class="varname">USE_IMAKE</code> to be installed correctly under
4231: <code class="varname">LOCALBASE</code>.</p></li>
4232: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.246 leot 4233: install files according to <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.184 rillig 4234: manual pages go into <code class="filename">${PREFIX}/man</code>, not
4235: <code class="filename">${PREFIX}/share/man</code>.</p></li>
4236: </ul></div>
4237: </div>
4238: <div class="sect1">
4239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4240: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
4241: <p>When building a package, various directories are used to store
4242: source files, temporary files, pkgsrc-internal files, and so on. These
4243: directories are explained here.</p>
4244: <p>Some of the directory variables contain relative pathnames. There
4245: are two common base directories for these relative directories:
4246: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
4247: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
4248: inside the package itself.</p>
4249: <div class="variablelist"><dl class="variablelist">
4250: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
4251: <dd><p>This is an absolute pathname that points to the pkgsrc
4252: root directory. Generally, you don't need
4253: it.</p></dd>
4254: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
4255: <dd><p>This is an absolute pathname that points to the
4256: current package.</p></dd>
4257: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
1.228 gutterid 4258: <dd>
4259: <p>This is a pathname relative to
4260: <code class="varname">PKGSRCDIR</code> that points to the current package.
4261: It is defined after including <code class="filename">bsd.prefs.mk</code>
4262: and can be used in makefile fragments that are used by several
4263: packages to distinguish between these packages. Other variables
4264: that would serve the same purpose are <code class="varname">PKGBASE</code>
4265: and <code class="varname">PKGNAME</code>, but these are only defined after
4266: including <code class="filename">bsd.pkg.mk</code>, which is too
4267: late.</p>
4268: <p>In <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the pkgsrc user can use
4269: <code class="varname">PKGPATH</code> to tweak variables like
4270: <code class="varname">MAKE_JOBS</code> and
4271: <code class="varname">CFLAGS</code>.</p>
4272: </dd>
1.184 rillig 4273: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
4274: <dd><p>This is an absolute pathname pointing to the directory
4275: where all work takes place. The distfiles are extracted to this
4276: directory. It also contains temporary directories and log files used by
4277: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
4278: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
4279: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
4280: <dd><p>This is an absolute pathname pointing to the directory
4281: where the distfiles are extracted. It is usually a direct subdirectory
4282: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
4283: that isn't hidden. This variable may be changed by a package
4284: <code class="filename">Makefile</code>.</p></dd>
4285: </dl></div>
4286: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
4287: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
4288: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
4289: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
4290: If users would like to have their pkgsrc trees behave in a
4291: read-only manner, then the value of
4292: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
4293: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 4294: </div>
1.41 asau 4295: <div class="sect1">
1.1 dsieger 4296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4297: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
4298: <p>You can run a particular phase by typing <span class="command"><strong>make
1.228 gutterid 4299: <em class="replaceable"><code>phase</code></em></strong></span>, where
4300: <em class="replaceable"><code>phase</code></em> is the name of the phase. This will
4301: automatically run all phases that are required for this phase. The
4302: default phase is <code class="varname">build</code>, that is, when you run
4303: <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.184 rillig 4304: the package will be built, but not installed.</p>
1.1 dsieger 4305: </div>
1.41 asau 4306: <div class="sect1">
1.1 dsieger 4307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4308: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
4309: <p>The first step in building a package is to fetch the
4310: distribution files (distfiles) from the sites that are providing
4311: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
4312: phase.</p>
1.41 asau 4313: <div class="sect2">
1.1 dsieger 4314: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 4315: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
4316: <p>In simple cases, <code class="varname">MASTER_SITES</code>
4317: defines all URLs from where the distfile, whose name is
4318: derived from the <code class="varname">DISTNAME</code> variable, is
4319: fetched. The more complicated cases are described
4320: below.</p>
4321: <p>The variable <code class="varname">DISTFILES</code> specifies
4322: the list of distfiles that have to be fetched. Its value
4323: defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
4324: its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
4325: so that most packages don't need to define it at all.
4326: <code class="varname">EXTRACT_SUFX</code> is
4327: <code class="literal">.tar.gz</code> by default, but can be changed
4328: freely. Note that if your package requires additional
4329: distfiles to the default one, you cannot just append the
4330: additional filenames using the <code class="literal">+=</code>
4331: operator, but you have write for example:</p>
4332: <pre class="programlisting">
4333: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
4334: </pre>
4335: <p>Each distfile is fetched from a list of sites, usually
4336: <code class="varname">MASTER_SITES</code>. If the package has multiple
4337: <code class="varname">DISTFILES</code> or multiple
4338: <code class="varname">PATCHFILES</code> from different sites, you can
4339: set
4340: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
4341: to the list of URLs where the file
4342: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
4343: (including the suffix) can be found.</p>
4344: <pre class="programlisting">
4345: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4346: DISTFILES+= foo-file.tar.gz
4347: SITES.foo-file.tar.gz= \
4348: https://www.somewhere.com/somehow/ \
4349: https://www.somewhereelse.com/mirror/somehow/
4350: </pre>
4351: <p>When actually fetching the distfiles, each item from
4352: <code class="varname">MASTER_SITES</code> or
4353: <code class="varname">SITES.*</code> gets the name of each distfile
4354: appended to it, without an intermediate slash. Therefore,
4355: all site values have to end with a slash or other separator
4356: character. This allows for example to set
4357: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
4358: that gets the name of the distfile as a parameter. In this
4359: case, the definition would look like:</p>
4360: <pre class="programlisting">
4361: MASTER_SITES= https://www.example.com/download.cgi?file=
4362: </pre>
4363: <p> The exception to this rule are URLs starting with a dash.
4364: In that case the URL is taken as is, fetched and the result
4365: stored under the name of the distfile. You can use this style
4366: for the case when the download URL style does not match the
4367: above common case. For example, if permanent download URL is a
4368: redirector to the real download URL, or the download file name
4369: is offered by an HTTP Content-Disposition header. In the
4370: following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
4371: created instead of the default
4372: <code class="filename">v1.0.0.tar.gz</code>.</p>
4373: <pre class="programlisting">
4374: DISTNAME= foo-1.0.0
4375: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
4376: </pre>
4377: <p>There are some predefined values for
4378: <code class="varname">MASTER_SITES</code>, which can be used in
4379: packages. The names of the variables should speak for
4380: themselves.</p>
4381: <table border="0" summary="Simple list" class="simplelist">
4382: <tr>
4383: <td>MASTER_SITE_APACHE</td>
4384: <td>MASTER_SITE_BACKUP</td>
4385: </tr>
4386: <tr>
4387: <td>MASTER_SITE_CRATESIO</td>
4388: <td>MASTER_SITE_CYGWIN</td>
4389: </tr>
4390: <tr>
4391: <td>MASTER_SITE_DEBIAN</td>
4392: <td>MASTER_SITE_FREEBSD</td>
4393: </tr>
4394: <tr>
4395: <td>MASTER_SITE_FREEBSD_LOCAL</td>
4396: <td>MASTER_SITE_GENTOO</td>
4397: </tr>
4398: <tr>
4399: <td>MASTER_SITE_GITHUB</td>
1.225 gutterid 4400: <td>MASTER_SITE_GITLAB</td>
4401: </tr>
4402: <tr>
1.184 rillig 4403: <td>MASTER_SITE_GNOME</td>
1.225 gutterid 4404: <td>MASTER_SITE_GNU</td>
1.184 rillig 4405: </tr>
4406: <tr>
4407: <td>MASTER_SITE_GNUSTEP</td>
1.225 gutterid 4408: <td>MASTER_SITE_HASKELL_HACKAGE</td>
1.184 rillig 4409: </tr>
4410: <tr>
4411: <td>MASTER_SITE_IFARCHIVE</td>
1.225 gutterid 4412: <td>MASTER_SITE_KDE</td>
1.184 rillig 4413: </tr>
4414: <tr>
4415: <td>MASTER_SITE_MOZILLA</td>
1.225 gutterid 4416: <td>MASTER_SITE_MOZILLA_ALL</td>
1.184 rillig 4417: </tr>
4418: <tr>
4419: <td>MASTER_SITE_MYSQL</td>
1.225 gutterid 4420: <td>MASTER_SITE_NETLIB</td>
1.184 rillig 4421: </tr>
4422: <tr>
4423: <td>MASTER_SITE_OPENBSD</td>
1.225 gutterid 4424: <td>MASTER_SITE_OPENOFFICE</td>
1.184 rillig 4425: </tr>
4426: <tr>
4427: <td>MASTER_SITE_OSDN</td>
1.225 gutterid 4428: <td>MASTER_SITE_PERL_CPAN</td>
1.184 rillig 4429: </tr>
4430: <tr>
4431: <td>MASTER_SITE_PGSQL</td>
1.225 gutterid 4432: <td>MASTER_SITE_PYPI</td>
1.184 rillig 4433: </tr>
4434: <tr>
4435: <td>MASTER_SITE_RUBYGEMS</td>
1.225 gutterid 4436: <td>MASTER_SITE_R_CRAN</td>
1.184 rillig 4437: </tr>
4438: <tr>
4439: <td>MASTER_SITE_SOURCEFORGE</td>
1.225 gutterid 4440: <td>MASTER_SITE_SUNSITE</td>
1.184 rillig 4441: </tr>
1.1 dsieger 4442: <tr>
1.184 rillig 4443: <td>MASTER_SITE_SUSE</td>
1.225 gutterid 4444: <td>MASTER_SITE_TEX_CTAN</td>
1.1 dsieger 4445: </tr>
4446: <tr>
1.184 rillig 4447: <td>MASTER_SITE_XCONTRIB</td>
1.225 gutterid 4448: <td>MASTER_SITE_XEMACS</td>
1.1 dsieger 4449: </tr>
4450: <tr>
1.184 rillig 4451: <td>MASTER_SITE_XORG</td>
1.225 gutterid 4452: <td> </td>
1.184 rillig 4453: </tr>
4454: </table>
4455: <p>Some explanations for the less self-explaining ones:
4456: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.254 wiz 4457: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.184 rillig 4458: 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>
4459: <p>If you choose one of these predefined sites, you may
4460: want to specify a subdirectory of that site. Since these
4461: macros may expand to more than one actual site, you
4462: <span class="emphasis"><em>must</em></span> use the following construct to
4463: specify a subdirectory:</p>
1.1 dsieger 4464: <pre class="programlisting">
1.184 rillig 4465: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4466: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 4467: </pre>
1.184 rillig 4468: <p>Note the trailing slash after the subdirectory
4469: name.</p>
4470: </div>
4471: <div class="sect2">
4472: <div class="titlepage"><div><div><h3 class="title">
4473: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
4474: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
4475: all the distfiles exist in a local directory
4476: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
4477: user). If the files do not exist, they are fetched using
4478: commands of the form</p>
1.1 dsieger 4479: <pre class="programlisting">
1.184 rillig 4480: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4481: </pre>
4482: <p>where <code class="literal">${site}</code> varies through
4483: several possibilities in turn: first,
4484: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
4485: sites specified in either <code class="varname">SITES.file</code> if
4486: defined, else <code class="varname">MASTER_SITES</code> or
4487: <code class="varname">PATCH_SITES</code>, as applies, then finally the
4488: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
4489: all except the first and the last can be optionally sorted
4490: by the user, via setting either
4491: <code class="varname">MASTER_SORT_RANDOM</code>, and
4492: <code class="varname">MASTER_SORT_AWK</code> or
4493: <code class="varname">MASTER_SORT_REGEX</code>.</p>
4494: <p> The specific command and arguments used depend on the
4495: <code class="varname">FETCH_USING</code> parameter. The example above is
4496: for <code class="literal">FETCH_USING=custom</code>.</p>
4497: <p>The distfiles mirror run by the NetBSD Foundation uses the
4498: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
4499: distfiles, if they are freely distributable. Packages setting
4500: <code class="varname">NO_SRC_ON_FTP</code> (usually to
4501: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
4502: mirrored.</p>
1.1 dsieger 4503: </div>
4504: </div>
1.184 rillig 4505: <div class="sect1">
4506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4507: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
4508: <p>After the distfile(s) are fetched, their checksum is
4509: generated and compared with the checksums stored in the
4510: distinfo file. If the checksums don't match, the build is
4511: aborted. This is to ensure the same distfile is used for
4512: building, and that the distfile wasn't changed, e.g. by some
4513: malign force, deliberately changed distfiles on the master
4514: distribution site or network lossage.</p>
1.1 dsieger 4515: </div>
1.41 asau 4516: <div class="sect1">
1.1 dsieger 4517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4518: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
4519: <p>When the distfiles are present on the local system, they
4520: need to be extracted, as they usually come in the form of some
4521: compressed archive format.</p>
4522: <p>By default, all <code class="varname">DISTFILES</code> are
4523: extracted. If you only need some of them, you can set the
4524: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
4525: files.</p>
4526: <p>Extracting the files is usually done by a little
4527: program, <code class="filename">mk/extract/extract</code>, which
4528: already knows how to extract various archive formats, so most
4529: likely you will not need to change anything here. But if you
4530: need, the following variables may help you:</p>
1.41 asau 4531: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4532: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
4533: <dd><p>Use these variables to override the default
4534: options for an extract command, which are defined in
4535: <code class="filename">mk/extract/extract</code>.</p></dd>
4536: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
4537: <dd><p>This variable can be set to
4538: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
4539: (which is the default value), <code class="literal">pax</code>, or an
4540: absolute pathname pointing to the command with which tar
4541: archives should be extracted. It is preferred to choose bsdtar over gtar
4542: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 4543: </dl></div>
1.184 rillig 4544: <p>If the <code class="filename">extract</code> program doesn't
4545: serve your needs, you can also override the
4546: <code class="varname">EXTRACT_CMD</code> variable, which holds the
4547: command used for extracting the files. This command is
4548: executed in the <code class="filename">${WRKSRC}</code>
4549: directory. During execution of this command, the shell
4550: variable <code class="varname">extract_file</code> holds the absolute
4551: pathname of the file that is going to be extracted.</p>
4552: <p>And if that still does not suffice, you can override the
4553: <code class="varname">do-extract</code> target in the package
4554: Makefile.</p>
1.1 dsieger 4555: </div>
1.41 asau 4556: <div class="sect1">
1.1 dsieger 4557: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4558: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
4559: <p>After extraction, all the patches named by the
4560: <code class="varname">PATCHFILES</code>, those present in the patches
4561: subdirectory of the package as well as in
4562: $LOCALPATCHES/$PKGPATH (e.g.
4563: <code class="filename">/usr/local/patches/graphics/png</code>) are
4564: applied. Patchfiles ending in <code class="filename">.Z</code> or
4565: <code class="filename">.gz</code> are uncompressed before they are
4566: applied, files ending in <code class="filename">.orig</code> or
4567: <code class="filename">.rej</code> are ignored. Any special options to
1.246 leot 4568: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.184 rillig 4569: <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.246 leot 4570: <p>By default <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.184 rillig 4571: fail if the expected text from the patch context is not found in the
4572: patched file. If that happens, fix the patch file by comparing it
4573: with the actual text in the file to be patched.</p>
1.1 dsieger 4574: </div>
1.41 asau 4575: <div class="sect1">
1.1 dsieger 4576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4577: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
4578: <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>.
4579: </p>
1.1 dsieger 4580: </div>
1.41 asau 4581: <div class="sect1">
1.1 dsieger 4582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4583: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
4584: <p>This phase creates wrapper programs for the compilers and
4585: linkers. The following variables can be used to tweak the
4586: wrappers.</p>
4587: <div class="variablelist"><dl class="variablelist">
4588: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
4589: <dd><p>The command used to print progress
4590: messages. Does nothing by default. Set to
4591: <code class="literal">${ECHO}</code> to see the progress
4592: messages.</p></dd>
4593: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
4594: <dd><p>This variable can be set to
4595: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
4596: depending on whether you want additional information in the
4597: wrapper log file.</p></dd>
4598: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
4599: <dd><p>This variable can be set to
4600: <code class="literal">yes</code> or <code class="literal">no</code>, depending
4601: on whether the wrapper should use its cache, which will
4602: improve the speed. The default value is
4603: <code class="literal">yes</code>, but is forced to
4604: <code class="literal">no</code> if the platform does not support
4605: it.</p></dd>
4606: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
4607: <dd><p>A list of reordering commands. A reordering
4608: command has the form
4609: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
4610: It ensures that that
4611: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
4612: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
4613: </p></dd>
4614: </dl></div>
4615: </div>
4616: <div class="sect1">
4617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4618: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
4619: <p>Most pieces of software need information on the header
4620: files, system calls, and library routines which are available
4621: on the platform they run on. The process of determining this
4622: information is known as configuration, and is usually
4623: automated. In most cases, a script is supplied with the
4624: distfiles, and its invocation results in generation of header
4625: files, Makefiles, etc.</p>
4626: <p>If the package contains a configure script, this can be
4627: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
4628: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
4629: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.187 rillig 4630: <span class="quote">“<span class="quote">yes</span>”</span> instead.</p>
4631: <p>In the <code class="literal">do-configure</code> stage, a rough
4632: equivalent of the following command is run. See
4633: <code class="filename">mk/configure/configure.mk</code>, target
4634: <code class="literal">do-configure-script</code> for the exact
4635: definition.</p>
4636: <pre class="programlisting">
4637: .for dir in ${CONFIGURE_DIRS}
4638: cd ${WRKSRC} && cd ${dir} \
4639: && env ${CONFIGURE_ENV} \
4640: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 4641: .endfor
1.1 dsieger 4642: </pre>
1.184 rillig 4643: <p><code class="varname">CONFIGURE_DIRS</code> (default:
4644: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4645: <code class="varname">WRKSRC</code>. In each of these directories, the
4646: configure script is run with the environment
4647: <code class="varname">CONFIGURE_ENV</code> and arguments
4648: <code class="varname">CONFIGURE_ARGS</code>. The variables
4649: <code class="varname">CONFIGURE_ENV</code>,
4650: <code class="varname">CONFIGURE_SCRIPT</code> (default:
4651: <span class="quote">“<span class="quote">./configure</span>”</span>) and
4652: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
4653: package.</p>
4654: <p>If the program uses the Perl way of configuration (mainly Perl
4655: modules, but not only), i.e. a file called
4656: <code class="filename">Makefile.PL</code>, it should include
4657: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
4658: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
4659: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
4660: <p>If the program uses an <code class="filename">Imakefile</code>
4661: for configuration, the appropriate steps can be invoked by
4662: setting <code class="varname">USE_IMAKE</code> to
4663: <span class="quote">“<span class="quote">yes</span>”</span>. If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
4664: You can add variables to xmkmf's environment by adding them to the
4665: <code class="varname">SCRIPTS_ENV</code> variable.</p>
4666: <p>If the program uses <code class="filename">cmake</code>
4667: for configuration, the appropriate steps can be invoked by
1.233 wiz 4668: including <code class="filename">../../devel/cmake/build.mk</code>.
1.184 rillig 4669: You can add variables to cmake's environment by adding them to the
4670: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
4671: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
1.233 wiz 4672: If you want to add arguments only for particular stages, you can use the
4673: <code class="varname">CMAKE_CONFIGURE_ARGS</code>,
4674: <code class="varname">CMAKE_BUILD_ARGS</code>, and
4675: <code class="varname">CMAKE_INSTALL_ARGS</code> variables.
4676: You can set the <code class="varname">CONFIGURE_DIRS</code> variable to the
4677: directories in which CMake should be run, relative to
4678: <code class="varname">WRKSRC</code>. This defaults to to <span class="quote">“<span class="quote">.</span>”</span>.
4679: </p>
1.184 rillig 4680: <p>If there is no configure step at all, set
4681: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4682: </div>
1.41 asau 4683: <div class="sect1">
1.1 dsieger 4684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4685: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187 rillig 4686: <p>For building a package, a rough equivalent of the following
4687: code is executed; see <code class="filename">mk/build/build.mk</code>, target
4688: <code class="literal">do-build</code> for the exact definition.</p>
1.1 dsieger 4689: <pre class="programlisting">
1.187 rillig 4690: .for dir in ${BUILD_DIRS}
4691: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 4692: && env ${MAKE_ENV} \
1.187 rillig 4693: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 4694: -f ${MAKE_FILE} \
4695: ${BUILD_TARGET}
4696: .endfor
1.1 dsieger 4697: </pre>
1.184 rillig 4698: <p><code class="varname">BUILD_DIRS</code> (default:
4699: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
4700: <code class="varname">WRKSRC</code>. In each of these directories,
4701: <code class="varname">MAKE_PROGRAM</code> is run with the environment
4702: <code class="varname">MAKE_ENV</code> and arguments
4703: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
4704: <code class="varname">MAKE_ENV</code>,
4705: <code class="varname">BUILD_MAKE_FLAGS</code>,
4706: <code class="varname">MAKE_FILE</code> and
4707: <code class="varname">BUILD_TARGET</code> may all be changed by the
4708: package.</p>
4709: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
4710: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
4711: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
4712: default value of <code class="varname">MAKE_FILE</code> is
4713: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
4714: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
4715: <p>If there is no build step at all, set
4716: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 4717: </div>
1.41 asau 4718: <div class="sect1">
1.1 dsieger 4719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4720: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
4721: <p>[TODO]</p>
1.1 dsieger 4722: </div>
1.41 asau 4723: <div class="sect1">
1.1 dsieger 4724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4725: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
4726: <p>Once the build stage has completed, the final step is to
4727: install the software in public directories, so users can
4728: access the programs and files.</p>
1.187 rillig 4729: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
4730: of the following code is executed; see
4731: <code class="filename">mk/install/install.mk</code>, target
4732: <code class="literal">do-install</code> for the exact definition. Additionally,
4733: before and after this code, several consistency checks are run
4734: against the files-to-be-installed, see
4735: <code class="filename">mk/check/*.mk</code> for details.</p>
4736: <pre class="programlisting">
4737: .for dir in ${INSTALL_DIRS}
4738: cd ${WRKSRC} && cd ${dir} \
4739: && env ${INSTALL_ENV} ${MAKE_ENV} \
4740: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
4741: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 4742: .endfor
1.1 dsieger 4743: </pre>
1.184 rillig 4744: <p>The variable's meanings are analogous to the ones in the
4745: <span class="emphasis"><em>build</em></span> phase.
4746: <code class="varname">INSTALL_DIRS</code> defaults to
4747: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
4748: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
4749: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
4750: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
4751: defined.</p>
4752: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
4753: variables are useful. They are all variations of the
1.246 leot 4754: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.184 rillig 4755: permissions preset. <code class="varname">INSTALL</code> is the plain
4756: install command. The specialized variants, together with their
4757: intended use, are:</p>
4758: <div class="variablelist"><dl class="variablelist">
4759: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
4760: <dd><p>directories that contain
4761: binaries</p></dd>
4762: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
4763: <dd><p>directories that contain
4764: scripts</p></dd>
4765: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
4766: <dd><p>directories that contain shared and static
4767: libraries</p></dd>
4768: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
4769: <dd><p>directories that contain data
4770: files</p></dd>
4771: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
4772: <dd><p>directories that contain man
4773: pages</p></dd>
4774: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
4775: <dd><p>directories that contain data files for games
4776: </p></dd>
4777: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
4778: <dd><p>binaries that can be stripped from debugging
4779: symbols</p></dd>
4780: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
4781: <dd><p>binaries that cannot be
4782: stripped</p></dd>
4783: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
4784: <dd><p>game
4785: binaries</p></dd>
4786: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
4787: <dd><p>shared and static
4788: libraries</p></dd>
4789: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
4790: <dd><p>data files</p></dd>
4791: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
4792: <dd><p>data files for
4793: games</p></dd>
4794: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
4795: <dd><p>man pages</p></dd>
4796: </dl></div>
4797: <p>Some other variables are:</p>
4798: <div class="variablelist"><dl class="variablelist">
4799: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.246 leot 4800: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.184 rillig 4801: when installing binaries. Any debugging sections and symbols present in
4802: binaries will be preserved.
4803: </p></dd>
4804: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
4805: <dd><p>A list of directories relative to
4806: <code class="varname">PREFIX</code> that are created by pkgsrc at the
4807: beginning of the <span class="emphasis"><em>install</em></span> phase.
4808: The package is supposed to create all needed directories itself
4809: before installing files to it and list all other directories here.
4810: </p></dd>
4811: </dl></div>
4812: <p>In the rare cases that a package shouldn't install anything,
4813: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
4814: mostly relevant for packages in the <code class="filename">regress</code>
4815: category.</p>
1.1 dsieger 4816: </div>
1.41 asau 4817: <div class="sect1">
1.1 dsieger 4818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4819: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
4820: <p>Once the install stage has completed, a binary package of
4821: the installed files can be built. These binary packages can be
4822: used for quick installation without previous compilation, e.g. by
4823: the <span class="command"><strong>make bin-install</strong></span> or by using
4824: <span class="command"><strong>pkg_add</strong></span>.</p>
4825: <p>By default, the binary packages are created in
4826: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
4827: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
4828: one for each category in the <code class="varname">CATEGORIES</code>
4829: variable. <code class="varname">PACKAGES</code> defaults to
4830: <code class="filename">pkgsrc/packages</code>.</p>
1.1 dsieger 4831: </div>
1.41 asau 4832: <div class="sect1">
1.1 dsieger 4833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4834: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
4835: <p>Once you're finished with a package, you can clean the work
4836: directory by running <span class="command"><strong>make clean</strong></span>. If you want
4837: to clean the work directories of all dependencies too, use
4838: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 4839: </div>
1.41 asau 4840: <div class="sect1">
1.1 dsieger 4841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 4842: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41 asau 4843: <div class="variablelist"><dl class="variablelist">
1.184 rillig 4844: <dt><span class="term">pre/post-*</span></dt>
4845: <dd>
4846: <p>For any of the main targets described in the previous
4847: section (configure, build, install, etc.), two auxiliary
4848: targets exist with
4849: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
4850: prefix for the main target's name. These targets are
4851: invoked before and after the main target is called,
4852: allowing extra configuration or installation steps be
4853: performed from a package's Makefile, for example, which
4854: a program's configure script or install target
4855: omitted.</p>
4856: <p>About 5% of the pkgsrc packages define their custom
4857: post-extract target, another 5% define pre-configure, and 10%
4858: define post-install. The other pre/post-* targets are defined
4859: even less often.</p>
4860: </dd>
4861: <dt><span class="term">do-*</span></dt>
1.1 dsieger 4862: <dd>
1.184 rillig 4863: <p>Should one of the main targets do the wrong thing,
4864: and should there be no variable to fix this, you can
4865: redefine it with the do-* target. (Note that redefining
4866: the target itself instead of the do-* target is a bad
4867: idea, as the pre-* and post-* targets won't be called
4868: anymore, etc.)</p>
4869: <p>About 15% of the pkgsrc packages override the default
4870: do-install, the other do-* targets are overridden even less
4871: often.</p>
1.1 dsieger 4872: </dd>
1.184 rillig 4873: <dt><span class="term">reinstall</span></dt>
1.1 dsieger 4874: <dd>
1.184 rillig 4875: <p>If you did a <span class="command"><strong>make install</strong></span> and
4876: you noticed some file was not installed properly, you
4877: can repeat the installation with this target, which will
4878: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
4879: <p>This is the default value of
4880: <code class="varname">DEPENDS_TARGET</code> except in the case of
4881: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
4882: package</strong></span>, where the defaults are
4883: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
4884: respectively.</p>
1.1 dsieger 4885: </dd>
1.184 rillig 4886: <dt><span class="term">deinstall</span></dt>
4887: <dd>
1.246 leot 4888: <p>This target does a <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.184 rillig 4889: current directory, effectively de-installing the
4890: package. The following variables can be used to tune the
4891: behaviour:</p>
4892: <div class="variablelist"><dl class="variablelist">
4893: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.246 leot 4894: <dd><p>Add a "-v" to the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.184 rillig 4895: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
4896: <dd><p>Remove all packages that require (depend on)
4897: the given package. This can be used to remove any
4898: packages that may have been pulled in by a given
4899: package, e.g. if <span class="command"><strong>make deinstall
4900: DEINSTALLDEPENDS=1</strong></span> is done in
4901: <code class="filename">pkgsrc/x11/kde</code>, this is
4902: likely to remove whole KDE. Works by adding
1.246 leot 4903: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.184 rillig 4904: command line.</p></dd>
4905: </dl></div>
4906: </dd>
4907: <dt><span class="term">bin-install</span></dt>
4908: <dd><p>Install a binary package from local disk and via FTP
4909: from a list of sites (see the
4910: <code class="varname">BINPKG_SITES</code> variable), and do a
4911: <span class="command"><strong>make package</strong></span> if no binary package is
4912: available anywhere. The arguments given to
4913: <span class="command"><strong>pkg_add</strong></span> can be set via
4914: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
4915: operation, etc.</p></dd>
4916: <dt><span class="term">install-clean</span></dt>
4917: <dd><p>This target removes the state files for the "install" and later
4918: phases so that the "install" target may be re-invoked. This can be
4919: used after editing the PLIST to install the package without
4920: rebuilding it.</p></dd>
4921: <dt><span class="term">build-clean</span></dt>
4922: <dd><p>This target removes the state files for the "build" and later
4923: phases so that the "build" target may be re-invoked.</p></dd>
4924: <dt><span class="term">update</span></dt>
4925: <dd>
4926: <p>This target causes the current package to be
4927: updated to the latest version. The package and all
4928: depending packages first get de-installed, then current
4929: versions of the corresponding packages get compiled and
4930: installed. This is similar to manually noting which
4931: packages are currently installed, then performing a
4932: series of <span class="command"><strong>make deinstall</strong></span> and
4933: <span class="command"><strong>make install</strong></span> (or whatever
4934: <code class="varname">UPDATE_TARGET</code> is set to) for these
4935: packages.</p>
4936: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
4937: resume package updating in case a previous <span class="command"><strong>make
4938: update</strong></span> was interrupted for some reason.
4939: However, in this case, make sure you don't call
4940: <span class="command"><strong>make clean</strong></span> or otherwise remove the
4941: list of dependent packages in <code class="varname">WRKDIR</code>.
4942: Otherwise, you lose the ability to automatically update
4943: the current package along with the dependent packages
4944: you have installed.</p>
4945: <p>Resuming an interrupted <span class="command"><strong>make
4946: update</strong></span> will only work as long as the package
4947: tree remains unchanged. If the source code for one of
4948: the packages to be updated has been changed, resuming
4949: <span class="command"><strong>make update</strong></span> will most certainly
4950: fail!</p>
4951: <p>The following variables can be used either on the
4952: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
4953: alter the behaviour of <span class="command"><strong>make
4954: update</strong></span>:</p>
4955: <div class="variablelist"><dl class="variablelist">
4956: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
4957: <dd><p>Install target to recursively use for the
4958: updated package and the dependent packages.
4959: Defaults to <code class="varname">DEPENDS_TARGET</code> if
4960: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
4961: <span class="command"><strong>make update</strong></span>. Other good
4962: targets are <span class="quote">“<span class="quote">package</span>”</span> or
4963: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
4964: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
4965: endless loop!</p></dd>
4966: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
4967: <dd><p>Don't clean up after updating. Useful if
4968: you want to leave the work sources of the updated
4969: packages around for inspection or other purposes.
4970: Be sure you eventually clean up the source tree
4971: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
4972: or you may run into troubles with old source code
4973: still lying around on your next
4974: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
4975: update</strong></span>.</p></dd>
4976: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
4977: <dd><p>Deinstall each package before installing
4978: (making <code class="varname">DEPENDS_TARGET</code>). This
4979: may be necessary if the
4980: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
4981: called after interrupting a running <span class="command"><strong>make
4982: update</strong></span>.</p></dd>
4983: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
4984: <dd><p>Allows you to disable recursion and hardcode
4985: the target for packages. The default is
4986: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
4987: facilitating a recursive update of prerequisite
4988: packages. Only set
4989: <code class="varname">DEPENDS_TARGET</code> if you want to
4990: disable recursive updates. Use
4991: <code class="varname">UPDATE_TARGET</code> instead to just
4992: set a specific target for each package to be
4993: installed during <span class="command"><strong>make update</strong></span>
4994: (see above).</p></dd>
4995: </dl></div>
4996: </dd>
4997: <dt><span class="term">clean-update</span></dt>
4998: <dd>
4999: <p>Clean the source tree for all packages that would
5000: get updated if <span class="command"><strong>make update</strong></span> was called
5001: from the current directory. This target should not be
5002: used if the current package (or any of its depending
5003: packages) have already been de-installed (e.g., after
5004: calling <span class="command"><strong>make update</strong></span>) or you may lose
5005: some packages you intended to update. As a rule of
5006: thumb: only use this target <span class="emphasis"><em>before</em></span>
5007: the first time you run <span class="command"><strong>make update</strong></span>
5008: and only if you have a dirty package tree (e.g., if you
5009: used <code class="varname">NOCLEAN</code>).</p>
5010: <p>If you are unsure about whether your tree is
5011: clean, you can either perform a <span class="command"><strong>make
5012: clean</strong></span> at the top of the tree, or use the
5013: following sequence of commands from the directory of the
5014: package you want to update (<span class="emphasis"><em>before</em></span>
5015: running <span class="command"><strong>make update</strong></span> for the first
5016: time, otherwise you lose all the packages you wanted to
5017: update!):</p>
5018: <pre class="screen">
5019: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
5020: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
5021: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
5022: </pre>
5023: <p>The following variables can be used either on the
5024: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
5025: <span class="command"><strong>make clean-update</strong></span>:</p>
5026: <div class="variablelist"><dl class="variablelist">
5027: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
5028: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
5029: reconstruct the list of directories to update for
5030: this package. Only use this if <span class="command"><strong>make
5031: update</strong></span> successfully installed all
5032: packages you wanted to update. Normally, this is
5033: done automatically on <span class="command"><strong>make
5034: update</strong></span>, but may have been suppressed by
5035: the <code class="varname">NOCLEAN</code> variable (see
5036: above).</p></dd>
5037: </dl></div>
5038: </dd>
5039: <dt><span class="term">replace</span></dt>
5040: <dd>
5041: <p>Update the installation of the current package. This
5042: differs from update in that it does not replace dependent
1.207 leot 5043: 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 5044: target to work.</p>
5045: <p><span class="emphasis"><em>Be careful when using this
5046: target!</em></span> There are no guarantees that dependent
5047: packages will still work, in particular they will most
5048: certainly break if you <span class="command"><strong>make replace</strong></span> a
5049: library package whose shared library major version changed
5050: between your installed version and the new one. For this
5051: reason, this target is not officially supported and only
5052: recommended for advanced users.</p>
5053: </dd>
5054: <dt><span class="term">info</span></dt>
1.246 leot 5055: <dd><p>This target invokes <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.184 rillig 5056: package. You can use this to check which version of a
5057: package is installed.</p></dd>
5058: <dt><span class="term">index</span></dt>
5059: <dd>
5060: <p>This is a top-level command, i.e. it should be used in
5061: the <code class="filename">pkgsrc</code> directory. It creates a
5062: database of all packages in the local pkgsrc tree, including
5063: dependencies, comment, maintainer, and some other useful
5064: information. Individual entries are created by running
5065: <span class="command"><strong>make describe</strong></span> in the packages'
5066: directories. This index file is saved as
5067: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
5068: verbose format by running <span class="command"><strong>make
5069: print-index</strong></span>. You can search in it with
5070: <span class="command"><strong>make search
5071: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
5072: extract a list of all packages that depend on a particular
5073: one by running <span class="command"><strong>make show-deps
5074: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
5075: <p>Running this command takes a very long time, some
5076: hours even on fast machines!</p>
5077: </dd>
5078: <dt><span class="term">readme</span></dt>
5079: <dd>
5080: <p>This target generates a
1.199 nia 5081: <code class="filename">index.html</code> file, which can be
1.207 leot 5082: 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 5083: contain references to any packages which are in the
5084: <code class="varname">PACKAGES</code> directory on the local
5085: host. The generated files can be made to refer to URLs
5086: based on <code class="varname">FTP_PKG_URL_HOST</code> and
5087: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.199 nia 5088: wanted to generate <code class="filename">index.html</code>
1.184 rillig 5089: files which pointed to binary packages on the local
5090: machine, in the directory
5091: <code class="filename">/usr/packages</code>, set
5092: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
5093: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
5094: <code class="varname">${PACKAGES}</code> directory and its
5095: subdirectories will be searched for all the binary
5096: packages.</p>
5097: <p>The target can be run at the toplevel or in category
5098: directories, in which case it descends recursively.</p>
5099: </dd>
5100: <dt><span class="term">readme-all</span></dt>
5101: <dd><p>This is a top-level command, run it in
5102: <code class="filename">pkgsrc</code>. Use this target to create a
5103: file <code class="filename">README-all.html</code> which contains a
5104: list of all packages currently available in the NetBSD
5105: Packages Collection, together with the category they belong
5106: to and a short description. This file is compiled from the
1.199 nia 5107: <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.184 rillig 5108: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
5109: readme</strong></span>.</p></dd>
5110: <dt><span class="term">cdrom-readme</span></dt>
5111: <dd><p>This is very much the same as the
5112: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
5113: used when generating a pkgsrc tree to be written to a
5114: CD-ROM. This target also produces
1.199 nia 5115: <code class="filename">index.html</code> files, and can be made
1.184 rillig 5116: to refer to URLs based on
5117: <code class="varname">CDROM_PKG_URL_HOST</code> and
5118: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
5119: <dt><span class="term">show-distfiles</span></dt>
5120: <dd><p>This target shows which distfiles and patchfiles
5121: are needed to build the package
5122: (<code class="varname">ALLFILES</code>, which contains all
5123: <code class="varname">DISTFILES</code> and
5124: <code class="varname">PATCHFILES</code>, but not
5125: <code class="filename">patches/*</code>).</p></dd>
5126: <dt><span class="term">show-downlevel</span></dt>
5127: <dd><p>This target shows nothing if the package is not
5128: installed. If a version of this package is installed,
5129: but is not the version provided in this version of
5130: pkgsrc, then a warning message is displayed. This target
5131: can be used to show which of your installed packages are
5132: downlevel, and so the old versions can be deleted, and
5133: the current ones added.</p></dd>
5134: <dt><span class="term">show-pkgsrc-dir</span></dt>
5135: <dd><p>This target shows the directory in the pkgsrc
5136: hierarchy from which the package can be built and
5137: installed. This may not be the same directory as the one
5138: from which the package was installed. This target is
5139: intended to be used by people who may wish to upgrade
5140: many packages on a single host, and can be invoked from
5141: the top-level pkgsrc Makefile by using the
5142: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
5143: <dt><span class="term">show-installed-depends</span></dt>
5144: <dd><p>This target shows which installed packages match
5145: the current package's <code class="varname">DEPENDS</code>. Useful
5146: if out of date dependencies are causing build
5147: problems.</p></dd>
5148: <dt><span class="term">print-build-depends-list</span></dt>
5149: <dd><p>This target shows the list of packages that the current package
5150: depends on for building.</p></dd>
5151: <dt><span class="term">print-run-depends-list</span></dt>
5152: <dd><p>This target shows the list of packages that the current package
5153: depends on for running.</p></dd>
5154: <dt><span class="term">check-shlibs</span></dt>
5155: <dd><p>After a package is installed, check all its
5156: binaries and (on ELF platforms) shared libraries to see
5157: if they find the shared libs they need. Run by default
5158: 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>
5159: <dt><span class="term">print-PLIST</span></dt>
5160: <dd>
5161: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
5162: upgraded pkg, this prints out an attempt to generate a
5163: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
5164: -newer work/.extract_done</strong></span>. An attempt is made
5165: to care for shared libs etc., but it is
5166: <span class="emphasis"><em>strongly</em></span> recommended to review the
5167: result before putting it into
5168: <code class="filename">PLIST</code>. On upgrades, it's useful to
5169: diff the output of this command against an already
5170: existing <code class="filename">PLIST</code> file.</p>
1.246 leot 5171: <p>If the package installs files via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.184 rillig 5172: other methods that don't update file access times, be
5173: sure to add these files manually to your
5174: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
5175: -newer</span>”</span> command used by this target won't catch
5176: them!</p>
5177: <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
5178: information on this target.</p>
5179: </dd>
1.255 ! wiz 5180: <dt><span class="term">rebuild</span></dt>
! 5181: <dd><p>If you did a <span class="command"><strong>make build</strong></span> and you
! 5182: noticed some further modifications of sources are needed,
! 5183: you can repeat the build with this target, which will ignore
! 5184: the <span class="quote">“<span class="quote">already built</span>”</span> flag. This target is
! 5185: helpful while working with patches.</p></dd>
! 5186: <dt><span class="term">repackage</span></dt>
! 5187: <dd><p>If you did a <span class="command"><strong>make package</strong></span> and you
! 5188: noticed some further modifications of sources are needed,
! 5189: you can repeat the package with this target, which will ignore
! 5190: the <span class="quote">“<span class="quote">already packaged</span>”</span> flag. This target is
! 5191: helpful while working with patches, PLIST* files etc.</p></dd>
! 5192: <dt><span class="term">retest</span></dt>
! 5193: <dd><p>If you did a <span class="command"><strong>make test</strong></span> and you
! 5194: noticed some further modifications of sources are needed,
! 5195: you can repeat the test with this target, which will ignore
! 5196: the <span class="quote">“<span class="quote">already tested</span>”</span> flag. This target is
! 5197: helpful while working with patches.</p></dd>
1.184 rillig 5198: </dl></div>
5199: </div>
5200: </div>
5201: <div class="chapter">
5202: <div class="titlepage"><div><div><h2 class="title">
5203: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
5204: <div class="toc">
5205: <p><b>Table of Contents</b></p>
5206: <dl class="toc">
5207: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
5208: <dd><dl>
1.219 nia 5209: <dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
5210: <dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
5211: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
1.184 rillig 5212: </dl></dd>
5213: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
5214: <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>
5215: </dl>
5216: </div>
5217: <p>When you find a package that is not yet in pkgsrc, you
5218: most likely have a URL from where you can download the source
5219: code. Starting with this URL, creating a package involves only a
5220: few steps.</p>
5221: <div class="procedure"><ol class="procedure" type="1">
5222: <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
5223: enable the basic quality checks.</p></li>
5224: <li class="step">
1.207 leot 5225: <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 5226: install the utilities <span class="command"><strong>url2pkg</strong></span>,
5227: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
5228: <span class="command"><strong>mkpatches</strong></span>:</p>
5229: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
5230: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer && bmake update)</code></strong></pre>
5231: </li>
5232: <li class="step">
5233: <p>Choose one of the top-level directories as the category in
5234: which you want to place your package. You can also create a directory of
1.219 nia 5235: your own (maybe called <code class="filename">local</code>). Change into that
5236: category directory:</p>
5237: <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 5238: </li>
5239: <li class="step">
1.219 nia 5240: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
5241: argument the URL of the distribution file (in most cases a
5242: <code class="filename">.tar.gz</code> file). This will download the distribution
5243: file and create the necessary files of the package, based on what's in
5244: the distribution file:</p>
1.184 rillig 5245: <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>
5246: </li>
5247: <li class="step">
5248: <p>Examine the extracted files to determine the dependencies of
5249: your package. Ideally, this is mentioned in some
5250: <code class="filename">README</code> file, but things may differ. For each of
5251: these dependencies, look where it exists in pkgsrc, and if there is a
5252: file called <code class="filename">buildlink3.mk</code> in that directory, add a
5253: line to your package <code class="filename">Makefile</code> which includes that
5254: file just before the last line. If the
5255: <code class="filename">buildlink3.mk</code> file does not exist, it must be
5256: created first. The <code class="filename">buildlink3.mk</code> file makes sure
5257: that the package's include files and libraries are provided.</p>
1.219 nia 5258: <p>If you just need binaries from a dependent package, add a
1.184 rillig 5259: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
5260: version of the dependency and where it can be found in pkgsrc. This line
5261: should be placed in the third paragraph. If the dependency is only
5262: needed for building the package, but not when using it, use
5263: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
5264: instead of <code class="varname">DEPENDS</code>.
5265: The difference between <code class="varname">TOOL_DEPENDS</code> and
5266: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
5267: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
1.219 nia 5268: packages, i.e. packages for the platform where the package is built;
1.184 rillig 5269: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.219 nia 5270: packages, i.e. packages for the platform for which the package
5271: is built. There is also <code class="varname">TEST_DEPENDS</code>, which
5272: specifies a dependency used only for testing the resulting package
5273: built, using the upstream project's included test suite, on the native
5274: platform.
1.184 rillig 5275: Your package may then look like this:</p>
5276: <pre class="programlisting">
5277: [...]
5278:
5279: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
5280: DEPENDS+= screen-[0-9]*:../../misc/screen
5281: DEPENDS+= screen>=4.0:../../misc/screen
5282:
5283: [...]
5284:
5285: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
5286: .include "../../devel/glib2/buildlink3.mk"
5287: .include "../../mk/bsd.pkg.mk"
5288: </pre>
5289: </li>
5290: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
5291: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
5292: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
5293: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
5294: additional explanations.</p></li>
5295: <li class="step"><p>In many cases the package is not yet ready to build. You can
5296: 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
5297: over there, you can hopefully continue here.</p></li>
5298: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
5299: directory from the extracted files. Besides these files, a lot of cache
1.219 nia 5300: files and other system information have been saved in the working
5301: directory, which may have become outdated after you edited the
1.184 rillig 5302: <code class="filename">Makefile</code>.</p></li>
5303: <li class="step">
5304: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
5305: 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 5306: <p>If the extracted files from the package need to be fixed, run
5307: multiple rounds of these commands:</p>
5308: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
1.184 rillig 5309: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
5310: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
1.219 nia 5311: <code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
5312: <code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
1.184 rillig 5313: </li>
5314: <li class="step"><p>When the package builds fine, the next step is to install
5315: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
5316: everything works.</p></li>
5317: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
5318: contains a list of the files that are installed by the package, is
5319: nearly empty. Run <span class="command"><strong>bmake print-PLIST
5320: >PLIST</strong></span> to generate a probably correct list. Check
5321: the file using your preferred text editor to see if the list of
5322: files looks plausible.</p></li>
5323: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
5324: <code class="filename">PLIST</code> contains garbage or not.</p></li>
5325: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
5326: had been registered in the database of installed files, but with an
5327: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
5328: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
5329: registered with the list of files from
5330: <code class="filename">PLIST</code>.</p></li>
5331: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
5332: from above again in a single step, making sure that the PLIST is correct
5333: and the whole package is created as intended.</p></li>
1.219 nia 5334: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
5335: left to do.</p></li>
1.184 rillig 5336: <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>
5337: </ol></div>
5338: <div class="sect1">
5339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5340: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
5341: <div class="sect2">
5342: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5343: <a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
1.184 rillig 5344: <p>Python modules and programs packages are easily created using a
5345: set of predefined variables.</p>
5346: <p>
5347: If some Python versions are not supported by the software, set the
5348: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
5349: that are not supported, e.g.
5350: </p>
5351: <pre class="programlisting">
5352: PYTHON_VERSIONS_INCOMPATIBLE= 27
5353: </pre>
5354: <p>
1.249 gutterid 5355: If the packaged software is a Python module, include
1.255 ! wiz 5356: <code class="filename">../../lang/python/wheel.mk</code>. Note per PEP-518,
! 5357: the minimum and default requirements to create .whl files are
! 5358: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/py-setuptools/index.html" target="_top"><code class="filename">devel/py-setuptools</code></a> plus <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/py-wheel/index.html" target="_top"><code class="filename">devel/py-wheel</code></a>; however, there are various other
! 5359: possible tools that projects can use. Thus inclusion of
! 5360: <code class="filename">wheel.mk</code> does not imply these defaults are
! 5361: defined as <code class="varname">TOOL_DEPENDS</code>. Whatever the project
! 5362: specifically requires as packaging tools must be defined in the
! 5363: package Makefile.
1.215 wiz 5364: </p>
1.248 wiz 5365: <p>The package directory should be called
1.184 rillig 5366: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
5367: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
5368: </p>
5369: <pre class="programlisting">
5370: DISTNAME= foopymodule-1.2.10
5371: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
5372: </pre>
1.226 gutterid 5373: <p>
5374: For software in PyPi, the name should match what PyPi specifies for
5375: "pip install software".
5376: </p>
1.184 rillig 5377: <p>If it is an application, include
5378: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>.
5379: In order to correctly set the path to the Python interpreter, use the
5380: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
5381: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
5382: For example:
5383: </p>
5384: <pre class="programlisting">
5385: REPLACE_PYTHON= *.py
5386: </pre>
5387: </div>
5388: <div class="sect2">
5389: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5390: <a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
1.184 rillig 5391: <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>
5392: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
1.207 leot 5393: 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 5394: Individual packages (and optionally their dependencies) may be created
5395: and updated. R packages generally follow the same form, and most of
5396: the relevant information needed is contained in a
5397: <code class="filename">DESCRIPTION</code> file as part of each R package on
5398: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
5399: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
5400: creates or updates a package in the canonical form. The resulting
5401: package should be reviewed for correctness.</p>
5402: </div>
5403: <div class="sect2">
5404: <div class="titlepage"><div><div><h3 class="title">
1.219 nia 5405: <a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
1.184 rillig 5406: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
1.207 leot 5407: <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 5408: <p>If the TeXlive package name is not known, it may be useful to
5409: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>. A
5410: <span class="quote">“<span class="quote">Contained in</span>”</span> field on the package page typically
5411: 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
5412: archive</a>.</p>
5413: <p>If the TeXlive package name is known, download the files from
5414: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
5415: archive</a>. For package <code class="filename">foo</code>, you will need
5416: to download <code class="filename">foo.tar.xz</code>. Most TeXlive packages
5417: also have associated documentation packages, so download
5418: <code class="filename">foo.doc.tar.xz</code> at the same time. These files
5419: should be placed in the appropriate category directory, which is often
5420: but not always <code class="filename">print</code>. Then run the following
5421: command in the category directory.</p>
5422: <pre class="programlisting">
5423: texlive2pkg foo.tar.xz foo.doc.tar.xz
5424: </pre>
5425: <p>This will create two packages, <code class="filename">tex-foo</code> and
5426: <code class="filename">tex-foo-doc</code>. Be sure to check that both packages
5427: are correct.</p>
5428: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
5429: currently does not include version information in package filenames
5430: and changes their contents periodically when updates occur.
5431: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
5432: pkgsrc archives. For each new or updated TeXlive package, e.g., the
5433: main one and the corresponding documentation, upload the distfiles
5434: with the following command in each package directory.</p>
5435: <pre class="programlisting">
5436: make upload-distfiles
5437: </pre>
5438: </div>
5439: </div>
5440: <div class="sect1">
5441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5442: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
5443: <div class="sect2">
5444: <div class="titlepage"><div><div><h3 class="title">
5445: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
5446: <div class="sect3">
5447: <div class="titlepage"><div><div><h4 class="title">
5448: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
5449: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
5450: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
5451: pkgsrc. As the description says it has to do with the web, the obvious
5452: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
5453: <pre class="programlisting">
5454: <code class="prompt">$</code> mkdir www/nvu
5455: <code class="prompt">$</code> cd www/nvu
5456: </pre>
5457: <p>The web site says that the sources are available as a tar file, so
5458: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
5459: <pre class="programlisting">
5460: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5461: </pre>
5462: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
5463: below the <code class="varname">DISTNAME</code> line, as the package name should
5464: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
5465: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
5466: <code class="varname">COMMENT</code> fields. Then the package
5467: <code class="filename">Makefile</code> looked like that:</p>
5468: <pre class="programlisting">
5469: # $NetBSD $
5470: #
5471:
5472: DISTNAME= nvu-1.0-sources
5473: PKGNAME= nvu-1.0
5474: CATEGORIES= www
5475: MASTER_SITES= http://cvs.nvu.com/download/
5476: EXTRACT_SUFX= .tar.bz2
5477:
5478: MAINTAINER= rillig@NetBSD.org
5479: HOMEPAGE= http://cvs.nvu.com/
5480: COMMENT= Web Authoring System
5481:
5482: # url2pkg-marker (please do not remove this line.)
5483: .include "../../mk/bsd.pkg.mk"
5484: </pre>
5485: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
5486: this is a workaround to prevent CVS expanding to the filename of the
5487: guide.</p>
5488: <p>Then, I quit the editor and watched pkgsrc downloading a large
5489: source archive:</p>
5490: <pre class="programlisting">
5491: url2pkg> Running "make makesum" ...
5492: => Required installed package digest>=20010302: digest-20060826 found
5493: => Fetching nvu-1.0-sources.tar.bz2
5494: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
5495: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
5496: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
5497: url2pkg> Running "make extract" ...
5498: => Required installed package digest>=20010302: digest-20060826 found
5499: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5500: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5501: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
5502: ===> Installing dependencies for nvu-1.0
5503: ===> Overriding tools for nvu-1.0
5504: ===> Extracting for nvu-1.0
5505: url2pkg> Adjusting the Makefile.
5506:
5507: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
5508:
5509: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
5510: </pre>
5511: </div>
5512: <div class="sect3">
5513: <div class="titlepage"><div><div><h4 class="title">
5514: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
5515: <p>Now that the package has been extracted, let's see what's inside
5516: it. The package has a <code class="filename">README.txt</code>, but that only
5517: says something about mozilla, so it's probably useless for seeing what
5518: dependencies this package has. But since there is a GNU configure script
5519: in the package, let's hope that it will complain about everything it
5520: needs.</p>
5521: <pre class="programlisting">
5522: <code class="prompt">$</code> bmake
5523: => Required installed package digest>=20010302: digest-20060826 found
5524: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
5525: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
5526: ===> Patching for nvu-1.0
5527: ===> Creating toolchain wrappers for nvu-1.0
5528: ===> Configuring for nvu-1.0
5529: [...]
5530: configure: error: Perl 5.004 or higher is required.
5531: [...]
5532: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
5533: [...]
5534: </pre>
5535: <p>That worked quite well. So I opened the package Makefile in my
5536: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
5537: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
5538: package have changed now, and since a perl wrapper is automatically
5539: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
5540: from scratch.</p>
5541: <pre class="programlisting">
5542: <code class="prompt">$</code> bmake clean
5543: ===> Cleaning for nvu-1.0
5544: <code class="prompt">$</code> bmake
5545: [...]
5546: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
5547: GNU Make. You will not be able to build Mozilla without GNU Make.
5548: [...]
5549: </pre>
5550: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
5551: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
5552: <pre class="programlisting">
5553: [...]
5554: checking for GTK - version >= 1.2.0... no
5555: *** Could not run GTK test program, checking why...
5556: [...]
5557: </pre>
5558: <p>Now to the other dependencies. The first question is: Where is the
5559: GTK package hidden in pkgsrc?</p>
5560: <pre class="programlisting">
5561: <code class="prompt">$</code> echo ../../*/gtk*
5562: [many packages ...]
5563: <code class="prompt">$</code> echo ../../*/gtk
5564: ../../x11/gtk
5565: <code class="prompt">$</code> echo ../../*/gtk2
5566: ../../x11/gtk2
5567: <code class="prompt">$</code> echo ../../*/gtk2/bui*
5568: ../../x11/gtk2/buildlink3.mk
5569: </pre>
5570: <p>The first try was definitely too broad. The second one had exactly
5571: one result, which is very good. But there is one pitfall with GNOME
5572: packages. Before GNOME 2 had been released, there were already many
5573: GNOME 1 packages in pkgsrc. To be able to continue to use these
5574: packages, the GNOME 2 packages were imported as separate packages, and
5575: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
5576: whether this was the case here, and indeed it was.</p>
5577: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
5578: file, adding the dependency is very easy. I just inserted an
5579: <code class="literal">.include</code> line before the last line of the package
5580: <code class="filename">Makefile</code>, so that it now looks like this:</p>
5581: <pre class="programlisting">
5582: [...]
5583: .include "../../x11/gtk2/buildlink3.mk"
5584: .include "../../mk/bsd.pkg.mk
5585: </pre>
5586: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
5587: was:</p>
1.1 dsieger 5588: <pre class="programlisting">
1.184 rillig 5589: [...]
5590: checking for gtk-config... /home/roland/pkg/bin/gtk-config
5591: checking for GTK - version >= 1.2.0... no
5592: *** Could not run GTK test program, checking why...
5593: *** The test program failed to compile or link. See the file config.log for the
5594: *** exact error that occured. This usually means GTK was incorrectly installed
5595: *** or that you have moved GTK since it was installed. In the latter case, you
5596: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
5597: configure: error: Test for GTK failed.
5598: [...]
1.111 sevan 5599: </pre>
1.184 rillig 5600: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
5601: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
5602: told me that this package really wanted to have the GNOME 1 version of
5603: GTK. If the package had looked for GTK2, it would have looked for
5604: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
5605: So I changed the <code class="literal">x11/gtk2</code> to
5606: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
5607: and tried again.</p>
1.18 snj 5608: <pre class="programlisting">
1.184 rillig 5609: [...]
5610: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
5611: In file included from xpidl.c:42:
5612: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
5613: In file included from xpidl.c:42:
5614: xpidl.h:132: error: parse error before "IDL_ns"
5615: [...]
1.111 sevan 5616: </pre>
1.184 rillig 5617: <p>The package still does not find all of its dependencies. Now the
5618: question is: Which package provides the
5619: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18 snj 5620: <pre class="programlisting">
1.184 rillig 5621: <code class="prompt">$</code> echo ../../*/*idl*
5622: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
5623: <code class="prompt">$</code> echo ../../*/*IDL*
5624: ../../net/libIDL
1.111 sevan 5625: </pre>
1.184 rillig 5626: <p>Let's take the one from the second try. So I included the
5627: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
5628: again. But the error didn't change. After digging through some of the
5629: code, I concluded that the build process of the package was broken and
5630: couldn't have ever worked, but since the Mozilla source tree is quite
5631: large, I didn't want to fix it. So I added the following to the package
5632: <code class="filename">Makefile</code> and tried again:</p>
1.86 wiz 5633: <pre class="programlisting">
1.184 rillig 5634: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
5635: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.111 sevan 5636: </pre>
1.184 rillig 5637: <p>The latter line is needed because the package expects the library
5638: <code class="filename">libIDL.so</code>, but only
5639: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
5640: wrapper to rewrite that on the fly.</p>
5641: <p>The next problem was related to a recent change of the FreeType
1.207 leot 5642: 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 5643: which patch files were relevant for this issue and copied them to the
5644: <code class="filename">patches</code> directory. Then I retried, fixed the
5645: patches so that they applied cleanly and retried again. This time,
5646: everything worked.</p>
1.86 wiz 5647: </div>
1.184 rillig 5648: <div class="sect3">
5649: <div class="titlepage"><div><div><h4 class="title">
5650: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 5651: <pre class="programlisting">
1.184 rillig 5652: <code class="prompt">$</code> bmake CHECK_FILES=no install
5653: [...]
5654: <code class="prompt">$</code> bmake print-PLIST >PLIST
5655: <code class="prompt">$</code> bmake deinstall
5656: <code class="prompt">$</code> bmake install
1.111 sevan 5657: </pre>
1.184 rillig 5658: </div>
5659: </div>
1.1 dsieger 5660: </div>
5661: </div>
1.41 asau 5662: <div class="chapter">
1.1 dsieger 5663: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 5664: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 5665: <div class="toc">
5666: <p><b>Table of Contents</b></p>
1.100 leot 5667: <dl class="toc">
1.184 rillig 5668: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
5669: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
5670: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
5671: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
5672: <dd><dl>
5673: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
5674: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
5675: <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>
5676: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.229 gutterid 5677: <dt><span class="sect2"><a href="#makefile.yesno">15.3.5. Testing yes/no variables in conditions</a></span></dt>
1.1 dsieger 5678: </dl></dd>
5679: </dl>
5680: </div>
1.184 rillig 5681: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
5682: each of which forms a well-defined part of the pkgsrc system. Using
1.246 leot 5683: the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 5684: like pkgsrc requires some discipline to keep the code correct and
5685: understandable.</p>
5686: <p>The basic ingredients for <code class="filename">Makefile</code>
5687: programming are variables and shell
5688: commands. Among these shell commands may even be more complex ones
1.246 leot 5689: like <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 5690: as intended it is necessary to quote all variables correctly when they
5691: are used.</p>
5692: <p>This chapter describes some patterns that appear quite often in
5693: <code class="filename">Makefile</code>s, including the pitfalls that come along
5694: with them.</p>
1.41 asau 5695: <div class="sect1">
1.1 dsieger 5696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5697: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
5698: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
5699: <p>When you are creating a file as a
5700: target of a rule, always write the data to a temporary file first
5701: and finally rename that file. Otherwise there might occur an error
5702: in the middle of generating the file, and when the user runs
1.246 leot 5703: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 5704: regenerated properly. Example:</p>
1.1 dsieger 5705: <pre class="programlisting">
1.184 rillig 5706: wrong:
5707: @echo "line 1" > ${.TARGET}
5708: @echo "line 2" >> ${.TARGET}
5709: @false
5710:
5711: correct:
5712: @echo "line 1" > ${.TARGET}.tmp
5713: @echo "line 2" >> ${.TARGET}.tmp
5714: @false
5715: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 5716: </pre>
1.184 rillig 5717: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
5718: <code class="filename">wrong</code> will exist, although there was an error
5719: message in the first run. On the other hand, running <span class="command"><strong>make
5720: correct</strong></span> gives an error message twice, as expected.</p>
1.246 leot 5721: <p>You might remember that <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.184 rillig 5722: <code class="literal">${.TARGET}</code> in case of error, but this only
5723: happens when it is interrupted, for example by pressing
5724: <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.246 leot 5725: when one of the commands fails (like <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.184 rillig 5726: </li></ul></div>
5727: </div>
5728: <div class="sect1">
5729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5730: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
5731: <p><code class="filename">Makefile</code> variables contain strings that
5732: can be processed using the five operators <code class="code">=</code>,
5733: <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.246 leot 5734: <code class="code">!=</code>, which are described in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.184 rillig 5735: page.</p>
5736: <p>When a variable's value is parsed from a
5737: <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
5738: the backslash character <code class="code">\</code> are handled specially. If a
5739: backslash is the last character in a line, that backslash is removed
5740: from the line and the line continues with the next line of the file.</p>
5741: <p>The <code class="code">#</code> character starts a comment that reaches
5742: until the end of the line. To get an actual <code class="code">#</code> character,
5743: such as in a URL, write <code class="code">\#</code> instead.</p>
5744: <p>The evaluation of variables either happens immediately or lazy.
5745: It happens immediately when the variable occurs on the right-hand
5746: side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
5747: <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
5748: In the other cases, it is evaluated lazily.</p>
5749: <p>Some of the modifiers split the string into words and then
5750: operate on the words, others operate on the string as a whole. When a
5751: string is split into words, double quotes and single quotes are
1.246 leot 5752: interpreted as delimiters, just like in <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.184 rillig 5753: <div class="sect2">
5754: <div class="titlepage"><div><div><h3 class="title">
5755: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
5756: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5757: <li class="listitem"><p>All variable names starting with an underscore
5758: are reserved for use by the pkgsrc infrastructure. They shall
5759: not be used by packages.</p></li>
5760: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
5761: lowercase variable names for the iteration
5762: variables.</p></li>
5763: <li class="listitem"><p>All list variables should have a plural name,
5764: such as <code class="varname">PKG_OPTIONS</code> or
5765: <code class="varname">DISTFILES</code>.</p></li>
5766: </ul></div>
5767: </div>
5768: </div>
5769: <div class="sect1">
5770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5771: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
5772: <div class="sect2">
5773: <div class="titlepage"><div><div><h3 class="title">
5774: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
5775: <p>When adding a string that possibly contains whitespace or quotes to
5776: a list (example 1), it must be quoted using the <code class="code">:Q</code>
5777: modifier.</p>
5778: <p>When adding another list to a list (example 2), it must not be
5779: quoted, since its elements are already quoted.</p>
1.1 dsieger 5780: <pre class="programlisting">
1.184 rillig 5781: STRING= foo * bar `date`
5782: LIST= # empty
5783: ANOTHER_LIST= a=b c=d
5784:
5785: LIST+= ${STRING:Q} # 1
5786: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 5787: </pre>
1.184 rillig 5788: </div>
5789: <div class="sect2">
5790: <div class="titlepage"><div><div><h3 class="title">
5791: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
5792: <p>Echoing a string containing special characters needs special
5793: work.</p>
1.1 dsieger 5794: <pre class="programlisting">
1.184 rillig 5795: STRING= foo bar < > * `date` $$HOME ' "
5796: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
5797:
5798: all:
5799: echo ${STRING} # 1
5800: echo ${STRING:Q} # 2
5801: printf '%s\n' ${STRING:Q}'' # 3
5802: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 5803: </pre>
1.184 rillig 5804: <p>Example 1 leads to a syntax error in the shell, as the characters
5805: are just copied.</p>
5806: <p>Example 2 quotes the string so that the shell interprets it
5807: correctly. But the echo command may additionally interpret strings with a
5808: leading dash or those containing backslashes.</p>
1.246 leot 5809: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.184 rillig 5810: interprets the format string, but not the next argument. The trailing
5811: single quotes handle the case when the string is empty. In that case, the
5812: :Q modifier would result in an empty string too, which would then be
1.246 leot 5813: skipped by the shell. For <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.184 rillig 5814: but other programs may care.</p>
5815: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
5816: need to be quoted because the quoting has already been done
5817: when adding elements to the list.</p>
1.1 dsieger 5818: </div>
1.41 asau 5819: <div class="sect2">
1.1 dsieger 5820: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 5821: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
5822: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
5823: GNU-style configure script (especially those that call other configure
5824: scripts), it must not have leading or trailing whitespace, since
5825: otherwise the configure script gets confused. To trim leading and
5826: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
5827: following example:</p>
1.1 dsieger 5828: <pre class="programlisting">
1.184 rillig 5829: CPPFLAGS= # empty
5830: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
5831: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 5832:
1.184 rillig 5833: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 5834:
1.184 rillig 5835: all:
5836: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5837: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
5838: </pre>
5839: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
5840: trailing whitespace because the <code class="code">+=</code> operator always adds a
5841: space.</p>
5842: </div>
5843: <div class="sect2">
5844: <div class="titlepage"><div><div><h3 class="title">
5845: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
5846: <p>When a possibly empty variable is used in a shell program, it may
5847: lead to a syntax error.</p>
5848: <pre class="programlisting">
5849: EGFILES= # empty
1.1 dsieger 5850:
1.184 rillig 5851: install-examples: # produces a syntax error in the shell
5852: for egfile in ${EGFILES}; do \
5853: echo "Installing $$egfile"; \
5854: done
5855: </pre>
5856: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.246 leot 5857: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.184 rillig 5858: To fix this syntax error, use one of the snippets below.</p>
5859: <pre class="programlisting">
1.229 gutterid 5860: EGFILES= # empty
1.1 dsieger 5861:
1.184 rillig 5862: install-examples:
5863: for egfile in ${EGFILES} ""; do \
5864: [ -n "$$egfile" ] || continue; \
5865: echo "Installing $$egfile"; \
5866: done
5867: </pre>
5868: <p>In this case, an empty string is appended to the iteration list (to
5869: prevent the syntax error) and filtered out later.</p>
5870: <pre class="programlisting">
5871: EGFILES= # empty
1.1 dsieger 5872:
1.184 rillig 5873: install-examples:
5874: .for egfile in ${EGFILES}
5875: echo "Installing ${egfile}"
5876: .endfor
1.1 dsieger 5877: </pre>
1.184 rillig 5878: <p>If one of the filenames contains special characters, it should be
5879: enclosed in single or double quotes.</p>
5880: <p>To have a shell command test whether a make variable is empty, use
5881: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
5882: </div>
1.229 gutterid 5883: <div class="sect2">
5884: <div class="titlepage"><div><div><h3 class="title">
5885: <a name="makefile.yesno"></a>15.3.5. Testing yes/no variables in conditions</h3></div></div></div>
5886: <p>When a variable can have the values <code class="literal">yes</code> or
5887: <code class="literal">no</code>, use the following pattern to test the variable:</p>
5888: <pre class="programlisting">
5889: .if ${VAR:U:tl} == "yes"
5890: # do something
5891: .endif
5892: </pre>
5893: <p>The <code class="literal">:U</code> modifier is only necessary if the variable
5894: can be undefined. If the variable is guaranteed to be defined, the
5895: <code class="literal">:U</code> can be omitted.</p>
5896: <p>The <code class="literal">:tl</code> modifier converts the variable value to
5897: lowercase, allowing for the values <code class="literal">yes</code>,
5898: <code class="literal">Yes</code>, <code class="literal">YES</code>.</p>
5899: </div>
1.184 rillig 5900: </div>
5901: </div>
5902: <div class="chapter">
5903: <div class="titlepage"><div><div><h2 class="title">
5904: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
5905: <div class="toc">
5906: <p><b>Table of Contents</b></p>
5907: <dl class="toc">
5908: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
5909: <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>
5910: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
5911: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
5912: </dl>
1.1 dsieger 5913: </div>
1.184 rillig 5914: <p>Many packages have the ability to be built to support different
5915: sets of features. <code class="filename">bsd.options.mk</code> is a framework
5916: in pkgsrc that provides generic handling of those options that
5917: determine different ways in which the packages can be built. It's
5918: possible for the user to specify exactly which sets of options will be
5919: built into a package or to allow a set of global default options
5920: apply.</p>
5921: <p>There are two broad classes of behaviors that one might want to
5922: control via options. One is whether some particular feature is
5923: enabled in a program that will be built anyway, often by including or
5924: not including a dependency on some other package. The other is
5925: whether or not an additional program will be built as part of the
5926: package. Generally, it is better to make a split package for such
5927: additional programs instead of using options, because it enables
5928: binary packages to be built which can then be added separately. For
5929: example, the foo package might have minimal dependencies (those
5930: packages without which foo doesn't make sense), and then the foo-gfoo
5931: package might include the GTK frontend program gfoo. This is better
5932: than including a gtk option to foo that adds gfoo, because either that
5933: option is default, in which case binary users can't get foo without
5934: gfoo, or not default, in which case they can't get gfoo. With split
5935: packages, they can install foo without having GTK, and later decide to
5936: install gfoo (pulling in GTK at that time). This is an advantage to
5937: source users too, avoiding the need for rebuilds.</p>
5938: <p>Plugins with widely varying dependencies should usually be split
5939: instead of options.</p>
5940: <p>It is often more work to maintain split packages, especially if
5941: the upstream package does not support this. The decision of split
5942: vs. option should be made based on the likelihood that users will want
5943: or object to the various pieces, the size of the dependencies that are
5944: included, and the amount of work.</p>
5945: <p>A further consideration is licensing. Non-free parts, or parts
5946: that depend on non-free dependencies (especially plugins) should
5947: almost always be split if feasible.</p>
5948: <div class="sect1">
5949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5950: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
5951: <p>Global default options are listed in
5952: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
5953: that should be built into every package if that option is supported.
5954: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 5955: </div>
1.41 asau 5956: <div class="sect1">
1.1 dsieger 5957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 5958: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
5959: </h2></div></div></div>
5960: <p>The following example shows how
5961: <code class="filename">bsd.options.mk</code> should be used
5962: by the hypothetical ``wibble'' package, either in the package
5963: <code class="filename">Makefile</code>, or in a file,
5964: e.g. <code class="filename">options.mk</code>, that is included by the
5965: main package <code class="filename">Makefile</code>.</p>
1.1 dsieger 5966: <pre class="programlisting">
1.184 rillig 5967: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5968: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5969: PKG_OPTIONS_OPTIONAL_GROUPS= database
5970: PKG_OPTIONS_GROUP.database= mysql pgsql
5971: PKG_SUGGESTED_OPTIONS= wibble-foo
5972: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5973: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5974:
5975: .include "../../mk/bsd.prefs.mk"
5976:
5977: # this package was previously named wibble2
5978: .if defined(PKG_OPTIONS.wibble2)
5979: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5980: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5981: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5982: .endif
5983:
5984: .include "../../mk/bsd.options.mk"
5985:
5986: # Package-specific option-handling
1.1 dsieger 5987:
1.184 rillig 5988: ###
5989: ### FOO support
5990: ###
5991: .if !empty(PKG_OPTIONS:Mwibble-foo)
5992: CONFIGURE_ARGS+= --enable-foo
5993: .endif
1.1 dsieger 5994:
1.184 rillig 5995: ###
5996: ### LDAP support
5997: ###
5998: .if !empty(PKG_OPTIONS:Mldap)
5999: . include "../../databases/openldap-client/buildlink3.mk"
6000: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6001: .endif
1.1 dsieger 6002:
1.184 rillig 6003: ###
6004: ### database support
6005: ###
6006: .if !empty(PKG_OPTIONS:Mmysql)
6007: . include "../../mk/mysql.buildlink3.mk"
6008: .endif
6009: .if !empty(PKG_OPTIONS:Mpgsql)
6010: . include "../../mk/pgsql.buildlink3.mk"
6011: .endif
6012: </pre>
6013: <p>The first section contains the information about which build
6014: options are supported by the package, and any default options settings
6015: if needed.</p>
6016: <div class="orderedlist"><ol class="orderedlist" type="1">
6017: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.246 leot 6018: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 6019: options. It should be set to
6020: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6021: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6022: at the point where the options are processed.</p></li>
6023: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6024: build options supported by the package.</p></li>
6025: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6026: list of names of groups of mutually exclusive options. The options in
6027: each group are listed in
6028: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6029: The most specific setting of any option from the group takes
6030: precedence over all other options in the group. Options from the
6031: groups will be automatically added to
6032: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6033: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6034: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6035: packages will fail if no option from the group is
6036: selected.</p></li>
6037: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6038: of names of sets of options. At least one option from each set must
6039: be selected. The options in each set are listed in
6040: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6041: Options from the sets will be automatically added to
6042: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6043: fail if no option from the set is selected.</p></li>
6044: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6045: build options which are enabled by default.</p></li>
6046: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6047: of
6048: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
6049: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
6050: their option counterparts. Pairs should be added with
6051: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
6052: warning will be issued if the user uses a legacy
6053: variable.</p></li>
6054: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6055: of
6056: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
6057: pairs that map options that have been renamed to their new
6058: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
6059: the listing of global legacy options. A warning will be issued if
6060: the user uses a legacy option.</p></li>
6061: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6062: options implied by deprecated variables used. This can be used for
6063: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6064: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6065: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6066: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6067: a list of warnings about deprecated variables or options used, and
6068: what to use instead.</p></li>
6069: </ol></div>
6070: <p>A package should never modify
6071: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6072: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6073: To suggest a default set of options, use
6074: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6075: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6076: including <code class="filename">bsd.options.mk</code>. If none of
6077: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6078: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6079: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6080: happen with platform-specific options if none of them is supported on
6081: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6082: empty list and the package is otherwise treated as not using the
6083: options framework.</p>
6084: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6085: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6086: build options, properly filtered to remove unsupported and duplicate
6087: options.</p>
6088: <p>The remaining sections contain the logic that is specific to
6089: each option. The correct way to check for an option is to check
6090: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6091: <pre class="programlisting">
6092: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1 dsieger 6093: </pre>
6094: </div>
1.184 rillig 6095: <div class="sect1">
6096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6097: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
6098: <p>Options that enable similar features in different packages (like
6099: optional support for a library) should use a common name in all
6100: packages that support it (like the name of the library). If another
6101: package already has an option with the same meaning, use the same
6102: name.</p>
6103: <p>Options that enable features specific to one package, where it's
6104: unlikely that another (unrelated) package has the same (or a similar)
6105: optional feature, should use a name prefixed with
6106: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6107: <p>If a group of related packages share an optional feature
6108: specific to that group, prefix it with the name of the
6109: <span class="quote">“<span class="quote">main</span>”</span> package
6110: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6111: <p>For new options, add a line to
6112: <code class="filename">mk/defaults/options.description</code>. Lines have two
6113: fields, separated by tab. The first field is the option name, the
6114: second its description. The description should be a whole sentence
6115: (starting with an uppercase letter and ending with a period) that
6116: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6117: support.</span>”</span> The file is sorted by option names.</p>
6118: </div>
6119: <div class="sect1">
6120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6121: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6122: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6123: different dependencies based on the options with which the package was
6124: built. For querying these options, the file
6125: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6126: typical example looks like this:</p>
1.1 dsieger 6127: <pre class="programlisting">
1.184 rillig 6128: pkgbase := libpurple
6129: .include "../../mk/pkg-build-options.mk"
6130:
6131: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6132: ...
6133: .endif
1.117 sevan 6134: </pre>
1.184 rillig 6135: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6136: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6137: options of the libpurple package, which can then be queried like
6138: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6139: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6140: details.</p>
1.1 dsieger 6141: </div>
6142: </div>
1.41 asau 6143: <div class="chapter">
1.1 dsieger 6144: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6145: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 6146: <div class="toc">
6147: <p><b>Table of Contents</b></p>
1.100 leot 6148: <dl class="toc">
1.184 rillig 6149: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
6150: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
6151: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1 dsieger 6152: </dl>
6153: </div>
1.184 rillig 6154: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
6155: by pkgsrc and also for individual packages to define what commands
6156: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
6157: or for later run-time of an installed packaged (such as
6158: <code class="varname">DEPENDS</code>).
6159: If the native system provides an adequate tool, then in many cases, a pkgsrc
6160: package will not be used.</p>
6161: <p>When building a package, the replacement tools are
6162: made available in a directory (as symlinks or wrapper scripts)
6163: that is early in the executable search path. Just like the buildlink
6164: system, this helps with consistent builds.</p>
6165: <p>A tool may be needed to help build a specific package. For example,
6166: perl, GNU make (gmake) or yacc may be needed.</p>
6167: <p>Also a tool may be needed, for example, because the native system's supplied
6168: tool may be inefficient for building a package with pkgsrc.
6169: For example, a package may need GNU awk, bison (instead of
6170: yacc) or a better sed.</p>
6171: <p>The tools used by a package can be listed by running
6172: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 6173: <div class="sect1">
1.1 dsieger 6174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6175: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
6176: <p>The default set of tools used by pkgsrc is defined in
6177: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
6178: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
6179: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
6180: These can be seen by running:
6181: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
6182: <p>If a package needs a specific program to build
6183: then the <code class="varname">USE_TOOLS</code> variable can be used
6184: to define the tools needed.</p>
1.1 dsieger 6185: </div>
1.184 rillig 6186: <div class="sect1">
6187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6188: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
6189: <p>In the following examples, the :run means that it is needed at
6190: run-time (and becomes a DEPENDS).
6191: The default is a build dependency which can be set with
6192: :build. (So in this example, it is the same as gmake:build
6193: and pkg-config:build.)</p>
1.1 dsieger 6194: <pre class="programlisting">
1.184 rillig 6195: USE_TOOLS+= gmake perl:run pkg-config
1.1 dsieger 6196: </pre>
1.184 rillig 6197: <p>When using the tools framework, a
6198: <code class="varname">TOOLS_PATH.foo</code> variable is defined
6199: which contains the full path to the appropriate tool. For example,
6200: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
6201: on Linux systems.</p>
6202: <p>If you always need a pkgsrc version of the
6203: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
6204: </p>
1.1 dsieger 6205: </div>
1.184 rillig 6206: <div class="sect1">
6207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6208: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
6209: <p>When improving or porting pkgsrc to a new platform, have a look
6210: at (or create) the corresponding platform specific make file fragment under
6211: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
6212: the name of the common tools. For example:</p>
1.1 dsieger 6213: <pre class="programlisting">
1.184 rillig 6214: .if exists(/usr/bin/bzcat)
6215: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6216: .elif exists(/usr/bin/bzip2)
6217: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6218: .endif
6219:
6220: TOOLS_PLATFORM.true?= true # shell builtin
1.1 dsieger 6221: </pre>
6222: </div>
6223: </div>
1.184 rillig 6224: <div class="chapter">
6225: <div class="titlepage"><div><div><h2 class="title">
6226: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
6227: <div class="toc">
6228: <p><b>Table of Contents</b></p>
6229: <dl class="toc">
6230: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
6231: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
6232: <dd><dl>
6233: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
6234: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
6235: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6236: and
6237: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6238: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
6239: </dl></dd>
6240: <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 6241: <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 6242: </dl>
1.1 dsieger 6243: </div>
1.184 rillig 6244: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
6245: are seen by a package's configure and build processes. This is implemented
6246: in a two step process:</p>
6247: <div class="orderedlist"><ol class="orderedlist" type="1">
6248: <li class="listitem"><p>Symlink headers and libraries for dependencies into
6249: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
6250: of <code class="varname">WRKDIR</code>.</p></li>
6251: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
6252: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
6253: <code class="option">-L${LOCALBASE}/lib</code> into references to
6254: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
6255: native compiler on some operating systems look like GCC, so that
6256: packages that expect GCC won't require modifications to build with
6257: those native compilers.</p></li>
6258: </ol></div>
6259: <p>This normalizes the environment in which a package is built so that the
6260: package may be built consistently despite what other software may be
6261: installed. Please note that the normal system header and library paths,
6262: e.g. <code class="filename">/usr/include</code>,
6263: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
6264: designed to insulate the package build from non-system-supplied
6265: software.</p>
1.41 asau 6266: <div class="sect1">
1.1 dsieger 6267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6268: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
6269: <p>The process of converting packages to use the buildlink3
6270: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
6271: The things to keep in mind are:</p>
1.23 wiz 6272: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184 rillig 6273: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
6274: instead of the actual toolchain. Some packages are tricky,
6275: and the only way to know for sure is the check
6276: <code class="filename">${WRKDIR}/.work.log</code> to see if the
6277: wrappers are being invoked.</p></li>
6278: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
6279: the package Makefile, e.g. Java VMs, standalone shells,
6280: etc., because the code to symlink files into
6281: <code class="filename">${BUILDLINK_DIR}</code> looks for files
6282: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
6283: </p></li>
6284: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
6285: <code class="filename">buildlink3.mk</code> files that you list in a
6286: package's Makefile are added as dependencies for that package.
6287: </p></li>
6288: </ol></div>
6289: <p>If a dependency on a particular package is required for its libraries and
6290: headers, then we replace:</p>
6291: <pre class="programlisting">
6292: DEPENDS+= foo>=1.1.0:../../category/foo
6293: </pre>
6294: <p>with</p>
6295: <pre class="programlisting">
6296: .include "../../category/foo/buildlink3.mk"
6297: </pre>
6298: <p>The buildlink3.mk files usually define the required dependencies.
6299: If you need a newer version of the dependency when using buildlink3.mk
6300: files, then you can define it in your Makefile; for example:</p>
1.1 dsieger 6301: <pre class="programlisting">
1.184 rillig 6302: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
6303: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 6304: </pre>
1.184 rillig 6305: <p>There are several <code class="filename">buildlink3.mk</code>
6306: files in <code class="filename">pkgsrc/mk</code>
6307: that handle special package issues:</p>
6308: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6309: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
6310: the native or a pkgsrc Berkeley DB implementation based on
6311: the values of <code class="varname">BDB_ACCEPTED</code> and
6312: <code class="varname">BDB_DEFAULT</code>.</p></li>
6313: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
6314: comes with neither Curses nor NCurses, this will take care
1.207 leot 6315: 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 6316: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
6317: of <code class="varname">KRB5_ACCEPTED</code> to choose between
6318: adding a dependency on Heimdal or MIT-krb5 for packages that
6319: require a Kerberos 5 implementation.</p></li>
6320: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
6321: system-provided Motif installation or adds a dependency on
1.207 leot 6322: <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 6323: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
6324: <span class="quote">“<span class="quote">lesstif</span>”</span> or <span class="quote">“<span class="quote">motif</span>”</span>
6325: to choose which Motif version will be used.</p></li>
6326: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
6327: system-provided GNU readline or editline (libedit) installation,
1.207 leot 6328: 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>,
6329: <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 6330: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
6331: If your package really needs GNU readline library, its Makefile
6332: should include <code class="filename">devel/readline/buildlink3.mk</code>
6333: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
6334: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
6335: variables that may be used by packages that use the
6336: Open Sound System (OSS) API.</p></li>
6337: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
6338: any of the Postgres versions in the variable
6339: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
6340: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
6341: the file for more information.</p></li>
6342: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
6343: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.207 leot 6344: 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 6345: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
6346: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
6347: library.</p></li>
6348: </ul></div>
6349: <p>The comments in those <code class="filename">buildlink3.mk</code>
6350: files provide a more complete
6351: description of how to use them properly.</p>
1.1 dsieger 6352: </div>
1.41 asau 6353: <div class="sect1">
1.1 dsieger 6354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6355: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
6356: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
6357: included by Makefiles to indicate the need to compile and link
6358: against header files and libraries provided by the package. A
6359: <code class="filename">buildlink3.mk</code> file should always provide
6360: enough information to add the correct type of dependency
6361: relationship and include any other
6362: <code class="filename">buildlink3.mk</code> files that it needs to find
6363: headers and libraries that it needs in turn.</p>
6364: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.207 leot 6365: 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 6366: package is highly recommended. For most packages, the following
6367: command will generate a good starting point for
6368: <code class="filename">buildlink3.mk</code> files:</p>
6369: <pre class="screen">
6370: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
6371: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
6372: </pre>
1.41 asau 6373: <div class="sect2">
1.1 dsieger 6374: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6375: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
6376: <p>The following real-life example
6377: <code class="filename">buildlink3.mk</code> is taken
6378: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1 dsieger 6379: <pre class="programlisting">
1.184 rillig 6380: BUILDLINK_TREE+= tiff
6381:
6382: .if !defined(TIFF_BUILDLINK3_MK)
6383: TIFF_BUILDLINK3_MK:=
6384:
6385: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
6386: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
6387: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
6388:
6389: .include "../../devel/zlib/buildlink3.mk"
6390: .include "../../graphics/jpeg/buildlink3.mk"
6391: .endif # TIFF_BUILDLINK3_MK
6392:
6393: BUILDLINK_TREE+= -tiff
1.1 dsieger 6394: </pre>
1.184 rillig 6395: <p>The header and footer manipulate
6396: <code class="varname">BUILDLINK_TREE</code>, which is common across all
6397: <code class="filename">buildlink3.mk</code> files and is used to track
6398: the dependency tree.</p>
6399: <p>The main section is protected from multiple inclusion
6400: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
6401: added. Several important variables are set in the section:</p>
6402: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6403: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6404: is the dependency version recorded in the installed
1.184 rillig 6405: package; this should always be set using
6406: <span class="command"><strong>+=</strong></span> to ensure that
6407: we're appending to any pre-existing list of values. This
1.185 wiz 6408: variable should be set to the last version of the
1.184 rillig 6409: package that had an backwards-incompatible API change.
6410: </p></li>
6411: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
6412: is the location of the <em class="replaceable"><code>pkg</code></em>
6413: pkgsrc directory.</p></li>
6414: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
6415: (not shown above) controls whether we use
1.236 gutterid 6416: <code class="varname">BUILD_DEPENDS</code> or
1.184 rillig 6417: <code class="varname">DEPENDS</code> to add the dependency on
6418: <em class="replaceable"><code>pkg</code></em>. The build dependency is
6419: selected by setting
6420: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.236 gutterid 6421: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.184 rillig 6422: used.</p></li>
6423: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
6424: and
6425: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
6426: (not shown above) are lists of subdirectories of
6427: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6428: to add to the header and library search paths. These
6429: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
6430: respectively.</p></li>
6431: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
6432: (not shown above) is the list of preprocessor flags to add
6433: to <code class="varname">CPPFLAGS</code>, which are passed on to the
6434: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
6435: should be avoided and instead be handled using
6436: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
6437: above.</p></li>
6438: </ul></div>
6439: <p>The following variables are all optionally defined within
6440: this second section (protected against multiple inclusion) and
6441: control which package files are symlinked into
6442: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
6443: transformed during the symlinking:</p>
6444: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6445: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
6446: (not shown above) is a shell glob pattern relative to
6447: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6448: to be symlinked into
6449: <code class="filename">${BUILDLINK_DIR}</code>,
6450: e.g. <code class="filename">include/*.h</code>.</p></li>
6451: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
6452: (not shown above) is a shell pipeline that
6453: outputs to stdout a list of files relative to
6454: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
6455: The resulting files are to be symlinked
6456: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
6457: this takes the <code class="filename">+CONTENTS</code> of a
6458: <em class="replaceable"><code>pkg</code></em> and filters it through
6459: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
6460: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6461: (not shown above) is a filter command that filters
6462: <code class="filename">+CONTENTS</code> input into a list of files
6463: relative to
6464: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
6465: on stdout. By default,
6466: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
6467: outputs the contents of the <code class="filename">include</code>
6468: and <code class="filename">lib</code> directories in the package
6469: <code class="filename">+CONTENTS</code>.</p></li>
6470: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
6471: (not shown above) is a list of sed arguments used to
6472: transform the name of the source filename into a
6473: destination filename, e.g. <span class="command"><strong>-e
6474: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
6475: </ul></div>
6476: <p>This section can additionally include any
6477: <code class="filename">buildlink3.mk</code> needed for
6478: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
6479: Including these <code class="filename">buildlink3.mk</code> files
6480: means that the headers and libraries for these
6481: dependencies are also symlinked into
6482: <code class="filename">${BUILDLINK_DIR}</code>
6483: whenever the <em class="replaceable"><code>pkg</code></em>
6484: <code class="filename">buildlink3.mk</code>
6485: file is included. Dependencies are only added for directly
6486: include <code class="filename">buildlink3.mk</code> files.</p>
6487: <p>When providing a <code class="filename">buildlink3.mk</code> and
6488: including other <code class="filename">buildlink3.mk</code> files in it,
6489: please only add necessary ones, i.e., those whose libraries or
6490: header files are automatically exposed when the package is
6491: use.</p>
6492: <p>In particular, if only an executable
6493: (<code class="filename">bin/foo</code>) is linked against a library, that
6494: library does not need to be propagated in the
6495: <code class="filename">buildlink3.mk</code> file.</p>
6496: <p>The following steps should help you decide if a
6497: <code class="filename">buildlink3.mk</code> file needs to be included:
6498: </p>
6499: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6500: <li class="listitem"><p>Look at the installed header files: What
6501: headers do they include? The packages providing these files
6502: must be buildlinked.</p></li>
6503: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
6504: libraries and look against what other libraries they link.
6505: Some of the packages providing these probably need to be
6506: buildlinked; however, it's not automatic, since e.g. GTK on
6507: some systems pulls in the X libraries, so they will show up in
6508: the <code class="filename">ldd</code> output, while on others (like OS
6509: X) it won't. <code class="filename">ldd</code> output can thus only be
6510: used as a hint.</p></li>
6511: </ul></div>
6512: <p>
6513: </p>
6514: </div>
1.41 asau 6515: <div class="sect2">
1.1 dsieger 6516: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 6517: <a name="updating-buildlink-depends"></a>18.2.2. Updating
6518: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6519: and
6520: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6521: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185 wiz 6522: <p>Both variables set lower bounds for a version of this package.
6523: The two variables differ in that one describes source
1.184 rillig 6524: compatibility (API) and the other binary compatibility (ABI).
6525: The difference is that a change in the API breaks compilation of
6526: programs while changes in the ABI stop compiled programs from
6527: running.</p>
1.185 wiz 6528: <p>The
6529: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6530: variable in a <code class="filename">buildlink3.mk</code> should be
6531: changed very rarely. (One possible scenario: If all packages
6532: using this package need a higher version than defined in the
6533: <code class="filename">buildlink3.mk</code>,
1.184 rillig 6534: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6535: could be updated to that higher version.)</p>
6536: <p>On the other hand, changes to
1.184 rillig 6537: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6538: are more common. The variable will need to be updated every
6539: time the major version of one of its shared libraries is changed,
6540: or any other change where a binary built against the previous
6541: version of the package will not run against the new version any
6542: longer.</p>
6543: <p>In such a case, the package's
1.184 rillig 6544: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6545: must be increased to require the new package version. Then the
6546: <code class="varname">PKGREVISION</code> of all packages
6547: <em class="replaceable"><code>foo</code></em> that depend on this package need
6548: to be increased, and if they have
6549: <code class="filename">buildlink3.mk</code> files,
6550: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
6551: in their <code class="filename">buildlink3.mk</code> files must be
6552: increased to the new version as well. This is required so that a
6553: package will pull in the versions of the packages that use the
6554: new ABI and that the packages' <code class="varname">PKGREVISION</code>s
6555: uniquely identify the packages built against the new ABI. The
1.207 leot 6556: <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 6557: help with these updates.</p>
6558: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, “Handling dependencies”</a> for more information
6559: about dependencies on other packages, including the
6560: <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184 rillig 6561: <p>Please take careful consideration before adjusting
6562: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6563: or
6564: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185 wiz 6565: in a <code class="filename">buildlink3.mk</code> file as we don't want to
6566: cause unneeded package deletions and rebuilds. In many cases,
6567: new versions of packages work just fine with older
6568: dependencies.</p>
1.211 gutterid 6569: <p>Also, it is not needed to set
1.184 rillig 6570: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
6571: when it is identical to
1.211 gutterid 6572: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.</p>
6573: <p>Note there is also the distinction that users are able to disable
6574: enforcement of ABI dependencies using the <code class="varname">USE_ABI_DEPENDS</code>
6575: variable, but there is no equivalent option for API dependencies.</p>
1.1 dsieger 6576: </div>
6577: </div>
1.41 asau 6578: <div class="sect1">
1.1 dsieger 6579: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6580: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
6581: <p>Some packages in pkgsrc install headers and libraries that
6582: coincide with headers and libraries present in the base system.
6583: Aside from a <code class="filename">buildlink3.mk</code> file, these
6584: packages should also include a <code class="filename">builtin.mk</code>
6585: file that includes the necessary checks to decide whether using
6586: the built-in software or the pkgsrc software is
6587: appropriate.</p>
6588: <p>The only requirements of a builtin.mk file for
6589: <em class="replaceable"><code>pkg</code></em> are:</p>
6590: <div class="orderedlist"><ol class="orderedlist" type="1">
6591: <li class="listitem"><p>It should set
6592: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6593: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
6594: after it is included.</p></li>
6595: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
6596: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6597: which is already set before the
6598: <code class="filename">builtin.mk</code> file is included.</p></li>
6599: <li class="listitem"><p>It should be written to allow multiple inclusion. This
6600: is <span class="emphasis"><em>very</em></span> important and takes careful
6601: attention to <code class="filename">Makefile</code> coding.</p></li>
6602: </ol></div>
6603: <div class="sect2">
6604: <div class="titlepage"><div><div><h3 class="title">
6605: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
6606: <p>The following is the recommended template for builtin.mk
6607: files:</p>
1.1 dsieger 6608: <pre class="programlisting">
1.184 rillig 6609: .if !defined(IS_BUILTIN.foo)
6610: #
6611: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
6612: # genuinely exists in the system or not.
6613: #
6614: IS_BUILTIN.foo?= no
1.1 dsieger 6615:
1.184 rillig 6616: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
6617: # version can be determined.
6618: #
6619: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
6620: BUILTIN_PKG.foo?= foo-1.0
6621: . endif
6622: .endif # IS_BUILTIN.foo
1.1 dsieger 6623:
1.184 rillig 6624: .if !defined(USE_BUILTIN.foo)
6625: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
6626: . if defined(BUILTIN_PKG.foo)
6627: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
6628: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
6629: USE_BUILTIN.foo!= \
6630: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
6631: && ${ECHO} "yes" || ${ECHO} "no"
6632: . endif
6633: . endfor
6634: . endif
6635: .endif # USE_BUILTIN.foo
1.1 dsieger 6636:
1.184 rillig 6637: CHECK_BUILTIN.foo?= no
6638: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
6639: #
6640: # Here we place code that depends on whether USE_BUILTIN.foo is set to
6641: # "yes" or "no".
6642: #
6643: .endif # CHECK_BUILTIN.foo
1.1 dsieger 6644: </pre>
1.184 rillig 6645: <p>The first section sets
6646: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6647: depending on if <em class="replaceable"><code>pkg</code></em> really exists
6648: in the base system. This should not be a base system software
6649: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
6650: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
6651: included as part of the base system. This variable is only
6652: used internally within the <code class="filename">builtin.mk</code>
6653: file.</p>
6654: <p>The second section sets
6655: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6656: to the version of <em class="replaceable"><code>pkg</code></em> in the base
6657: system if it exists (if
6658: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6659: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
6660: within the <code class="filename">builtin.mk</code> file.</p>
6661: <p>The third section sets
6662: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6663: and is <span class="emphasis"><em>required</em></span> in all
6664: <code class="filename">builtin.mk</code> files. The code in this
6665: section must make the determination whether the built-in
6666: software is adequate to satisfy the dependencies listed in
6667: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6668: This is typically done by comparing
6669: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
6670: against each of the dependencies in
6671: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
6672: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6673: <span class="emphasis"><em>must</em></span> be set to the correct value by the
6674: end of the <code class="filename">builtin.mk</code> file. Note that
6675: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6676: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
6677: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6678: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
6679: that the built-in version of the software is similar enough to
6680: be used as a replacement.</p>
6681: <p>The last section is guarded by
6682: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
6683: and includes code that uses the value of
6684: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
6685: set in the previous section. This typically includes, e.g.,
6686: adding additional dependency restrictions and listing additional
6687: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
6688: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
6689: </div>
1.7 rillig 6690: </div>
1.1 dsieger 6691: </div>
1.41 asau 6692: <div class="chapter">
1.1 dsieger 6693: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 6694: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1 dsieger 6695: <div class="toc">
6696: <p><b>Table of Contents</b></p>
1.100 leot 6697: <dl class="toc">
1.184 rillig 6698: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
6699: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
6700: <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>
6701: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
6702: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
6703: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
6704: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
6705: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
6706: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1 dsieger 6707: </dl>
6708: </div>
1.184 rillig 6709: <p>The <code class="filename">PLIST</code> file contains a package's
6710: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
6711: the package (relative to the <code class="filename">${PREFIX}</code>
6712: directory it's been installed in) plus some additional statements
1.246 leot 6713: - see the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.184 rillig 6714: This chapter addresses some issues that need attention when
6715: dealing with the <code class="filename">PLIST</code> file (or files, see
6716: below!).</p>
1.41 asau 6717: <div class="sect1">
1.1 dsieger 6718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6719: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
6720: <p>Be sure to add a RCS ID line as the first thing in any
6721: <code class="filename">PLIST</code> file you write:</p>
6722: <pre class="programlisting">
6723: @comment $NetBSD $
6724: </pre>
6725: <p>An artificial space has been added between NetBSD and $, this is a
6726: workaround here to prevent CVS expanding to the filename of the guide. When
6727: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6728: </div>
1.41 asau 6729: <div class="sect1">
1.1 dsieger 6730: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6731: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
6732: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
6733: to output a PLIST that matches any new files since the package
6734: was extracted. See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, “Other helpful targets”</a> for
6735: more information on this target.</p>
1.1 dsieger 6736: </div>
1.41 asau 6737: <div class="sect1">
1.1 dsieger 6738: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6739: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
6740: </h2></div></div></div>
6741: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
6742: of AWK patterns and actions that are used to filter the output of
6743: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
6744: scripting you like to it, but be careful with quoting.</p>
6745: <p>For example, to get all files inside the
6746: <code class="filename">libdata/foo</code> directory removed from the
6747: resulting PLIST:</p>
1.1 dsieger 6748: <pre class="programlisting">
1.184 rillig 6749: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 6750: </pre>
1.185 wiz 6751: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
6752: evaluated after the file list and directory list are sorted.
6753: <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
6754: <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
6755: list and directory list are sorted.</p>
1.184 rillig 6756: </div>
6757: <div class="sect1">
6758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6759: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
6760: <p>A number of variables are substituted automatically in
6761: PLISTs when a package is installed on a system. This includes the
6762: following variables:</p>
6763: <div class="variablelist"><dl class="variablelist">
6764: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
6765: <dd>
6766: <p>Some packages like emacs and perl embed information
6767: about which architecture they were built on into the
6768: pathnames where they install their files. To handle this
6769: case, PLIST will be preprocessed before actually used, and
6770: the symbol
6771: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
6772: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
6773: same is done if the string
6774: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
6775: PLIST somewhere - use this on packages that have GNU
6776: autoconf-created configure scripts.</p>
6777: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
6778: <h3 class="title">Legacy note</h3>
6779: <p>There used to be a symbol
6780: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
6781: was replaced by the output of <span class="command"><strong>uname
6782: -m</strong></span>, but that's no longer supported and has
6783: been removed.</p>
6784: </div>
6785: </dd>
6786: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
6787: <dd>
6788: <p>Some packages want to embed the OS name and version
6789: into some paths. To do this, use these variables in the
6790: <code class="filename">PLIST</code>:
6791: </p>
6792: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6793: <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>
6794: <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>
6795: <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>
6796: </ul></div>
6797: </dd>
6798: </dl></div>
6799: <p>For a list of values which are replaced by
6800: default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
6801: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
6802: <code class="varname">PLIST_SUBST</code> should help.</p>
6803: <p>If you want to change other variables not listed above, you
6804: can add variables and their expansions to this variable in the
6805: 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 6806: <pre class="programlisting">
1.184 rillig 6807: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 6808: </pre>
1.184 rillig 6809: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
6810: in the <code class="filename">PLIST</code> with
6811: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
6812: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
6813: the common case of conditionally including some
6814: <code class="filename">PLIST</code> entries. It can be done by adding
6815: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
6816: setting the corresponding <code class="varname">PLIST.foo</code> variable
6817: to <code class="literal">yes</code> if the entry should be included.
6818: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
6819: in the <code class="filename">PLIST</code> with either
6820: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
6821: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
6822: For example, in <code class="filename">Makefile</code>:</p>
1.66 asau 6823: <pre class="programlisting">
1.184 rillig 6824: PLIST_VARS+= foo
6825: .if <em class="replaceable"><code>condition</code></em>
6826: PLIST.foo= yes
6827: .else
1.66 asau 6828: </pre>
1.184 rillig 6829: <p>And then in <code class="filename">PLIST</code>:</p>
1.1 dsieger 6830: <pre class="programlisting">
1.184 rillig 6831: @comment $NetBSD $
6832: bin/bar
6833: man/man1/bar.1
6834: ${PLIST.foo}bin/foo
6835: ${PLIST.foo}man/man1/foo.1
6836: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 6837: </pre>
1.184 rillig 6838: <p>An artificial space has been added between NetBSD and $, this is a
6839: workaround here to prevent CVS expanding to the filename of the guide. When
1.195 gutterid 6840: adding the RCS ID the space should be omitted.</p>
1.1 dsieger 6841: </div>
1.184 rillig 6842: <div class="sect1">
6843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6844: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
6845: <p>Man pages should be installed in compressed form if
6846: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
6847: and uncompressed otherwise. To handle this in the
6848: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
6849: appended/removed automatically for man pages according to
6850: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
6851: or not, see above for details. This modification of the
6852: <code class="filename">PLIST</code> file is done on a copy of it, not
6853: <code class="filename">PLIST</code> itself.</p>
1.1 dsieger 6854: </div>
1.41 asau 6855: <div class="sect1">
1.1 dsieger 6856: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6857: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
6858: </h2></div></div></div>
6859: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
6860: in generating the binary package, set the variable
6861: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.246 leot 6862: The files are later concatenated using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.184 rillig 6863: important. The default for <code class="varname">PLIST_SRC</code> is
6864: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1 dsieger 6865: </div>
1.41 asau 6866: <div class="sect1">
1.1 dsieger 6867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6868: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
6869: <p>Some packages decide to install a different set of files based on
6870: the operating system being used. These differences can be
6871: automatically handled by using the following files:</p>
6872: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6873: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
6874: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
6875: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
6876: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
6877: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
6878: </ul></div>
1.1 dsieger 6879: </div>
1.41 asau 6880: <div class="sect1">
1.1 dsieger 6881: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6882: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
6883: <p>Some packages decide to generate hard-to-guess file names
6884: during installation that are hard to wire down.</p>
6885: <p>In such cases, you can set the
6886: <code class="varname">GENERATE_PLIST</code> variable to shell code
6887: terminated (with a semicolon) that will output PLIST entries which
6888: will be appended to the PLIST</p>
6889: <p>You can find one example in editors/xemacs:</p>
6890: <pre class="programlisting">
6891: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
6892: </pre>
6893: <p>which will append something like
6894: <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
6895: <code class="filename">PLIST</code>.
6896: </p>
1.1 dsieger 6897: </div>
1.41 asau 6898: <div class="sect1">
1.1 dsieger 6899: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6900: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
6901: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
6902: multiple (and unrelated) packages install files. These
6903: directories were problematic because you had to add special
6904: tricks in the PLIST to conditionally remove them, or have some
6905: centralized package handle them.</p>
6906: <p>In pkgsrc, it is now easy: Each package should create
6907: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
6908: will remove any directories left empty after uninstalling a
6909: package.</p>
6910: <p>If a package needs an empty directory to work, create
6911: the directory during installation as usual, and also add an
6912: entry to the PLIST:
6913:
6914: </p>
6915: <pre class="programlisting">
6916: @pkgdir path/to/empty/directory
6917: </pre>
6918: <p>
6919:
6920: or take a look at <code class="varname">MAKE_DIRS</code> and
6921: <code class="varname">OWN_DIRS</code>.
1.1 dsieger 6922: </p>
6923: </div>
1.184 rillig 6924: </div>
6925: <div class="chapter">
6926: <div class="titlepage"><div><div><h2 class="title">
6927: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
6928: <div class="toc">
6929: <p><b>Table of Contents</b></p>
6930: <dl class="toc">
6931: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
6932: <dd><dl>
6933: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
6934: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
6935: </dl></dd>
6936: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
6937: <dd><dl>
6938: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
6939: <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 6940: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installation</a></span></dt>
6941: <dt><span class="sect2"><a href="#conf-files-declare">20.2.4. Declaring configuration files</a></span></dt>
6942: <dt><span class="sect2"><a href="#conf-files-disable">20.2.5. Disabling handling of configuration files</a></span></dt>
1.184 rillig 6943: </dl></dd>
6944: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
6945: <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>
6946: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
6947: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
6948: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
6949: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
6950: <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>
6951: </dl>
6952: </div>
6953: <p>This chapter describes the framework known as
6954: <code class="literal">pkginstall</code>, whose key features are:</p>
6955: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
6956: <li class="listitem"><p>Generic installation and manipulation of directories and files
6957: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
6958: <li class="listitem"><p>Automatic handling of configuration files during installation,
6959: provided that packages are correctly designed.</p></li>
6960: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
6961: <li class="listitem"><p>Registration of system users and groups.</p></li>
6962: <li class="listitem"><p>Registration of system shells.</p></li>
6963: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
6964: </ul></div>
6965: <p>The following sections inspect each of the above points in detail.</p>
6966: <p>You may be thinking that many of the things described here could be
6967: easily done with simple code in the package's post-installation target
6968: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
6969: as the code in them is only executed when building from source. Machines
6970: using binary packages could not benefit from it at all (as the code itself
6971: could be unavailable). Therefore, the only way to achieve any of the items
6972: described above is by means of the installation scripts, which are
6973: automatically generated by pkginstall.</p>
1.41 asau 6974: <div class="sect1">
1.1 dsieger 6975: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 6976: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
6977: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
6978: of files and directories that belong to a package. The names used in it
6979: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
6980: which means that it cannot register files outside this directory (absolute
6981: path names are not allowed). Despite this restriction, some packages need
6982: to install files outside this location; e.g., under
6983: <code class="filename">${VARBASE}</code> or
6984: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
6985: is to create such files during installation time by using
6986: installation scripts.</p>
6987: <p>The generic installation scripts are shell scripts that can
6988: contain arbitrary code. The list of scripts to execute is taken from
6989: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6990: <code class="filename">INSTALL</code>. A similar variable exists for package
6991: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6992: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6993: commands, so they have the potential to create and manage files
6994: anywhere in the file system.</p>
6995: <p>Using these general installation files is not recommended, but
6996: may be needed in some special cases. One reason for avoiding them is
6997: that the user has to trust the packager that there is no unwanted or
6998: simply erroneous code included in the installation script. Also,
6999: previously there were many similar scripts for the same functionality,
7000: and fixing a common error involved finding and changing all of
7001: them.</p>
7002: <p>The pkginstall framework offers another, standardized way. It
7003: provides generic scripts to abstract the manipulation of such files
7004: and directories based on variables set in the package's
7005: <code class="filename">Makefile</code>. The rest of this section describes
7006: these variables.</p>
7007: <div class="sect2">
7008: <div class="titlepage"><div><div><h3 class="title">
7009: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
7010: <p>The following variables can be set to request the creation of
7011: directories anywhere in the file system:</p>
7012: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7013: <li class="listitem">
7014: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
7015: contain a list of directories that should be created and should attempt
7016: to be destroyed by the installation scripts. The difference between
7017: the two is that the latter prompts the administrator to remove any
7018: directories that may be left after deinstallation (because they were
7019: not empty), while the former does not. Example:</p>
7020: <pre class="programlisting">
7021: MAKE_DIRS+= ${VARBASE}/foo/private
7022: </pre>
7023: </li>
7024: <li class="listitem">
7025: <p><code class="varname">MAKE_DIRS_PERMS</code> and
7026: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
7027: which directories should be created and should attempt to be destroyed
7028: by the installation scripts. Each tuple holds the following values,
7029: separated by spaces: the directory name, its owner, its group and its
7030: numerical mode. For example:</p>
7031: <pre class="programlisting">
7032: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
7033: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
7034: </pre>
7035: <p>The difference between the two is exactly the same as their
7036: non-<code class="varname">PERMS</code> counterparts.</p>
7037: </li>
7038: </ul></div>
1.1 dsieger 7039: </div>
1.184 rillig 7040: <div class="sect2">
7041: <div class="titlepage"><div><div><h3 class="title">
7042: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
7043: <p>Creating non-empty files outside the installation prefix is tricky
7044: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.239 dholland 7045: To overcome this problem, the only solution is to extract the file in a
1.184 rillig 7046: known place (i.e., inside the installation prefix) and copy it to the
7047: appropriate location during installation (done by the installation scripts
1.239 dholland 7048: generated by pkginstall). We will call the former the <span class="emphasis"><em>reference
1.184 rillig 7049: file</em></span> in the following paragraphs, which describe the variables
7050: that can be used to automatically and consistently handle files outside the
7051: installation prefix:</p>
7052: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.239 dholland 7053: <li class="listitem"><p><code class="varname">REQD_FILES</code> is a list of pairs of reference
7054: and target files. At installation time, the reference file is copied
7055: to the target if and only if the latter does not exist. Upon
7056: deinstallation, the reference file is removed provided that it was
7057: not modified by the installation.</p></li>
1.184 rillig 7058: <li class="listitem">
1.239 dholland 7059: <p><code class="varname">REQD_FILES_PERMS</code> contains tuples describing
7060: reference files and targets, including owner, group, and numeric
7061: permissions that should be set. For example:</p>
1.1 dsieger 7062: <pre class="programlisting">
1.184 rillig 7063: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
7064: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 7065: </pre>
1.184 rillig 7066: </li>
1.239 dholland 7067: <li class="listitem"><p><code class="varname">CONF_FILES</code> and
7068: <code class="varname">CONF_FILES_PERMS</code> have the same syntax as
7069: <code class="varname">REQD_FILES</code> and
7070: <code class="varname">REQD_FILES_PERMS</code> respectively. The difference
7071: is that these variables are specifically intended for handling
7072: configuration files, for which additional conventions and
7073: constraints apply. See <a class="xref" href="#conf-files" title="20.2. Configuration files">Section 20.2, “Configuration files”</a> for further
7074: discussion. Note in particular that while handling of
7075: 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
7076: <code class="varname">REQD_FILES</code> and
7077: <code class="varname">REQD_FILES_PERMS</code>.</p></li>
1.184 rillig 7078: </ul></div>
1.239 dholland 7079: <p>To install an empty file, one can use these macros and
7080: <code class="filename">/dev/null</code> as the reference file.</p>
1.184 rillig 7081: </div>
1.1 dsieger 7082: </div>
1.41 asau 7083: <div class="sect1">
1.1 dsieger 7084: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7085: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
1.239 dholland 7086: <p>There are two principles that govern the handling of
7087: configuration files in pkgsrc: first, the user's configuration must
7088: not be lost or overwritten by upgrades or reinstallations; and second,
7089: the default configuration should always be available for reference.
7090: To that end, pkgsrc has a framework specifically for handling
7091: configuration files. In general, configuration files are installed
7092: into <code class="filename">${PREFIX}/share/examples</code>, and copied from
7093: there to the pertinent <code class="filename">etc</code> directory as a
7094: separate step and only as needed.</p>
7095: <p>To make this work, there are three things that need to happen,
7096: any of which may require patching. First, the package must be told to
7097: read its configuration from the correct place at runtime; this place
7098: is <code class="filename">${PKG_SYSCONFDIR}</code> (or possibly a subdirectory
7099: of it) which is often but not always
7100: <code class="filename">${PREFIX}/etc</code>. Second, the package must be
7101: taught to install its default configuration files in
7102: <code class="filename">${PREFIX}/share/examples/${PKGBASE}</code>; this is the
7103: point at which patching often becomes required because it is not the
7104: same place as the runtime location. Third, the configuration files
7105: need to be declared in the package makefile; this is the easy part.
7106: </p>
7107: <p>With those elements in place, the right things will happen: the
7108: package install phase and resulting binary package will not touch
7109: <code class="filename">${PKG_SYSCONFDIR}</code>, and the default configuration
7110: will be copied into place by the pkgsrc framework only if not already
7111: present. Similarly, upon deinstall the configuration will not be
7112: removed if it has been modified. (This means that in the case of
7113: reinstallation and upgrades, unmodified configuration files are
7114: updated but modifications are never discarded.)</p>
7115: <p>The following sections describe how to make these things happen
7116: and document other relevant knobs available in the pkgsrc
7117: infrastructure.</p>
1.184 rillig 7118: <div class="sect2">
7119: <div class="titlepage"><div><div><h3 class="title">
7120: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
7121: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
7122: specifies where configuration files shall be installed. Its contents are
7123: set based upon the following variables:</p>
7124: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7125: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
7126: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.239 dholland 7127: be overridden by the user to point to their preferred location (e.g.,
1.184 rillig 7128: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
7129: Packages must not use it directly.</p></li>
7130: <li class="listitem">
7131: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
7132: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
7133: for the package being built shall be installed. The definition of this
7134: variable only makes sense in the package's
7135: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
7136: <p>As an example, consider the Apache package,
1.207 leot 7137: <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 7138: configuration files under the
7139: <code class="filename">httpd/</code> subdirectory of
7140: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
7141: Makefile.</p>
7142: </li>
7143: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
7144: variable that holds this package's configuration directory (if
7145: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
7146: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
7147: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
7148: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
7149: directory where the configuration files for the package identified by
7150: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
7151: </ul></div>
7152: <p>Based on the above variables, pkginstall determines the value of
7153: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
1.239 dholland 7154: variable that may be used within a package to refer to its configuration
1.184 rillig 7155: directory. The algorithm used to set its value is basically the
7156: following:</p>
7157: <div class="orderedlist"><ol class="orderedlist" type="1">
7158: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
7159: its value is used.</p></li>
7160: <li class="listitem"><p>If the previous variable is not defined but
7161: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
7162: <code class="filename">Makefile</code>, the resulting value is
7163: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
7164: <li class="listitem"><p>Otherwise, it is set to
7165: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
7166: </ol></div>
7167: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.239 dholland 7168: automatically added to <code class="filename">OWN_DIRS</code>. This causes it
7169: 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
7170: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>; they must be manually
7171: created with <code class="varname">OWN_DIRS</code> or
7172: <code class="varname">MAKE_DIRS</code>.</p>
1.184 rillig 7173: </div>
7174: <div class="sect2">
7175: <div class="titlepage"><div><div><h3 class="title">
7176: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
7177: <p>Given that pkgsrc (and users!) expect configuration files to be in a
1.239 dholland 7178: known place, you need to teach each package where to install its files. In
7179: some cases you will have to patch the package Makefiles to achieve it. If
7180: you are lucky, though, it may be as easy as passing an extra flag to the
7181: configuration script. This is the case for packages using GNU
7182: autoconf:</p>
1.1 dsieger 7183: <pre class="programlisting">
1.184 rillig 7184: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 7185: </pre>
1.184 rillig 7186: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
1.239 dholland 7187: for</em></span> its configuration files, not where they will be installed.
7188: Fortunately, there is a different way to specify the latter, as seen
1.240 gutterid 7189: in the next section, although the combination is rather confusing at
1.239 dholland 7190: first glance.</p>
1.1 dsieger 7191: </div>
1.184 rillig 7192: <div class="sect2">
7193: <div class="titlepage"><div><div><h3 class="title">
1.239 dholland 7194: <a name="conf-files-patching"></a>20.2.3. Patching installation</h3></div></div></div>
7195: <p>As discussed above, <span class="strong"><strong>packages themselves must not
1.184 rillig 7196: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
7197: directly</strong></span>. Bad news is that many software installation scripts
7198: will, out of the box, mess with the contents of that directory. So what is
7199: the correct procedure to fix this issue?</p>
7200: <p>You must teach the package (usually by manually patching it) to
7201: install any configuration files under the examples hierarchy,
7202: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
7203: <code class="filename">PLIST</code> registers them and the administrator always
7204: has the original copies available.</p>
1.239 dholland 7205: <p>It turns out that for packages using GNU autoconf it is possible
7206: to create the desired effect by setting <code class="varname">sysconfdir</code>
7207: on the make command line at install time. Consider this example taken
7208: 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>
7209: <pre class="programlisting">
7210: EGDIR= ${PREFIX}/share/examples/mutt
7211: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
7212: </pre>
7213: <p>Note that the <code class="varname">EGDIR</code> variable, though commonly
7214: used for this purpose, is local to that package and has no meaning
7215: outside it.</p>
7216: </div>
7217: <div class="sect2">
7218: <div class="titlepage"><div><div><h3 class="title">
7219: <a name="conf-files-declare"></a>20.2.4. Declaring configuration files</h3></div></div></div>
1.184 rillig 7220: <p>Once the required configuration files are in place (i.e., under the
1.239 dholland 7221: examples hierarchy), the pkginstall framework can use them as reference copies
1.184 rillig 7222: during the package installation to update what is in
7223: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
7224: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.239 dholland 7225: 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
7226: information about their syntax and their purpose. Here is an example,
7227: 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>
7228: <pre class="programlisting">
7229: EGDIR= ${PREFIX}/share/examples/mutt
7230: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7231: </pre>
7232: <p>Note that (as in the previous section's example) the
7233: <code class="varname">EGDIR</code> variable is specific to the package and has
7234: no meaning outside it.</p>
7235: <p>For reference, the complete example from Mutt is as follows:</p>
1.1 dsieger 7236: <pre class="programlisting">
1.239 dholland 7237: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
7238: EGDIR= ${PREFIX}/share/examples/mutt
7239: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
7240: INSTALLATION_DIRS+= ${EGDIR}
7241: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.1 dsieger 7242: </pre>
7243: </div>
1.184 rillig 7244: <div class="sect2">
7245: <div class="titlepage"><div><div><h3 class="title">
1.239 dholland 7246: <a name="conf-files-disable"></a>20.2.5. Disabling handling of configuration files</h3></div></div></div>
1.184 rillig 7247: <p>The automatic copying of config files can be toggled by setting the
7248: environment variable <code class="varname">PKG_CONFIG</code> prior to package
7249: installation.</p>
1.1 dsieger 7250: </div>
7251: </div>
1.41 asau 7252: <div class="sect1">
1.1 dsieger 7253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7254: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
7255: <p>System startup scripts are special files because they must be
7256: installed in a place known by the underlying OS, usually outside the
7257: 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
7258: can be used. However, pkginstall provides a special mechanism to handle
7259: these files.</p>
7260: <p>In order to provide system startup scripts, the package has
7261: to:</p>
7262: <div class="orderedlist"><ol class="orderedlist" type="1">
7263: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
7264: the <code class="literal">.sh</code> suffix appended. Considering the
1.223 nia 7265: <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
7266: has a <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.184 rillig 7267: <li class="listitem">
7268: <p>Tell pkginstall to handle it, appending the name of the script,
7269: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
7270: Continuing the previous example:</p>
7271: <pre class="programlisting">
7272: RCD_SCRIPTS+= cupsd
7273: </pre>
7274: </li>
7275: </ol></div>
7276: <p>Once this is done, pkginstall will do the following steps for each
7277: script in an automated fashion:</p>
7278: <div class="orderedlist"><ol class="orderedlist" type="1">
7279: <li class="listitem"><p>Process the file found in the files directory applying all the
7280: substitutions described in the <code class="filename">FILES_SUBST</code>
7281: variable.</p></li>
7282: <li class="listitem"><p>Copy the script from the files directory to the examples
7283: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.239 dholland 7284: that this reference file must be explicitly registered in the
1.184 rillig 7285: <code class="filename">PLIST</code>.</p></li>
7286: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
7287: from the examples hierarchy into the system-wide startup scripts
7288: directory.</p></li>
7289: </ol></div>
7290: <div class="sect2">
7291: <div class="titlepage"><div><div><h3 class="title">
7292: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
7293: <p>The automatic copying of config files can be toggled by setting the
7294: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
7295: installation. Note that the scripts will be always copied inside the
7296: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
7297: matter what the value of this variable is.</p>
1.1 dsieger 7298: </div>
7299: </div>
1.184 rillig 7300: <div class="sect1">
7301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7302: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
7303: <p>If a package needs to create special users and/or groups during
7304: installation, it can do so by using the pkginstall framework.</p>
7305: <p>Users can be created by adding entries to the
7306: <code class="varname">PKG_USERS</code> variable. Each entry has the following
7307: syntax:</p>
7308: <pre class="programlisting">
7309: user:group
7310: </pre>
7311: <p>Further specification of user details may be done by setting
7312: per-user variables.
7313: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
7314: numeric UID for the user.
7315: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
7316: user's description or comment.
7317: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
7318: user's home directory, and defaults to
7319: <code class="filename">/nonexistent</code> if not specified.
7320: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
7321: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
7322: not specified.</p>
7323: <p>Similarly, groups can be created by adding entries to the
7324: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
7325: <pre class="programlisting">
7326: group
7327: </pre>
7328: <p>The numeric GID of the group may be set by defining
7329: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
7330: <p>If a package needs to create the users and groups at an earlier
7331: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
7332: <code class="literal">configure</code>,<code class="literal">build</code>, or
7333: <code class="literal">pre-install</code> to indicate the phase before which the
7334: users and groups are created. In this case, the numeric UIDs and GIDs
7335: of the created users and groups are automatically hardcoded into the
7336: final installation scripts.</p>
1.1 dsieger 7337: </div>
1.41 asau 7338: <div class="sect1">
1.1 dsieger 7339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7340: <a name="shells"></a>20.5. System shells</h2></div></div></div>
7341: <p>Packages that install system shells should register them in the shell
7342: database, <code class="filename">/etc/shells</code>, to make things easier to the
7343: administrator. This must be done from the installation scripts to keep
7344: binary packages working on any system. pkginstall provides an easy way to
7345: accomplish this task.</p>
7346: <p>When a package provides a shell interpreter, it has to set the
7347: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
7348: add some hooks to the installation scripts to handle it. Consider the
1.207 leot 7349: 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 7350: <pre class="programlisting">
7351: PKG_SHELL= ${PREFIX}/bin/zsh
7352: </pre>
7353: <div class="sect2">
7354: <div class="titlepage"><div><div><h3 class="title">
7355: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
7356: <p>The automatic registration of shell interpreters can be disabled by
7357: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
7358: environment variable to <code class="literal">NO</code>.</p>
7359: </div>
1.1 dsieger 7360: </div>
1.41 asau 7361: <div class="sect1">
1.1 dsieger 7362: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 7363: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
7364: <p>Packages that install X11 fonts should update the database files
7365: that index the fonts within each fonts directory. This can easily be
7366: accomplished within the pkginstall framework.</p>
7367: <p>When a package installs X11 fonts, it must list the directories in
7368: which fonts are installed in the
7369: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
7370: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
7371: <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
7372: installation scripts to run the appropriate commands to update the fonts
7373: database files within each of those directories. For convenience, if the
7374: directory path is relative, it is taken to be relative to the package's
1.207 leot 7375: 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 7376: <pre class="programlisting">
1.184 rillig 7377: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 7378: </pre>
1.184 rillig 7379: <div class="sect2">
7380: <div class="titlepage"><div><div><h3 class="title">
7381: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
7382: <p>The automatic update of fonts databases can be disabled by
7383: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
7384: environment variable to <code class="literal">NO</code>.</p>
1.1 dsieger 7385: </div>
7386: </div>
7387: </div>
1.41 asau 7388: <div class="chapter">
1.1 dsieger 7389: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 7390: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1 dsieger 7391: <div class="toc">
7392: <p><b>Table of Contents</b></p>
1.100 leot 7393: <dl class="toc">
1.154 rillig 7394: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1 dsieger 7395: <dd><dl>
1.154 rillig 7396: <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>
7397: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
7398: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
7399: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
7400: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
7401: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
7402: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
7403: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
7404: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
7405: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
7406: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7407: </dl></dd>
7408: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7409: <dd><dl>
7410: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7411: <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>
7412: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
7413: </dl></dd>
7414: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7415: <dd><dl>
7416: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
7417: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7418: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
1.223 nia 7419: <dt><span class="sect2"><a href="#meson">21.3.4. Meson / ninja</a></span></dt>
1.154 rillig 7420: </dl></dd>
7421: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
7422: <dd><dl>
7423: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
7424: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.205 wiz 7425: <dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
1.223 nia 7426: <dt><span class="sect2"><a href="#rust-programming-language">21.4.4. Rust</a></span></dt>
7427: <dt><span class="sect2"><a href="#perl-scripts">21.4.5. Packages containing Perl scripts</a></span></dt>
7428: <dt><span class="sect2"><a href="#shell-scripts">21.4.6. Packages containing shell scripts</a></span></dt>
7429: <dt><span class="sect2"><a href="#other-programming-languages">21.4.7. Other programming languages</a></span></dt>
1.154 rillig 7430: </dl></dd>
7431: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7432: <dd><dl>
7433: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
7434: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172 rillig 7435: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
7436: <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>
7437: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154 rillig 7438: </dl></dd>
7439: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7440: <dd><dl>
7441: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
7442: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
7443: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
7444: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
7445: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203 nia 7446: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.254 wiz 7447: <dt><span class="sect2"><a href="#faq.pkg-config-files">21.6.7. Packages installing pkg-config files</a></span></dt>
7448: <dt><span class="sect2"><a href="#faq.info-files">21.6.8. Packages installing info files</a></span></dt>
7449: <dt><span class="sect2"><a href="#manpages">21.6.9. Packages installing man pages</a></span></dt>
7450: <dt><span class="sect2"><a href="#x11-fonts">21.6.10. Packages installing X11 fonts</a></span></dt>
7451: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.11. Packages installing SGML or XML data</a></span></dt>
7452: <dt><span class="sect2"><a href="#mime-database">21.6.12. Packages installing extensions to the MIME database</a></span></dt>
7453: <dt><span class="sect2"><a href="#intltool">21.6.13. Packages using intltool</a></span></dt>
7454: <dt><span class="sect2"><a href="#startup-scripts">21.6.14. Packages installing startup scripts</a></span></dt>
7455: <dt><span class="sect2"><a href="#tex-packages">21.6.15. Packages installing TeX modules</a></span></dt>
7456: <dt><span class="sect2"><a href="#emulation-packages">21.6.16. Packages supporting running binaries in
1.1 dsieger 7457: emulation</a></span></dt>
1.254 wiz 7458: <dt><span class="sect2"><a href="#hicolor-theme">21.6.17. Packages installing hicolor icons</a></span></dt>
7459: <dt><span class="sect2"><a href="#desktop-files">21.6.18. Packages installing desktop files</a></span></dt>
1.1 dsieger 7460: </dl></dd>
1.154 rillig 7461: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7462: </dl>
7463: </div>
1.41 asau 7464: <div class="sect1">
1.1 dsieger 7465: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 7466: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1 dsieger 7467: <p>One appealing feature of pkgsrc is that it runs on many
1.108 rillig 7468: different platforms. As a result, it is important to ensure,
7469: where possible, that packages in pkgsrc are portable. This
7470: chapter mentions some particular details you should pay
7471: attention to while working on pkgsrc.</p>
1.41 asau 7472: <div class="sect2">
1.1 dsieger 7473: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7474: <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 7475: </h3></div></div></div>
7476: <p>The pkgsrc user can configure pkgsrc by overriding several
7477: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7478: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7479: want to use those variables in the preprocessor directives of
1.246 leot 7480: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 7481: <code class="literal">.for</code>), you need to include the file
7482: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7483: loads the user preferences.</p>
7484: <p>But note that some variables may not be completely defined
7485: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7486: included, as they may contain references to variables that are
1.108 rillig 7487: not yet defined. In shell commands (the lines in
7488: <code class="filename">Makefile</code> that are indented with a tab) this
7489: is no problem, since variables are only expanded when they are
7490: used. But in the preprocessor directives mentioned above and in
7491: dependency lines (of the form <code class="literal">target:
1.1 dsieger 7492: dependencies</code>) the variables are expanded at load
7493: time.</p>
1.41 asau 7494: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7495: <h3 class="title">Note</h3>
1.108 rillig 7496: <p>To check whether a variable can be used at load time,
7497: run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1 dsieger 7498: </div>
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="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1 dsieger 7503: <p>Occasionally, packages require interaction from the user,
7504: and this can be in a number of ways:</p>
1.41 asau 7505: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7506: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7507: interaction such as entering username/password or accepting a
7508: license on a web page.</p></li>
1.23 wiz 7509: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7510: passwords.</p></li>
1.23 wiz 7511: <li class="listitem"><p>help to configure the package before it is built</p></li>
7512: <li class="listitem"><p>help during the build process</p></li>
7513: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7514: </ul></div>
1.108 rillig 7515: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
7516: variable to define which stages need interaction. This should be
7517: done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1 dsieger 7518: <pre class="programlisting">
7519: INTERACTIVE_STAGE= configure install
1.111 sevan 7520: </pre>
1.1 dsieger 7521: <p>The user can then decide to skip this package by setting the
1.108 rillig 7522: <code class="varname">BATCH</code> variable. Packages that require interaction
7523: are also excluded from bulk builds.</p>
1.1 dsieger 7524: </div>
1.41 asau 7525: <div class="sect2">
1.1 dsieger 7526: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7527: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111 sevan 7528: <p>Authors of software can choose the licence under which software
7529: can be copied. The Free Software Foundation has declared some
7530: licenses "Free", and the Open Source Initiative has a definition of
7531: "Open Source".</p>
7532: <p>By default, pkgsrc allows packages with Free or Open Source
7533: licenses to be built. To allow packages with other licenses to be
7534: built as well, the pkgsrc user needs to add these licenses to the
7535: <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Note
7536: that this variable only affects which packages may be
7537: <span class="emphasis"><em>built</em></span>, while the license terms often also
7538: restrict the actual use of the package and its redistribution.</p>
1.1 dsieger 7539: <p>One might want to only install packages with a BSD license,
1.108 rillig 7540: or the GPL, and not the other. The free licenses are added to the
1.111 sevan 7541: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The pkgsrc
1.19 jnemeth 7542: user can override the default by setting the
7543: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111 sevan 7544: of "+=". The licenses accepted by default are defined in the
7545: <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
7546: <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1 dsieger 7547: <p>The license tag mechanism is intended to address
7548: copyright-related issues surrounding building, installing and
7549: using a package, and not to address redistribution issues (see
7550: <code class="varname">RESTRICTED</code> and
1.111 sevan 7551: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19 jnemeth 7552: Packages with redistribution restrictions should set these
7553: tags.</p>
1.1 dsieger 7554: <p>Denoting that a package may be copied according to a
7555: particular license is done by placing the license in
7556: <code class="filename">pkgsrc/licenses</code> and setting the
7557: <code class="varname">LICENSE</code> variable to a string identifying the
1.207 leot 7558: 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 7559: <pre class="programlisting">
7560: LICENSE= xv-license
1.111 sevan 7561: </pre>
1.1 dsieger 7562: <p>When trying to build, the user will get a notice that the
7563: package is covered by a license which has not been placed in the
7564: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7565: <pre class="programlisting">
7566: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7567: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7568: ===> To view the license, enter "/usr/bin/make show-license".
7569: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7570: ===> ACCEPTABLE_LICENSES+=xv-license
7571: *** Error code 1
1.111 sevan 7572: </pre>
1.10 hubertf 7573: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7574: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7575: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7576: convey to pkgsrc that it should not in the future fail because of
7577: that license:</p>
7578: <pre class="programlisting">
7579: ACCEPTABLE_LICENSES+=xv-license
1.111 sevan 7580: </pre>
7581: <p>The use of <code class="varname">LICENSE=shareware</code>,
7582: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7583: is deprecated because it does not crisply refer to a particular
7584: license text. Another problem with such usage is that it does not
7585: enable a user to tell pkgsrc to proceed for a single package
7586: without also telling pkgsrc to proceed for all packages with that
7587: tag.</p>
7588: <div class="sect3">
7589: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7590: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48 rodent 7591: <p>When adding a package with a new license, the following steps
7592: are required:</p>
7593: <div class="orderedlist"><ol class="orderedlist" type="1">
7594: <li class="listitem">
1.169 rillig 7595: <p>Check whether the license qualifies as Free or Open Source by
7596: referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
7597: Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111 sevan 7598: Open Source Initiative</a>. If this is the case, the filename in
7599: <code class="filename">pkgsrc/licenses/</code> does not need the
7600: <code class="filename">-license</code> suffix, and the license name should be
7601: added to:</p>
1.48 rodent 7602: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 7603: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
7604: <code class="filename">pkgsrc/mk/license.mk</code></p></li>
7605: <li class="listitem"><p>default_acceptable_licenses in
7606: <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48 rodent 7607: </ul></div>
7608: </li>
1.169 rillig 7609: <li class="listitem"><p>The license text should be added to
7610: <code class="filename">pkgsrc/licenses</code> for displaying. A list of known
7611: licenses can be seen in this directory.</p></li>
1.48 rodent 7612: </ol></div>
1.111 sevan 7613: </div>
7614: <div class="sect3">
7615: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 7616: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1 dsieger 7617: <p>When the license changes (in a way other than formatting),
1.111 sevan 7618: make sure that the new license has a different name (e.g.,
1.1 dsieger 7619: append the version number if it exists, or the date). Just
7620: because a user told pkgsrc to build programs under a previous
7621: version of a license does not mean that pkgsrc should build
7622: programs under the new licenses. The higher-level point is that
7623: pkgsrc does not evaluate licenses for reasonableness; the only
7624: test is a mechanistic test of whether a particular text has been
1.111 sevan 7625: approved by either of two bodies (FSF or OSI).</p>
7626: </div>
1.1 dsieger 7627: </div>
1.41 asau 7628: <div class="sect2">
1.1 dsieger 7629: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7630: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1 dsieger 7631: <p>Some licenses restrict how software may be re-distributed.
1.111 sevan 7632: By declaring the restrictions, package tools can
1.1 dsieger 7633: automatically refrain from e.g. placing binary packages on FTP
7634: sites.</p>
1.111 sevan 7635: <p>There are four possible restrictions, which are
1.1 dsieger 7636: the cross product of sources (distfiles) and binaries not being
7637: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7638: language in any license, and because non-Free licenses tend to be
7639: different from each other, pkgsrc adopts a definition of FTP and
1.111 sevan 7640: CD-ROM.
7641:
7642: "FTP" means making the source or binary file available over the
7643: Internet at no charge.
7644:
7645: "CD-ROM" means making the source or binary available on some kind of
7646: media, together with other source and binary packages, which is sold
7647: for a distribution charge.
1.1 dsieger 7648: </p>
7649: <p>In order to encode these restrictions, the package system
7650: defines five make variables that can be set to note these
7651: restrictions:</p>
1.41 asau 7652: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7653: <li class="listitem">
1.1 dsieger 7654: <p><code class="varname">RESTRICTED</code></p>
7655: <p>This variable should be set whenever a restriction
7656: exists (regardless of its kind). Set this variable to a
7657: string containing the reason for the restriction. It should
7658: be understood that those wanting to understand the restriction
7659: will have to read the license, and perhaps seek advice of
7660: counsel.</p>
7661: </li>
1.23 wiz 7662: <li class="listitem">
1.1 dsieger 7663: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7664: <p>Binaries may not be placed on CD-ROM containing other
7665: binary packages, for which a distribution charge may be made.
7666: In this case, set this variable to
7667: <code class="varname">${RESTRICTED}</code>.</p>
7668: </li>
1.23 wiz 7669: <li class="listitem">
1.1 dsieger 7670: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7671: <p>Binaries may not made available on the Internet without
7672: charge. In this case, set this variable to
7673: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7674: binary packages will not be included on ftp.NetBSD.org.</p>
7675: </li>
1.23 wiz 7676: <li class="listitem">
1.1 dsieger 7677: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7678: <p>Distfiles may not be placed on CD-ROM, together with
7679: other distfiles, for which a fee may be charged. In this
7680: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7681: </p>
7682: </li>
1.23 wiz 7683: <li class="listitem">
1.1 dsieger 7684: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7685: <p>Distfiles may not made available via FTP at no charge.
7686: In this case, set this variable to
7687: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7688: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7689: </li>
7690: </ul></div>
1.111 sevan 7691: <p>Please note that packages will be removed from pkgsrc when the
7692: distfiles are not distributable and cannot be obtained for a period
7693: of one full quarter branch. Packages with manual/interactive fetch
7694: must have a maintainer and it is his/her responsibility to ensure
7695: this.</p>
1.1 dsieger 7696: </div>
1.41 asau 7697: <div class="sect2">
1.1 dsieger 7698: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7699: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175 gutterid 7700: <p>Your package may depend on some other package being present,
7701: and there are various ways of expressing this dependency.
7702: pkgsrc supports the <code class="varname">DEPENDS</code>,
7703: <code class="varname">BUILD_DEPENDS</code>,
7704: <code class="varname">TOOL_DEPENDS</code>, and
7705: <code class="varname">TEST_DEPENDS</code> definitions, the
1.1 dsieger 7706: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7707: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7708: to handle dependencies, and which uses the variables named above.
1.184 rillig 7709: 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 7710: <p>The basic difference is that the <code class="varname">DEPENDS</code>
7711: definition registers that pre-requisite in the binary package so it
7712: will be pulled in when the binary package is later installed, whilst
7713: the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7714: and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
7715: dependency that is only needed for building or testing the resulting
1.184 rillig 7716: 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 7717: <p>This means that if you only need a package present whilst
1.175 gutterid 7718: you are building or testing, it should be noted as a
7719: <code class="varname">TOOL_DEPENDS</code>,
7720: <code class="varname">BUILD_DEPENDS</code>, or
7721: <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
1.156 leot 7722: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
7723: packages, i.e. packages for the architecture where the package
7724: is built;
7725: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175 gutterid 7726: packages, i.e., packages for the architecture for which the package
1.156 leot 7727: is built.</p>
1.175 gutterid 7728: <p>The format for a <code class="varname">DEPENDS</code>,
7729: <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
7730: and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1 dsieger 7731: <pre class="programlisting">
7732: <pre-req-package-name>:../../<category>/<pre-req-package>
1.111 sevan 7733: </pre>
1.23 wiz 7734: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7735: may include any of the wildcard version numbers recognized by
1.246 leot 7736: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7737: <div class="orderedlist"><ol class="orderedlist" type="1">
7738: <li class="listitem">
1.1 dsieger 7739: <p>If your package needs another package's binaries or
1.54 wiz 7740: libraries to build and run, and if that package has a
1.1 dsieger 7741: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7742: <pre class="programlisting">
7743: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7744: </pre>
1.1 dsieger 7745: </li>
1.23 wiz 7746: <li class="listitem">
1.54 wiz 7747: <p>If your package needs another package's binaries or
7748: libraries only for building, and if that package has a
7749: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7750: <pre class="programlisting">
7751: .include "../../graphics/jpeg/buildlink3.mk"
1.111 sevan 7752: </pre>
1.54 wiz 7753: <p>but set
7754: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
7755: to make it a build dependency only. This case is rather
7756: rare.</p>
7757: </li>
7758: <li class="listitem">
1.25 spz 7759: <p>If your package needs binaries from another package to build,
1.156 leot 7760: use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1 dsieger 7761: <pre class="programlisting">
1.156 leot 7762: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111 sevan 7763: </pre>
1.1 dsieger 7764: </li>
1.156 leot 7765: <li class="listitem"><p>If your package needs static libraries to link against, header
7766: files to include, etc. from another package to build,
7767: use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25 spz 7768: <li class="listitem"><p>If your package needs a library with which to link and
7769: there is no <code class="filename">buildlink3.mk</code> file
7770: available, create one. Using
7771: <code class="varname">DEPENDS</code> won't be sufficient because the
7772: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 7773: <li class="listitem">
1.25 spz 7774: <p>If your package needs some executable to be able to run
7775: correctly and if there's no
7776: <code class="filename">buildlink3.mk</code> file, this is specified
7777: using the <code class="varname">DEPENDS</code> variable. The
1.207 leot 7778: <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 7779: be able to execute the latex binary from the tex-latex-bin package
1.25 spz 7780: when it runs, and that is specified:</p>
1.1 dsieger 7781: <pre class="programlisting">
1.129 wiz 7782: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111 sevan 7783: </pre>
1.25 spz 7784: </li>
1.175 gutterid 7785: <li class="listitem"><p>If your package includes a test suite that has extra
7786: dependencies only required for this purpose (frequently this
7787: can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
7788: <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25 spz 7789: <li class="listitem">
7790: <p>You can use wildcards in package dependencies. Note that
7791: such wildcard dependencies are retained when creating binary
7792: packages. The dependency is checked when installing the binary
7793: package and any package which matches the pattern will be
7794: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 7795: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
7796: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
7797: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
7798: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 7799: <p>Wildcards can also be used to specify that a package
7800: will only build against a certain minimum version of a
7801: pre-requisite:</p>
7802: <pre class="programlisting">
1.25 spz 7803: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.111 sevan 7804: </pre>
1.25 spz 7805: <p>This means that the package will build using version 6.0
7806: of ImageMagick or newer. Such a dependency may be warranted
7807: if, for example, the command line options of an executable
7808: have changed.</p>
7809: <p>If you need to depend on minimum versions of libraries,
1.183 wiz 7810: set
7811: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
7812: to the appropriate pattern before including its
7813: <code class="filename">buildlink3.mk</code> file, e.g.</p>
7814: <pre class="programlisting">
7815: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
7816: .include "../../graphics/jpeg/buildlink3.mk"
7817: </pre>
1.1 dsieger 7818: <p>For security fixes, please update the package
1.154 rillig 7819: 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 7820: information.</p>
7821: </li>
7822: </ol></div>
7823: <p>If your package needs files from another package to build,
7824: add the relevant distribution files to
7825: <code class="varname">DISTFILES</code>, so they will be extracted
1.207 leot 7826: 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 7827: (It relies on the jpeg sources being present in source form
7828: during the build.)</p>
7829: </div>
1.41 asau 7830: <div class="sect2">
1.1 dsieger 7831: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7832: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.226 gutterid 7833: <p>Your package may conflict with other packages users might
7834: already have installed on their system, e.g., if your package
1.1 dsieger 7835: installs the same set of files as another package in the pkgsrc
1.227 wiz 7836: tree.</p>
1.207 leot 7837: <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>
7838: 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 7839: install the same shared library, thus you set in
7840: <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
7841: <pre class="programlisting">
7842: CONFLICTS= Xaw-Xpm-[0-9]*
1.238 wiz 7843: </pre>
1.142 leot 7844: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7845: <pre class="programlisting">
7846: CONFLICTS= libXaw3d-[0-9]*
1.238 wiz 7847: </pre>
1.246 leot 7848: <p><a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 7849: that conflict with existing packages and abort. However, in many
7850: situations this is too late in the process. Binary package managers
7851: will not know about the conflict until they attempt to install the
7852: package after already downloading it and all its dependencies.
7853: Users may also waste time building a package and its dependencies
7854: only to find out at the end that it conflicts with another package
7855: they have installed.</p>
7856: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
7857: should be added in all cases where it is known that packages conflict
7858: with each other. These <code class="varname">CONFLICTS</code> entries are
1.246 leot 7859: exported in <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.142 leot 7860: managers to inform users that packages cannot be installed onto
7861: the target system.</p>
1.1 dsieger 7862: </div>
1.41 asau 7863: <div class="sect2">
1.1 dsieger 7864: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7865: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7866: <p>There are several reasons why a package might be
7867: instructed to not build under certain circumstances. If the
7868: package builds and runs on most platforms, the exceptions
1.83 dholland 7869: should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>. If
7870: the package builds and runs on a small handful of platforms,
7871: set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
7872: Both <code class="varname">BROKEN_ON_PLATFORM</code> and
7873: <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
7874: (OS-version-platform) that can use glob-style
7875: wildcards.</p>
7876: <p>If a package is not appropriate for some platforms (as
1.114 maya 7877: opposed to merely broken), a different set of variables should be
1.83 dholland 7878: used as this affects failure reporting and statistics.
7879: If the package is appropriate for most platforms, the exceptions
1.1 dsieger 7880: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
1.83 dholland 7881: the package is appropriate for only a small handful of platforms
7882: (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1 dsieger 7883: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7884: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7885: (OS-version-platform) that can use glob-style
7886: wildcards.</p>
7887: <p>Some packages are tightly bound to a specific version of an
1.207 leot 7888: 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 7889: backwards compatible with other versions of the OS, and should be
7890: uploaded to a version specific directory on the FTP server. Mark
7891: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 7892: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 7893: the package system internals, but may be used in the
7894: future.</p>
7895: <p>If the package should be skipped (for example, because it
7896: provides functionality already provided by the system), set
7897: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7898: the package should fail because some preconditions are not met,
7899: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7900: message.</p>
7901: </div>
1.41 asau 7902: <div class="sect2">
1.1 dsieger 7903: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7904: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7905: <p>To ensure that a package may not be deleted, once it has been
7906: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7907: be set in the package Makefile. This will be carried into any
7908: binary package that is made from this pkgsrc entry. A
1.23 wiz 7909: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.246 leot 7910: not be deleted using <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 7911: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 7912: </div>
1.41 asau 7913: <div class="sect2">
1.1 dsieger 7914: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7915: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 7916: <p>When a vulnerability is found, this should be noted in
1.247 wiz 7917: <code class="filename">pkgsrc/doc/pkg-vulnerabilities</code>.
1.205 wiz 7918: Entries in that file consist of three parts:</p>
7919: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
7920: <li class="listitem"><p>package version pattern</p></li>
7921: <li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
7922: <li class="listitem"><p>URL providing additional information about the issue</p></li>
7923: </ul></div>
7924: <p>For the package version pattern please always use `<' to
7925: mark an upper bound (not `<='!). This will avoid possible
7926: problems due unrelated <code class="varname">PKGREVISION</code> bumps not
7927: related to security fixes. Lower bounds can be added too, using
7928: '>' or '>='. For example,
1.206 wiz 7929: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.2</code></span>”</span> would mark
1.205 wiz 7930: versions 1.0 (included) to 1.2 (excluded) of
7931: <span class="quote">“<span class="quote"><code class="literal">foo</code></span>”</span> as affected by the security
7932: issue.</p>
7933: <p>Entries should always be added at the bottom of the file.</p>
7934: <p>When fixing packages, please modify the upper bound of the
7935: corresponding entry. To continue the previous example, if a fix
7936: was backported to version 1.1nb2, change the previous pattern to
1.206 wiz 7937: <span class="quote">“<span class="quote"><code class="literal">foo>=1<1.1nb2</code></span>”</span>.</p>
1.205 wiz 7938: <p>To locally test a package version pattern against a
7939: <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
7940: pmatch</strong></span> command.</p>
7941: <p>The URL should be as permanent as possible and provide as
7942: much information about the issue as possible. CVE entries are
7943: preferred.</p>
7944: <p>After committing that file, ask pkgsrc-security@NetBSD.org to
1.31 wiz 7945: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 7946: <p>After fixing the vulnerability by a patch, its
1.31 wiz 7947: <code class="varname">PKGREVISION</code> should be increased (this is of
7948: course not necessary if the problem is fixed by using a newer
7949: release of the software), and the pattern in the
7950: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 7951: <p>Also, if the fix should be applied to the stable pkgsrc
7952: branch, be sure to submit a pullup request!</p>
7953: <p>Binary packages already on ftp.NetBSD.org will be handled
7954: semi-automatically by a weekly cron job.</p>
1.205 wiz 7955: <p>In case a security issue is disputed, please contact
7956: pkgsrc-security@NetBSD.org.</p>
1.1 dsieger 7957: </div>
1.41 asau 7958: <div class="sect2">
1.1 dsieger 7959: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 7960: <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 7961: <p>When making fixes to an existing package it can be useful
7962: to change the version number in <code class="varname">PKGNAME</code>. To
7963: avoid conflicting with future versions by the original author, a
1.23 wiz 7964: <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 7965: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 7966: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
7967: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 7968: <pre class="programlisting">
7969: DISTNAME= foo-17.42
7970: PKGREVISION= 9
1.111 sevan 7971: </pre>
1.1 dsieger 7972: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 7973: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
7974: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 7975: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
7976: <code class="varname">PKGNAME_NOREV</code>.</p>
7977: <p>When a new release of the package is released, the
7978: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
7979: minor release of the above package, things should be like:</p>
7980: <pre class="programlisting">
7981: DISTNAME= foo-17.43
1.111 sevan 7982: </pre>
1.1 dsieger 7983: <p><code class="varname">PKGREVISION</code> should be incremented for any
7984: non-trivial change in the resulting binary package. Without a
7985: <code class="varname">PKGREVISION</code> bump, someone with the previous
7986: version installed has no way of knowing that their package is out
7987: of date. Thus, changes without increasing
7988: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
7989: trivial that no reasonable person would want to upgrade", and this
7990: is the rough test for when increasing
7991: <code class="varname">PKGREVISION</code> is appropriate. Examples of
7992: changes that do not merit increasing
7993: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 7994: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7995: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169 rillig 7996: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
7997: comments in Makefile.</p></li>
7998: <li class="listitem"><p>Changing build variables if the resulting binary
7999: package is the same.</p></li>
8000: <li class="listitem"><p>Changing
8001: <code class="filename">DESCR</code>.</p></li>
8002: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
8003: default options don't change.</p></li>
1.1 dsieger 8004: </ul></div>
8005: <p>Examples of changes that do merit an increase to
8006: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 8007: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169 rillig 8008: <li class="listitem"><p>Security fixes</p></li>
8009: <li class="listitem"><p>Changes or additions to a patch
8010: file</p></li>
8011: <li class="listitem"><p>Changes to the
8012: <code class="filename">PLIST</code></p></li>
8013: <li class="listitem"><p>A dependency is changed or
8014: renamed.</p></li>
1.1 dsieger 8015: </ul></div>
8016: <p>PKGREVISION must also be incremented when dependencies have ABI
8017: changes.</p>
8018: </div>
1.41 asau 8019: <div class="sect2">
1.1 dsieger 8020: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8021: <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 8022: <p>When you want to replace the same text in multiple files, or
8023: multiple times in the same file, it is cumbersome to maintain a patch
8024: file for this. This is where the SUBST framework steps in. It provides an
8025: easy-to-use interface for replacing text in files. It just needs the
8026: following information:</p>
8027: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8028: <li class="listitem"><p>In which phase of the package build cycle should the
8029: replacement happen?</p></li>
8030: <li class="listitem"><p>In which files should the replacement
1.172 rillig 8031: happen?</p></li>
1.180 rillig 8032: <li class="listitem"><p>Which text should be replaced with
8033: what?</p></li>
1.172 rillig 8034: </ul></div>
8035: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180 rillig 8036: variables. A minimal example is:</p>
8037: <pre class="programlisting">
8038: SUBST_CLASSES+= paths
8039: SUBST_STAGE.paths= pre-configure
8040: SUBST_FILES.paths= src/*.c
8041: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
8042: </pre>
8043: <p>Translated into English, it means: In the pre-configure stage (that
8044: is, after applying the patches from the patches/ directory and before
8045: running the configure script and the portability check), replace the text
8046: <code class="literal">/usr/local</code> with the content of the variable
8047: <code class="varname">PREFIX</code>.</p>
8048: <p>Each SUBST block starts by appending an identifier to
8049: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
8050: identifier can be chosen freely by the package. If there should ever be
8051: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
8052: early, so don't worry about name collisions.</p>
8053: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
8054: SUBST block are parameterized using this identifier. In the remainder of
8055: this section, these parameterized variables are written as
8056: <code class="varname">SUBST_STAGE.*</code>.</p>
8057: <pre class="programlisting">
8058: SUBST_CLASSES+= paths
8059: SUBST_STAGE.paths= pre-configure
8060: SUBST_MESSAGE.paths= Fixing absolute paths.
8061: SUBST_FILES.paths= src/*.c
8062: SUBST_FILES.paths+= scripts/*.sh
8063: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
8064: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8065: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
8066: </pre>
8067: <p>To get a complete picture about the SUBST substitutions, run
8068: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
8069: expected, run pkglint on the package, which detects several typical
8070: mistakes surrounding the SUBST blocks. For any questions that might
8071: remain after this, have a look at
8072: <code class="filename">mk/subst.mk</code>.</p>
8073: <div class="sect3">
8074: <div class="titlepage"><div><div><h4 class="title">
8075: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
8076: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
8077: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
8078: <code class="literal">pre-configure</code> is used most often, by far. The most
8079: popular stages are, in chronological order:</p>
8080: <div class="variablelist"><dl class="variablelist">
8081: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
8082: <dd>
8083: <p>The substitutions are applied immediately after the
8084: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
8085: package will leave no traces of the original files.</p>
8086: <p>When the substitution applies to files for which there is also a
8087: patch in the <code class="filename">patches/</code> directory, this means that the
8088: patches will be computed based on the result of the substitution. When
8089: these patches are sent to the upstream maintainer later, to be fixed in
8090: the upstream package, these patches may no longer match what the upstream
8091: author is used to. Because of this, <code class="literal">pre-configure</code> is
8092: often a better choice.</p>
8093: </dd>
8094: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
8095: <dd>
8096: <p>The substitutions are applied after the patches from the
8097: <code class="filename">patches/</code> directory. This makes it possible to run
8098: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
1.207 leot 8099: 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 8100: <p>When updating the patches, it is helpful to explicitly separate the
8101: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
8102: configure</strong></span>, and to only edit the patches between these commands.
8103: Otherwise the substitutions from the SUBST block will end up in the patch
8104: file. When this happens in really obvious ways, pkglint will complain
8105: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
8106: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
8107: can only detect these really obvious
8108: cases.</p>
8109: </dd>
8110: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
8111: <dd><p>This stage should only be used if the package defines a
8112: <code class="literal">pre-configure</code> action itself, and the substitution must
8113: happen after that. Typical examples are packages that use the
8114: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
8115: script from
8116: <code class="filename">configure.ac</code>.</p></dd>
8117: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
8118: <dd><p>This stage is used to fix up any mistakes by the
8119: configure stage.</p></dd>
8120: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
8121: <dd><p>This stage should only be used for substitutions that are
8122: clearly related to building the package, not for fixing the
8123: configuration. Substitutions for pathnames (such as replacing
8124: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
8125: user names (such as replacing <code class="literal">@MY_USER@</code> with the
8126: actual username) belong in pre-configure or post-configure
8127: instead.</p></dd>
8128: <dt><span class="term"><code class="literal">post-build</code></span></dt>
8129: <dd>
8130: <p>Just as with pre-build, this stage should only be used
8131: for substitutions that are clearly related to building the package, not
8132: for fixing the configuration. Substitutions for pathnames (such as
8133: replacing <code class="filename">/usr/local</code> with
8134: <code class="literal">${PREFIX}</code>) or user names (such as replacing
8135: <code class="literal">@MY_USER@</code> with the actual username) belong in
8136: pre-configure or post-configure instead.</p>
8137: <p>A typical use is to update pkg-config files to include the rpath
8138: compiler options.</p>
8139: </dd>
8140: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
8141: <dd><p>In general, the install phase should be as simple as
8142: possible. As with the pre-build and post-build stages, it should not be
8143: used to fix pathnames or user names, these belong in pre-configure
8144: instead. There are only few legitimate use cases for applying
8145: substitutions in this stage.</p></dd>
8146: </dl></div>
8147: </div>
8148: <div class="sect3">
8149: <div class="titlepage"><div><div><h4 class="title">
1.181 rillig 8150: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180 rillig 8151: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
8152: filename patterns. These patterns are relative to
8153: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
8154: A typical example is:</p>
8155: <pre class="programlisting">
8156: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
8157: </pre>
8158: <p>The above patterns, especially the last, are quite broad. The SUBST
8159: implementation checks that each filename pattern that is mentioned here
8160: has an effect. For example, if none of the
8161: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
8162: and substituted, that filename pattern is redundant and should be left
1.181 rillig 8163: out. By default, the SUBST framework will complain with an error message.
8164: If the text to be substituted occurs in some of the files from a single
8165: pattern, but not in all of them, that is totally ok, and the SUBST
1.180 rillig 8166: framework will only print an INFO message for those files.</p>
8167: <p>If there is a good reason for having redundant filename patterns,
1.181 rillig 8168: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180 rillig 8169: <p>Another popular way of choosing the files for the substitutions is
8170: via a shell command, like this:</p>
8171: <pre class="programlisting">
1.181 rillig 8172: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 8173: SUBST_FILES.path= ${C_FILES_CMD:sh}
8174: </pre>
8175: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
8176: freely chosen and independent of the SUBST framework.</p>
8177: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
8178: lists each file individually. Thereby chances are higher that there are
8179: filename patterns in which no substitution happens. Since the SUBST
8180: framework cannot know whether the filename patterns in
8181: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
8182: Makefile (where any redundant filename pattern would be suspicious) or
8183: been generated by a shell command (in which redundant filename patterns
8184: are more likely and to be expected), it will complain about these
8185: redundant filename patterns. Therefore, SUBST blocks that use a shell
8186: command to generate the list of filename patterns often need to set
8187: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
8188: </div>
8189: <div class="sect3">
8190: <div class="titlepage"><div><div><h4 class="title">
8191: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
8192: <p>In most cases, the substitutions are given using one or more
1.246 leot 8193: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.180 rillig 8194: <pre class="programlisting">
8195: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
8196: </pre>
8197: <p>Each of the sed commands needs to be preceded by the
8198: <code class="literal">-e</code> option and should be specified on a line of its
8199: own, to avoid hiding short sed commands at the end of a line.</p>
8200: <p>Since the sed commands often contain shell metacharacters as the
8201: separator (the <code class="literal">|</code> in the above example), it is common
8202: to enclose them in single quotes.</p>
8203: <p>A common substitution is to replace placeholders of the form
8204: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
8205: <code class="literal">${VARNAME}</code>. A typical example is:</p>
8206: <pre class="programlisting">
8207: SUBST_VARS.path= PREFIX
8208: </pre>
8209: <p>This type of substitutions is typically done by the GNU configure
1.181 rillig 8210: scripts during the do-configure stage, but in some cases these need to be
8211: overridden. The same pattern is also used when a package defines patches
8212: that replace previously hard-coded paths like
8213: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
8214: placeholder first, which then gets substituted by the actual
8215: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
8216: cases, it works equally well to just use the SUBST framework to directly
8217: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
8218: thereby omitting the intermediate patch file.</p>
1.180 rillig 8219: <p>If the above is not flexible enough, it is possible to not use sed
8220: at all for the substitution but to specify an entirely different command,
8221: like this:</p>
1.1 dsieger 8222: <pre class="programlisting">
1.180 rillig 8223: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
8224: </pre>
8225: <p>This is used for the few remaining packages in which the
8226: distributed files use Windows-style line endings that need to be
8227: converted to UNIX-style line endings.</p>
8228: </div>
8229: <div class="sect3">
8230: <div class="titlepage"><div><div><h4 class="title">
8231: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
8232: <p>When a SUBST block is applied during a package build, a message is
8233: logged. The default message is fine for most purposes but can be
8234: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
8235: message.</p>
8236: </div>
1.1 dsieger 8237: </div>
8238: </div>
1.41 asau 8239: <div class="sect1">
1.1 dsieger 8240: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8241: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8242: <div class="sect2">
1.1 dsieger 8243: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8244: <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 8245: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8246: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8247: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8248: with the name of each file to download as an argument, expecting
8249: it to output the URL of the directory from which to download
1.207 leot 8250: 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 8251: example of this usage.</p>
8252: <p>If the download can't be automated, because the user must
8253: submit personal information to apply for a password, or must pay
8254: for the source, or whatever, you can set
8255: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8256: displayed to the user before aborting the build. Example:</p>
8257: <pre class="programlisting">
8258: FETCH_MESSAGE= "Please download the files"
8259: FETCH_MESSAGE+= " "${DISTFILES:Q}
8260: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111 sevan 8261: </pre>
1.1 dsieger 8262: </div>
1.41 asau 8263: <div class="sect2">
1.1 dsieger 8264: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8265: <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 8266: <p>Sometimes authors of a software package make some
8267: modifications after the software was released, and they put up a
8268: new distfile without changing the package's version number. If a
8269: package is already in pkgsrc at that time, the checksum will
8270: no longer match. The contents of the new distfile should be
8271: compared against the old one before changing anything, to make
8272: sure the distfile was really updated on purpose, and that
8273: no trojan horse or so crept in.
8274: Please mention that the distfiles were compared and what was found
1.53 rodent 8275: in your commit message.</p>
1.109 wiz 8276: <p>Then, the correct way to work around this is to set
8277: <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
8278: based on <code class="varname">PKGNAME_NOREV</code> (but take care with
8279: python or ruby packages, where <code class="varname">PKGNAME</code> includes
8280: a variable prefix). All <code class="varname">DISTFILES</code> and
1.1 dsieger 8281: <code class="varname">PATCHFILES</code> for this package will be put in that
1.154 rillig 8282: 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 8283: happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109 wiz 8284: including the <code class="filename">nbX</code> suffix) or a date stamp can
8285: be appended, like
8286: <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169 rillig 8287: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
8288: name does not contain a version and the distfile is apt to change. In
8289: cases where the likelihood of this is very small,
8290: <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
8291: <code class="varname">DIST_SUBDIR</code> must not be removed unless the
8292: distfile name changes, even if a package is being moved or
8293: renamed.</p>
1.53 rodent 8294: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8295: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8296: path in the filenames.
1.53 rodent 8297: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8298: Furthermore, a mail to the package's authors seems appropriate
8299: telling them that changing distfiles after releases without
8300: changing the file names is not good practice.</p>
8301: </div>
1.88 tnn 8302: <div class="sect2">
8303: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8304: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169 rillig 8305: <p>Helper methods exist for packages hosted on github.com which
8306: will often have distfile names that clash with other packages, for
8307: example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
8308: from below:</p>
1.88 tnn 8309: <div class="sect3">
8310: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8311: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169 rillig 8312: <p>If your distfile URL looks similar to
1.189 bacon 8313: <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169 rillig 8314: then you are packaging a tagged release.</p>
1.88 tnn 8315: <pre class="programlisting">
1.189 bacon 8316: DISTNAME= example-1.0
1.90 tnn 8317: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8318: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8319: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 8320: EXTRACT_SUFX= .zip
8321: </pre>
1.230 gutterid 8322: <p>Here, DISTNAME combined with use of GITHUB_TAG leads the
8323: file fetching infrastructure to save the resulting file locally as
8324: <code class="literal">example-1.0.zip</code>.</p>
1.88 tnn 8325: </div>
8326: <div class="sect3">
8327: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8328: <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>
8329: <p>If your distfile looks similar to
8330: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
8331: release, then set the package version to 0.0.0.N, where N is the number
8332: of commits to the repository, and set GITHUB_TAG to the commit hash.
8333: This will (almost) ensure that the first tagged release will have a
8334: version greater than this one so that package upgrades will function
8335: properly.</p>
8336: <pre class="programlisting">
8337: DISTNAME= example-0.0.0.347
8338: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8339: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
8340: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
8341: </pre>
8342: </div>
8343: <div class="sect3">
8344: <div class="titlepage"><div><div><h4 class="title">
8345: <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>
8346: <p>If your distfile looks similar to
8347: <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
8348: then include the last release version and the commit count since that
8349: release in the package version and set GITHUB_TAG to the commit hash.
8350: The latest release and commit count are shown in the output of
8351: "git describe --tags":
8352: </p>
8353: <pre class="screen">
8354: # git clone https://github.com/username/example
8355: # cd example
8356: # git describe --tags
8357: 1.2.3-5-g988881a
8358: </pre>
1.88 tnn 8359: <pre class="programlisting">
1.189 bacon 8360: DISTNAME= example-1.2.3.5
8361: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
8362: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 8363: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111 sevan 8364: </pre>
1.88 tnn 8365: </div>
8366: <div class="sect3">
8367: <div class="titlepage"><div><div><h4 class="title">
1.189 bacon 8368: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169 rillig 8369: <p>If your distfile URL looks similar to
1.189 bacon 8370: <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169 rillig 8371: then you are packaging a release.</p>
1.88 tnn 8372: <pre class="programlisting">
8373: DISTNAME= offensive-1.6
1.90 tnn 8374: PKGNAME= ${DISTNAME:S/offensive/proper/}
8375: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 8376: GITHUB_PROJECT= example
1.90 tnn 8377: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
8378: EXTRACT_SUFX= .zip
1.111 sevan 8379: </pre>
1.88 tnn 8380: </div>
8381: </div>
1.1 dsieger 8382: </div>
1.41 asau 8383: <div class="sect1">
1.1 dsieger 8384: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8385: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8386: <div class="sect2">
1.1 dsieger 8387: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8388: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8389: <p>pkgsrc supports many different machines, with different
8390: object formats like a.out and ELF, and varying abilities to do
8391: shared library and dynamic loading at all. To accompany this,
8392: varying commands and options have to be passed to the
8393: compiler, linker, etc. to get the Right Thing, which can be
8394: pretty annoying especially if you don't have all the machines
8395: at your hand to test things. The
1.207 leot 8396: <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 8397: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8398: both static and dynamic libraries from a set of source files,
8399: thus being platform-independent.</p>
8400: <p>Here's how to use libtool in a package in seven simple
8401: steps:</p>
1.23 wiz 8402: <div class="orderedlist"><ol class="orderedlist" type="1">
8403: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8404: Makefile.</p></li>
1.23 wiz 8405: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8406: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8407: add it to the definition of <code class="varname">CC</code>, if only
8408: libraries are being built in a given Makefile. This one command
8409: will build both PIC and non-PIC library objects, so you need not
8410: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8411: <li class="listitem">
1.1 dsieger 8412: <p>For the linking of the library, remove any
1.23 wiz 8413: <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
8414: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8415: <pre class="programlisting">
8416: ${LIBTOOL} --mode=link \
8417: ${CC} -o ${.TARGET:.a=.la} \
8418: ${OBJS:.o=.lo} \
8419: -rpath ${PREFIX}/lib \
8420: -version-info major:minor
1.111 sevan 8421: </pre>
1.1 dsieger 8422: <p>Note that the library is changed to have a
8423: <code class="filename">.la</code> extension, and the objects are
8424: changed to have a <code class="filename">.lo</code>
8425: extension. Change <code class="varname">OBJS</code> as
8426: necessary. This automatically creates all of the
8427: <code class="filename">.a</code>,
8428: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8429: necessary) in the build directory. Be sure to include
1.23 wiz 8430: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8431: minor are zero, as libtool will otherwise strip off the
8432: shared library version.</p>
8433: <p>From the libtool manual:</p>
8434: <pre class="programlisting">
8435: So, libtool library versions are described by three integers:
8436:
8437: CURRENT
8438: The most recent interface number that this library implements.
8439:
8440: REVISION
8441: The implementation number of the CURRENT interface.
8442:
8443: AGE
8444: The difference between the newest and oldest interfaces that
8445: this library implements. In other words, the library implements
8446: all the interface numbers in the range from number `CURRENT -
8447: AGE' to `CURRENT'.
8448:
8449: If two libraries have identical CURRENT and AGE numbers, then the
8450: dynamic linker chooses the library with the greater REVISION number.
1.111 sevan 8451: </pre>
1.23 wiz 8452: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8453: different results for a.out and ELF (excluding symlinks)
8454: in only one case. An ELF library of the form
1.23 wiz 8455: <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 8456: will have a symlink of
1.23 wiz 8457: <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 8458: on an a.out platform. This is handled
8459: automatically.</p>
1.23 wiz 8460: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8461: directory of the library being built.</p>
8462: <p>In the <code class="filename">PLIST</code>, include only the
8463: <code class="filename">.la</code> file, the other files will be
8464: added automatically.</p>
8465: </li>
1.23 wiz 8466: <li class="listitem">
1.1 dsieger 8467: <p>When linking shared object (<code class="filename">.so</code>)
1.246 leot 8468: files, i.e. files that are loaded via <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 8469: shared libraries, use <span class="quote">“<span class="quote">-module
8470: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8471: tacked on.</p>
8472: <p>The <code class="filename">PLIST</code> file gets the
8473: <code class="filename">foo.so</code> entry.</p>
8474: </li>
1.23 wiz 8475: <li class="listitem">
1.1 dsieger 8476: <p>When linking programs that depend on these libraries
8477: <span class="emphasis"><em>before</em></span> they are installed, preface
1.246 leot 8478: the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 8479: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8480: libraries (static or shared), but please be aware that
8481: libtool will not allow you to specify a relative path in
1.23 wiz 8482: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8483: expects you to change that argument to be the
8484: <code class="filename">.la</code> file. e.g.</p>
8485: <pre class="programlisting">
8486: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111 sevan 8487: </pre>
1.1 dsieger 8488: <p>should be changed to:</p>
8489: <pre class="programlisting">
8490: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111 sevan 8491: </pre>
1.1 dsieger 8492: <p>and it will do the right thing with the libraries.</p>
8493: </li>
1.23 wiz 8494: <li class="listitem">
1.246 leot 8495: <p>When installing libraries, preface the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8496: or <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 8497: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8498: <code class="filename">.la</code>. e.g.</p>
8499: <pre class="programlisting">
1.22 jakllsch 8500: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111 sevan 8501: </pre>
1.1 dsieger 8502: <p>This will install the static <code class="filename">.a</code>,
8503: shared library, any needed symlinks, and run
1.246 leot 8504: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 8505: </li>
1.23 wiz 8506: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8507: the <code class="filename">.la</code>
8508: file (this is a change from previous behaviour).</p></li>
8509: </ol></div>
8510: </div>
1.41 asau 8511: <div class="sect2">
1.1 dsieger 8512: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8513: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8514: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8515: package Makefile. This will override the package's own libtool
8516: in most cases. For older libtool using packages, libtool is
8517: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8518: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8519: configure; find work*/ -name libtool</strong></span>.</p>
8520: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8521: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8522: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8523: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8524: package's libtool script(s), set it as appropriate.</p>
8525: <p>If you do not need <code class="filename">*.a</code> static
8526: libraries built and installed, then use
8527: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8528: <p>If your package makes use of the platform-independent library
8529: for loading dynamic shared objects, that comes with libtool
8530: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8531: <p>Some packages use libtool incorrectly so that the package
8532: may not work or build in some circumstances. Some of the more
8533: common errors are:</p>
1.41 asau 8534: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8535: <li class="listitem">
1.1 dsieger 8536: <p>The inclusion of a shared object (-module) as a dependent library in an
8537: executable or library. This in itself isn't a problem if one of two things
8538: has been done:</p>
1.23 wiz 8539: <div class="orderedlist"><ol class="orderedlist" type="1">
8540: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8541: <code class="filename">libfoo.la</code>, not
8542: <code class="filename">foo.la</code></p></li>
1.23 wiz 8543: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8544: </ol></div>
8545: </li>
1.23 wiz 8546: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8547: The function lt_dlinit() should be called and the macro
8548: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8549: executables.</p></li>
8550: </ul></div>
8551: </div>
1.41 asau 8552: <div class="sect2">
1.1 dsieger 8553: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8554: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8555: <p>If a package needs GNU autoconf or automake to be executed
1.223 nia 8556: to regenerate the
8557: <code class="filename">configure</code>
8558: script and <code class="filename">Makefile.in</code> makefile
8559: templates from <code class="filename">configure.ac</code> and
8560: <code class="filename">Makefile.am</code>,
8561: then they should be executed in a pre-configure target:</p>
1.1 dsieger 8562: <pre class="programlisting">
1.223 nia 8563: USE_TOOLS+= autoconf automake autoreconf
8564: GNU_CONFIGURE= yes
1.1 dsieger 8565: ...
8566:
8567: pre-configure:
1.223 nia 8568: set -e; cd ${WRKSRC} && autoreconf -fi
1.1 dsieger 8569: ...
1.111 sevan 8570: </pre>
1.223 nia 8571: <p>Packages which use GNU Automake will sometimes
8572: require GNU Make (<code class="literal">gmake</code> in
8573: <code class="varname">USE_TOOLS</code>),
8574: but not always. Note that autoreconf
8575: only needs to be executed if <code class="filename">configure.ac</code>
8576: or Makefiles are modified, or <code class="filename">configure</code>
8577: is not present.</p>
1.1 dsieger 8578: <p>There are times when the configure process makes
8579: additional changes to the generated files, which then causes
8580: the build process to try to re-execute the automake sequence.
8581: This is prevented by touching various files in the configure
8582: stage. If this causes problems with your package you can set
8583: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8584: Makefile.</p>
8585: </div>
1.223 nia 8586: <div class="sect2">
8587: <div class="titlepage"><div><div><h3 class="title">
8588: <a name="meson"></a>21.3.4. Meson / ninja</h3></div></div></div>
8589: <p>Packages using Meson to configure need to include:
8590:
8591: </p>
8592: <pre class="programlisting">
8593: .include "../../devel/meson/build.mk"
8594: </pre>
8595: <p>In nearly all cases (any program with dependencies),
8596: pkg-config needs to be added to
8597: <code class="varname">USE_TOOLS</code>. If the package installs
8598: translation files for non-English languages, also
8599: add msgfmt and xgettext:
8600:
8601: </p>
8602: <pre class="programlisting">
8603: USE_TOOLS+= pkg-config msgfmt xgettext
8604: </pre>
8605: <p>If any options need to be passed to Meson, use
8606: <code class="varname">MESON_ARGS</code> instead of
8607: <code class="varname">CONFIGURE_ARGS</code>:
8608:
8609: </p>
8610: <pre class="programlisting">
8611: MESON_ARGS+= -Dx11=false
8612: </pre>
8613: </div>
1.1 dsieger 8614: </div>
1.41 asau 8615: <div class="sect1">
1.1 dsieger 8616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8617: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41 asau 8618: <div class="sect2">
1.1 dsieger 8619: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8620: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.244 gutterid 8621: <p>Compilers for the C and C++ languages come with
1.1 dsieger 8622: the NetBSD base system. By default, pkgsrc assumes that a package
8623: is written in C and will hide all other compilers (via the wrapper
1.184 rillig 8624: framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.243 gutterid 8625: <p>To declare which languages should be made available through
8626: pkgsrc's compiler wrappers, use
1.1 dsieger 8627: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.212 wiz 8628: currently are:
1.238 wiz 8629: </p>
1.212 wiz 8630: <pre class="programlisting">
1.244 gutterid 8631: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.238 wiz 8632: </pre>
1.212 wiz 8633: <p>
8634: (and any combination). The default is
1.23 wiz 8635: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8636: written in C++, usually need a C compiler for the configure
1.244 gutterid 8637: phase.</p>
1.250 jnemeth 8638: <p>To declare which features a package requires from the
1.243 gutterid 8639: compiler, set either <code class="varname">USE_CC_FEATURES</code>
8640: or <code class="varname">USE_CXX_FEATURES</code>. Allowed values for
8641: <code class="varname">USE_CC_FEATURES</code> are currently:
8642: </p>
8643: <pre class="programlisting">
8644: c11, c99, has_include
8645: </pre>
8646: <p>
8647: Allowed values for <code class="varname">USE_CXX_FEATURES</code> are
8648: currently:
8649: </p>
8650: <pre class="programlisting">
8651: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
8652: charconv, parallelism_ts, unique_ptr, put_time,
8653: is_trivially_copy_constructible
8654: </pre>
8655: <p>
1.251 gutterid 8656: Note at present these variables only affect use of GCC, not other
8657: compilers.
1.243 gutterid 8658: </p>
1.244 gutterid 8659: <p>Language variants like <code class="literal">gnu99</code> and
8660: <code class="literal">c++11</code> can be specified in <code class="varname">FORCE_C_STD</code>
8661: and <code class="varname">FORCE_CXX_STD</code> if the package does not explicitly set
8662: <code class="literal">-std=...</code> when compiling (i.e. the package
8663: assumes the compiler defaults to C++11 or some other standard).
8664: This is a common bug in upstream build systems.</p>
8665: <p>Allowed values for <code class="varname">FORCE_C_STD</code> are
8666: currently:
8667: </p>
8668: <pre class="programlisting">
8669: c90, c99, c11, gnu90, gnu99, gnu11
8670: </pre>
8671: <p>
8672: </p>
8673: <p>Allowed values for <code class="varname">FORCE_CXX_STD</code> are
8674: currently:
8675: </p>
8676: <pre class="programlisting">
8677: c++03, c++11, c++14, c++17, c++20,
8678: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
8679: </pre>
8680: <p>
1.251 gutterid 8681: Note at present these variables only affect use of GCC and Clang.
1.244 gutterid 8682: </p>
1.1 dsieger 8683: </div>
1.41 asau 8684: <div class="sect2">
1.1 dsieger 8685: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8686: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1 dsieger 8687: <p>If a program is written in Java, use the Java framework in
8688: pkgsrc. The package must include
8689: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8690: provides the following variables:</p>
1.41 asau 8691: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8692: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8693: dependency on the JDK is added. If
1.23 wiz 8694: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8695: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8696: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8697: JDK.</p></li>
1.23 wiz 8698: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8699: a package needs a Java2 implementation. The supported values
1.23 wiz 8700: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8701: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8702: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8703: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8704: above. This variable is not set by default.</p></li>
1.24 wiz 8705: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8706: automatically set to the runtime location of the used Java
8707: implementation dependency. It may be used to set
8708: <code class="varname">JAVA_HOME</code> to a good value if the program
8709: needs this variable to be defined.
8710: </p></li>
1.1 dsieger 8711: </ul></div>
8712: </div>
1.41 asau 8713: <div class="sect2">
1.1 dsieger 8714: <div class="titlepage"><div><div><h3 class="title">
1.205 wiz 8715: <a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
8716: <p>If a program is written in Go and has any dependencies on
8717: other Go modules, have the package include
8718: <code class="filename">../../lang/go/go-module.mk</code>.</p>
8719: <div class="orderedlist"><ol class="orderedlist" type="1">
8720: <li class="listitem"><p>Generate a list of those dependencies with
8721: <span class="command"><strong>make clean && make patch && make show-go-modules >
8722: go-modules.mk</strong></span>.</p></li>
1.223 nia 8723: <li class="listitem"><p>Prepend
8724: <code class="literal">.include "go-modules.mk"</code> to any other
8725: <code class="literal">.include</code>s.</p></li>
8726: <li class="listitem"><p>Incorporate these modules in
8727: <code class="filename">distinfo</code> with <span class="command"><strong>make
8728: makesum</strong></span>.</p></li>
8729: </ol></div>
8730: </div>
8731: <div class="sect2">
8732: <div class="titlepage"><div><div><h3 class="title">
8733: <a name="rust-programming-language"></a>21.4.4. Rust</h3></div></div></div>
8734: <p>If a program is written in Rust and uses Cargo to build,
8735: have the package include
8736: <code class="filename">../../lang/rust/cargo.mk</code>.</p>
8737: <div class="orderedlist"><ol class="orderedlist" type="1">
8738: <li class="listitem"><p>Generate a list of those dependencies with
8739: <span class="command"><strong>make CARGO_ARGS="build --release" build &&
8740: make print-cargo-depends > cargo-depends.mk</strong></span>.</p></li>
8741: <li class="listitem"><p>Prepend
8742: <code class="literal">.include "cargo-depends.mk"</code> to any other
8743: <code class="literal">.include</code>s.</p></li>
1.205 wiz 8744: <li class="listitem"><p>Incorporate these modules in
8745: <code class="filename">distinfo</code> with <span class="command"><strong>make
8746: makesum</strong></span>.</p></li>
8747: </ol></div>
8748: </div>
8749: <div class="sect2">
8750: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8751: <a name="perl-scripts"></a>21.4.5. Packages containing Perl scripts</h3></div></div></div>
1.203 nia 8752: <p>If your package contains interpreted Perl scripts, add
1.23 wiz 8753: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8754: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8755: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8756: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74 wiz 8757: that you want adjusted. Every occurrence of
8758: <code class="filename">*/bin/perl</code> in a she-bang line will be
1.210 gutterid 8759: replaced with the full path to the Perl executable.</p>
8760: <p>If a particular version of Perl is needed, set the
1.1 dsieger 8761: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8762: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.203 nia 8763: <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 8764: about handling Perl modules.</p>
8765: <p>There is also the <code class="varname">REPLACE_PERL6</code> variable
8766: for the language now known as Raku.</p>
1.1 dsieger 8767: </div>
1.41 asau 8768: <div class="sect2">
1.1 dsieger 8769: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8770: <a name="shell-scripts"></a>21.4.6. Packages containing shell scripts</h3></div></div></div>
1.40 wiz 8771: <p><code class="varname">REPLACE_SH</code>,
8772: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8773: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.225 gutterid 8774: she-bangs in files. Please use the appropriate one, preferring
8775: <code class="varname">REPLACE_SH</code> when this shell is sufficient.
1.74 wiz 8776: Each should contain a list of scripts, relative to
8777: <code class="varname">WRKSRC</code>, that you want adjusted. Every
8778: occurrence of the matching shell in a she-bang line will be
8779: replaced with the full path to the shell executable.
1.40 wiz 8780: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8781: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8782: </div>
1.41 asau 8783: <div class="sect2">
1.40 wiz 8784: <div class="titlepage"><div><div><h3 class="title">
1.223 nia 8785: <a name="other-programming-languages"></a>21.4.7. Other programming languages</h3></div></div></div>
1.210 gutterid 8786: <p>There are further similar REPLACE variables available, e.g.,
8787: <code class="varname">REPLACE_AWK</code> for packages containing awk scripts,
8788: and <code class="varname">REPLACE_R</code> for R. These two, like the others
1.211 gutterid 8789: noted above, have their actions defined centrally in
1.210 gutterid 8790: <code class="filename">mk/configure/replace-interpreter.mk</code>. Other
1.211 gutterid 8791: languages define the actions of these variables within their own
8792: dedicated part of the tree, e.g., <code class="varname">REPLACE_PHP</code> is
1.245 gutterid 8793: actioned in <code class="filename">lang/php/replace.mk</code>, and
1.211 gutterid 8794: <code class="varname">REPLACE_PYTHON</code> is actioned in
1.210 gutterid 8795: <code class="filename">lang/python/application.mk</code>. For other languages,
8796: consult the mk files found within their specific directories (the
1.216 gutterid 8797: naming convention varies), or check the list found in
8798: <a class="xref" href="#help-topics" title="Appendix E. Help topics">Appendix E, <i>Help topics</i></a>.</p>
1.210 gutterid 8799: <p>Currently, special handling for other languages varies
1.1 dsieger 8800: in pkgsrc. If a compiler package provides a
8801: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8802: just add a (build) dependency on the appropriate compiler
8803: package.</p>
8804: </div>
8805: </div>
1.41 asau 8806: <div class="sect1">
1.1 dsieger 8807: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 8808: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8809: <p>The most common failures when building a package are that
8810: some platforms do not provide certain header files, functions or
8811: libraries, or they provide the functions in a library that the
8812: original package author didn't know. To work around this, you
8813: can rewrite the source code in most cases so that it does not
8814: use the missing functions or provides a replacement function.</p>
1.41 asau 8815: <div class="sect2">
1.1 dsieger 8816: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8817: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8818: <p>If a package already comes with a GNU configure script, the
8819: preferred way to fix the build failure is to change the
8820: configure script, not the code. In the other cases, you can
8821: utilize the C preprocessor, which defines certain macros
8822: depending on the operating system and hardware architecture it
8823: compiles for. These macros can be queried using for example
8824: <code class="varname">#if defined(__i386)</code>. Almost every operating
8825: system, hardware architecture and compiler has its own macro.
8826: For example, if the macros <code class="varname">__GNUC__</code>,
8827: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8828: are all defined, you know that you are using NetBSD on an i386
8829: compatible CPU, and your compiler is GCC.</p>
8830: <p>The list of the following macros for hardware and
8831: operating system depends on the compiler that is used. For
8832: example, if you want to conditionally compile code on Solaris,
8833: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8834: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8835: <div class="sect3">
1.1 dsieger 8836: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8837: <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 8838: <p>To distinguish between specific NetBSD versions,
8839: you should use the following code.</p>
8840: <pre class="programlisting">
8841: #ifdef __NetBSD__
8842: #include <sys/param.h>
8843: #if __NetBSD_Prereq__(9,99,17)
8844: /* use a newer feature */
8845: #else
8846: /* older code */
8847: #endif
8848: #endif
8849:
8850: #ifndef _WIN32
8851: /* Unix-like specific code */
8852: #endif
8853: </pre>
1.1 dsieger 8854: <p>To distinguish between 4.4 BSD-derived systems and the
8855: rest of the world, you should use the following code.</p>
8856: <pre class="programlisting">
8857: #include <sys/param.h>
8858: #if (defined(BSD) && BSD >= 199306)
8859: /* BSD-specific code goes here */
8860: #else
8861: /* non-BSD-specific code goes here */
8862: #endif
8863: </pre>
1.223 nia 8864: <p>You can also test for the following macros:</p>
1.1 dsieger 8865: <pre class="programlisting">
1.45 obache 8866: Cygwin __CYGWIN__
8867: DragonFly __DragonFly__
1.1 dsieger 8868: FreeBSD __FreeBSD__
1.45 obache 8869: Haiku __HAIKU__
1.1 dsieger 8870: Interix __INTERIX
8871: IRIX __sgi (TODO: get a definite source for this)
1.223 nia 8872: Linux __linux
1.83 dholland 8873: Mac OS X __APPLE__
1.45 obache 8874: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8875: Minix3 __minix
1.1 dsieger 8876: NetBSD __NetBSD__
8877: OpenBSD __OpenBSD__
8878: Solaris sun, __sun
8879: </pre>
8880: </div>
1.41 asau 8881: <div class="sect3">
1.1 dsieger 8882: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8883: <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 8884: <pre class="programlisting">
8885: i386 i386, __i386, __i386__
1.223 nia 8886: x86-64 __amd64__, __x86_64__
8887: ARM __arm__
1.1 dsieger 8888: MIPS __mips
8889: SPARC sparc, __sparc
1.223 nia 8890: PowerPC __powerpc
1.1 dsieger 8891: </pre>
8892: </div>
1.41 asau 8893: <div class="sect3">
1.1 dsieger 8894: <div class="titlepage"><div><div><h4 class="title">
1.154 rillig 8895: <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 8896: <pre class="programlisting">
8897: GCC __GNUC__ (major version), __GNUC_MINOR__
8898: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8899: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8900: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8901: </pre>
8902: </div>
8903: </div>
1.41 asau 8904: <div class="sect2">
1.1 dsieger 8905: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 8906: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8907: <p>Some source files trigger bugs in the compiler, based on
8908: combinations of compiler version and architecture and almost
8909: always relation to optimisation being enabled. Common symptoms
8910: are gcc internal errors or never finishing compiling a
8911: file.</p>
8912: <p>Typically, a workaround involves testing the
8913: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8914: optimisation for that combination of file,
1.87 tnn 8915: <code class="varname">MACHINE_ARCH</code> and compiler.</p>
8916: <p>This used to be a big problem in the past, but is rarely
8917: needed now as compiler technology has matured. If you still need
8918: to add a compiler specific workaround, please do so in the file
8919: <code class="filename">hacks.mk</code> and describe the symptom and
8920: compiler version as detailed as possible.</p>
1.1 dsieger 8921: </div>
1.41 asau 8922: <div class="sect2">
1.1 dsieger 8923: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 8924: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
8925: <p>Compilation sometimes fails with an error message like this:</p>
8926: <pre class="programlisting">
8927: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
8928: fatal error: pango/pango.h: No such file or directory
8929: </pre>
8930: <p>The proper way to fix this problem depends on the type of the
8931: header, which is described in the following sections.</p>
8932: <div class="sect3">
8933: <div class="titlepage"><div><div><h4 class="title">
8934: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
8935: <p>If the header name looks like it comes from a different package,
8936: that other package should be included via the buildlink3
8937: framework.</p>
8938: <p>First, look whether the header is somewhere in the buildlink3
8939: directory below <code class="varname">WRKDIR</code>. In the above case of
8940: the missing Pango header:</p>
8941: <pre class="programlisting">
8942: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
8943: </pre>
8944: <p>In the case of Pango, the output is:</p>
8945: <pre class="programlisting">
8946: work/.buildlink/include/pango-1.0/pango/pango.h
8947: </pre>
8948: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
8949: in the <code class="filename">.buildlink</code> directory, it would have been
8950: found automatically. There is an extra <code class="filename">pango-1.0</code>
8951: path component though, which means that the compiler command line must
8952: contain an option of the form
8953: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
8954: most cases this option is generated by the configure script, which can be examined using:</p>
8955: <pre class="programlisting">
8956: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
8957: -I/usr/pkg/include/pango-1.0
8958: -I/usr/pkg/include/pango-1.0
8959: -I/usr/pkg/include/pango-1.0
8960: -I/usr/pkg/include/pango-1.0
8961: -I/usr/pkg/include/pango-1.0
8962: </pre>
8963: <p>This looks good. These options are transformed by the buildlink
8964: wrapper to refer to the correct path inside
8965: <code class="filename">work/.buildlink</code>.</p>
8966: <p>Since the compilation fails though, examine the compiler command
8967: lines in <code class="filename">work/.work.log</code> to see whether the
8968: <code class="literal">-I</code> option is included in the particular command
8969: line.</p>
8970: <p>To further analyze the situation, run <span class="command"><strong>bmake
8971: build-env</strong></span>, which sets up an interactive, realistic environment
8972: including all the pkgsrc wrapper commands and environment variables. From
8973: there, try to compile some simple example programs that use the
8974: header.</p>
8975: </div>
8976: <div class="sect3">
8977: <div class="titlepage"><div><div><h4 class="title">
8978: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
8979: <p>If the name of the header seems to come from the package itself,
8980: and if the build is run with parallel jobs, the package may have some
8981: undeclared dependencies between the <code class="filename">.c</code> and the
8982: <code class="filename">.h</code> files, and a C file is compiled before its
8983: required header is generated.</p>
8984: <p>To see whether the build runs with parallel jobs, run
8985: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
8986: like this:</p>
8987: <pre class="programlisting">
8988: usr MAKE_JOBS= 7
8989: pkg MAKE_JOBS_SAFE # undefined
8990: def _MAKE_JOBS_N= 7
8991: </pre>
8992: <p>In this case the pkgsrc user has asked pkgsrc to build packages
8993: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
8994: package could have disabled parallel builds by setting
8995: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
8996: in this case it hasn't.</p>
8997: <p>To see whether the build failure is caused by parallel builds,
8998: first save the exact error message and a bit of context, maybe you need
8999: it later for reporting a bug. Next, run:</p>
9000: <pre class="programlisting">
9001: MAKE_JOBS_SAFE=no bmake clean build
9002: </pre>
9003: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
9004: report</a> against the pkgsrc package, including the exact error
9005: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
9006: </div>
1.173 rillig 9007: <div class="sect3">
9008: <div class="titlepage"><div><div><h4 class="title">
9009: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
9010: <p>Pkgsrc does not work reliably if any of
9011: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
9012: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
9013: bootstrap program prevents installing pkgsrc in symlink-based
9014: directories. Existing pkgsrc installations are not checked for symlinks
9015: though.</p>
9016: <p>The "No such file or directory" error messages are a typical
9017: symptom of symlinks, and it's quite difficult to find out that this is
9018: the actual cause.</p>
9019: </div>
9020: <div class="sect3">
9021: <div class="titlepage"><div><div><h4 class="title">
9022: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
9023: <p>When building a hierarchy of packages, it may happen that one
9024: package is built and then pkgsrc is updated. This situation can provoke
9025: various hard to diagnose build errors. To clean up the situation:</p>
9026: <pre class="programlisting">
1.223 nia 9027: <code class="prompt">$</code> (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.173 rillig 9028: </pre>
1.223 nia 9029: <p>(The only purpose of the <code class="filename">bsd.pkg.mk</code> is to
9030: prevent running this command in the wrong directory.)</p>
1.173 rillig 9031: <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
9032: that directory as well.</p>
9033: </div>
9034: <div class="sect3">
9035: <div class="titlepage"><div><div><h4 class="title">
9036: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
9037: <p>On platforms other than BSD, third-party packages are installed in
9038: <code class="filename">/usr/include</code>, together with the base system. This
9039: means that pkgsrc cannot distinguish between headers provided by the base
9040: system (which it needs) and headers from third-party packages (which are
9041: often included in pkgsrc as well). This can lead to subtle version
9042: mismatches.</p>
9043: <p>In pkgsrc installations that have been active for several years, it
9044: may happen that some files are manually deleted. To exclude this unlikely
9045: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
9046: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
9047: check/fix dependencies.</p>
9048: <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>
9049: for contact information. Be prepared to describe what you have tried so
9050: far and what any error messages were.</p>
9051: </div>
1.172 rillig 9052: </div>
9053: <div class="sect2">
9054: <div class="titlepage"><div><div><h3 class="title">
9055: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
1.23 wiz 9056: </h3></div></div></div>
1.1 dsieger 9057: <p>This error message often means that a package did not
9058: link to a shared library it needs. The following functions are
9059: known to cause this error message over and over.</p>
9060: <div class="informaltable">
1.106 tnn 9061: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1 dsieger 9062: <colgroup>
9063: <col>
9064: <col>
9065: <col>
9066: </colgroup>
9067: <thead><tr>
9068: <th>Function</th>
9069: <th>Library</th>
9070: <th>Affected platforms</th>
9071: </tr></thead>
9072: <tbody>
9073: <tr>
9074: <td>accept, bind, connect</td>
9075: <td>-lsocket</td>
9076: <td>Solaris</td>
9077: </tr>
9078: <tr>
9079: <td>crypt</td>
9080: <td>-lcrypt</td>
9081: <td>DragonFly, NetBSD</td>
9082: </tr>
9083: <tr>
9084: <td>dlopen, dlsym</td>
9085: <td>-ldl</td>
9086: <td>Linux</td>
9087: </tr>
9088: <tr>
9089: <td>gethost*</td>
9090: <td>-lnsl</td>
9091: <td>Solaris</td>
9092: </tr>
9093: <tr>
9094: <td>inet_aton</td>
9095: <td>-lresolv</td>
9096: <td>Solaris</td>
9097: </tr>
9098: <tr>
9099: <td>nanosleep, sem_*, timer_*</td>
9100: <td>-lrt</td>
9101: <td>Solaris</td>
9102: </tr>
9103: <tr>
9104: <td>openpty</td>
9105: <td>-lutil</td>
9106: <td>Linux</td>
9107: </tr>
9108: </tbody>
9109: </table>
9110: </div>
1.223 nia 9111: <p>To fix these linker errors, it is often sufficient to add
1.1 dsieger 9112: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
9113: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.223 nia 9114: <code class="filename">Makefile</code> and then run <span class="command"><strong>bmake clean;
1.1 dsieger 9115: bmake</strong></span>.</p>
1.41 asau 9116: <div class="sect3">
1.1 dsieger 9117: <div class="titlepage"><div><div><h4 class="title">
1.223 nia 9118: <a name="undefined-reference-sunpro"></a>21.5.4.1. The SunPro compiler and inline functions</h4></div></div></div>
1.1 dsieger 9119: <p>When you are using the SunPro compiler, there is another
9120: possibility. That compiler cannot handle the following code:</p>
9121: <pre class="programlisting">
9122: extern int extern_func(int);
9123:
9124: static inline int
9125: inline_func(int x)
9126: {
9127: return extern_func(x);
9128: }
9129:
9130: int main(void)
9131: {
9132: return 0;
9133: }
9134: </pre>
9135: <p>It generates the code for <code class="function">inline_func</code> even if
9136: that function is never used. This code then refers to
9137: <code class="function">extern_func</code>, which can usually not be resolved. To
9138: solve this problem you can try to tell the package to disable inlining
9139: of functions.</p>
9140: </div>
1.228 gutterid 9141: <div class="sect3">
9142: <div class="titlepage"><div><div><h4 class="title">
9143: <a name="undefined-reference-atomic"></a>21.5.4.2. Missing atomic functions</h4></div></div></div>
9144: <p>When building for older machine architectures (e.g., i386, PowerPC),
9145: builds may fail because the package expects modern 64-bit atomic functions
9146: which the underlying hardware either doesn't support, or will only support
9147: with specific compiler flags. This is generally handled via inclusion of
9148: mk/atomic64.mk.</p>
9149: </div>
1.1 dsieger 9150: </div>
1.41 asau 9151: <div class="sect2">
1.1 dsieger 9152: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 9153: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1 dsieger 9154: <p>Sometimes packages fail to build because the compiler runs
9155: into an operating system specific soft limit. With the
9156: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.223 nia 9157: to unlimit the resources. The allowed values are any combination of
9158: <span class="quote">“<span class="quote">cputime</span>”</span>,
9159: <span class="quote">“<span class="quote">datasize</span>”</span>,
9160: <span class="quote">“<span class="quote">memorysize</span>”</span>,
9161: <span class="quote">“<span class="quote">stacksize</span>”</span> and
9162: <span class="quote">“<span class="quote">virtualsize</span>”</span>.
1.1 dsieger 9163: Setting this variable is similar to running the shell builtin
1.10 hubertf 9164: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 9165: segment size or maximum stack size of a process, respectively, to
9166: their hard limits.</p>
9167: </div>
9168: </div>
1.41 asau 9169: <div class="sect1">
1.1 dsieger 9170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9171: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 9172: <div class="sect2">
1.1 dsieger 9173: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9174: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 9175: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 9176: with some operating systems cannot create more than one
9177: directory at a time. As such, you should call
9178: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
9179: <pre class="programlisting">
9180: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
9181: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111 sevan 9182: </pre>
1.223 nia 9183: <p>Instead of running the <span class="command"><strong>install</strong></span> commands
9184: directly, you can also append <span class="quote">“<span class="quote"><code class="literal">dir1
9185: dir2</code></span>”</span> to the <code class="varname">INSTALLATION_DIRS</code>
9186: variable, which will automatically do the right thing.</p>
1.1 dsieger 9187: </div>
1.41 asau 9188: <div class="sect2">
1.1 dsieger 9189: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9190: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 9191: <p>In general, documentation should be installed into
9192: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
1.223 nia 9193: <code class="filename">${PREFIX}/share/doc/${PKGNAME_NOREV}</code> (the latter
1.1 dsieger 9194: includes the version number of the package).</p>
9195: <p>Many modern packages using GNU autoconf allow to set the
9196: directory where HTML documentation is installed with the
1.223 nia 9197: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag is
9198: needed because otherwise the documentation ends up in
9199: <code class="filename">${PREFIX}/share/doc/html</code> or other places. In
9200: pkgsrc, the HTML documentation should go into the package-specific
9201: directory, just like any other documentation.</p>
1.1 dsieger 9202: <p>An exception to the above is that library API documentation
1.207 leot 9203: 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 9204: browsers (devhelp) should be left at their default location, which
9205: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
9206: documentation can be recognized from files ending in
9207: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
9208: (It is also acceptable to install such files in
9209: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
9210: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9211: <code class="filename">.devhelp*</code> file must be directly in that
9212: directory then, no additional subdirectory level is allowed in
9213: this case. This is usually achieved by using
1.23 wiz 9214: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 9215: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9216: though.)</p>
9217: </div>
1.41 asau 9218: <div class="sect2">
1.1 dsieger 9219: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9220: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 9221: <p>Certain packages, most of them in the games category, install
9222: a score file that allows all users on the system to record their
9223: highscores. In order for this to work, the binaries need to be
9224: installed setgid and the score files owned by the appropriate
1.35 wiz 9225: group and/or owner (traditionally the "games" user/group). Set
9226: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 9227: following variables, documented in more detail in
9228: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 9229: behaviour: <code class="varname">GAMEDATAMODE</code>,
9230: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100 leot 9231: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
9232: Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
9233: <code class="varname">GAMEDATA_PERMS</code> and
9234: <code class="varname">SETGID_GAMES_PERMS</code>.</p>
9235: <p>An example that illustrates some of the variables described above is
9236: <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
9237: used to properly set directory permissions of the directory where the
9238: scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
9239: dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
9240: and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
9241: binary:</p>
9242: <pre class="programlisting">
1.112 rillig 9243: USE_GAMESGROUP= yes
1.100 leot 9244:
1.112 rillig 9245: BUILD_DEFS+= VARBASE
1.100 leot 9246:
1.112 rillig 9247: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
9248: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
9249: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111 sevan 9250: </pre>
1.100 leot 9251: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
9252: <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
9253: <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
9254: needed to be accessed by setgid games and
9255: <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14 jmcneill 9256: <p>A package should therefore never hard code file ownership or
1.100 leot 9257: access permissions but rely on <code class="varname">*_PERMS</code> as described above
9258: or alternatively on <code class="varname">INSTALL_GAME</code>,
9259: <code class="varname">INSTALL_GAME_DATA</code> and
9260: <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1 dsieger 9261: </div>
1.41 asau 9262: <div class="sect2">
1.1 dsieger 9263: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9264: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 9265: <p><code class="varname">DESTDIR</code> support means that a package
9266: installs into a staging directory, not the final location of the
9267: files. Then a binary package is created which can be used for
9268: installation as usual. There are two ways: Either the package must
1.23 wiz 9269: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9270: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 9271: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9272: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113 leot 9273: set to <span class="quote">“<span class="quote">destdir</span>”</span> or <span class="quote">“<span class="quote">user-destdir</span>”</span>.
9274: By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38 wiz 9275: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9276: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 9277: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9278: the inclusion.</p></li>
1.23 wiz 9279: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 9280: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 9281: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 9282: automatically. Many manual rules and pre/post-install often are
9283: incorrect; fix them.</p></li>
1.23 wiz 9284: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 9285: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 9286: <li class="listitem"><p>In general, packages should support
1.4 rillig 9287: <code class="varname">UNPRIVILEGED</code> to be able to use
9288: DESTDIR.</p></li>
9289: </ul></div>
9290: </div>
1.41 asau 9291: <div class="sect2">
1.4 rillig 9292: <div class="titlepage"><div><div><h3 class="title">
1.154 rillig 9293: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 9294: <p>Your package may also contain scripts with hardcoded paths to
1.203 nia 9295: other interpreters besides (or as well as) Perl. To correct the
1.1 dsieger 9296: full pathname to the script interpreter, you need to set the
9297: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 9298: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 9299: <pre class="programlisting">
9300: REPLACE_INTERPRETER+= tcl
9301: REPLACE.tcl.old= .*/bin/tclsh
9302: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9303: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9304: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111 sevan 9305: </pre>
1.1 dsieger 9306: </div>
1.41 asau 9307: <div class="sect2">
1.1 dsieger 9308: <div class="titlepage"><div><div><h3 class="title">
1.203 nia 9309: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.1 dsieger 9310: <p>Makefiles of packages providing perl5 modules should include
9311: the Makefile fragment
9312: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 9313: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 9314: configuration for such modules as well as various hooks to tune
9315: this configuration. See comments in this file for
9316: details.</p>
9317: <p>Perl5 modules will install into different places depending
9318: on the version of perl used during the build process. To
9319: address this, pkgsrc will append lines to the
9320: <code class="filename">PLIST</code> corresponding to the files listed in
9321: the installed <code class="filename">.packlist</code> file generated by
9322: most perl5 modules. This is invoked by defining
9323: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 9324: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9325: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9326: e.g.:</p>
1.1 dsieger 9327: <pre class="programlisting">
1.47 wiz 9328: PERL5_PACKLIST= auto/Pg/.packlist
1.111 sevan 9329: </pre>
1.47 wiz 9330: <p>The perl5 config variables
9331: <code class="varname">installarchlib</code>,
9332: <code class="varname">installscript</code>,
9333: <code class="varname">installvendorbin</code>,
9334: <code class="varname">installvendorscript</code>,
9335: <code class="varname">installvendorarch</code>,
9336: <code class="varname">installvendorlib</code>,
9337: <code class="varname">installvendorman1dir</code>, and
9338: <code class="varname">installvendorman3dir</code> represent those
9339: locations in which components of perl5 modules may be installed,
9340: provided as variable with uppercase and prefixed with
9341: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9342: and may be used by perl5 packages that don't have a packlist.
9343: These variables are also substituted for in the
9344: <code class="filename">PLIST</code> as uppercase prefixed with
9345: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 9346: </div>
1.41 asau 9347: <div class="sect2">
1.1 dsieger 9348: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9349: <a name="faq.pkg-config-files"></a>21.6.7. Packages installing pkg-config files</h3></div></div></div>
9350: <p>Some packages, usually those providing libraries, install
9351: pkg-config files so that their headers and libraries can easily be
9352: found. The file names end with <code class="filename">.pc</code>.</p>
9353: <p>Most of the time, these files only provide the linker flags
9354: for the library, but do not include the flags for setting the
9355: rpath so the libraries can also be found at runtime. Since this is
9356: so common, pkgsrc provides <code class="varname">PKGCONFIG_OVERRIDE</code>
9357: for this. Many packages generate the <code class="filename">.pc</code> from
9358: <code class="filename">.pc.in</code>, in that case add those files to the
9359: <code class="varname">PKGCONFIG_OVERRIDE</code> variable:</p>
9360: <pre class="programlisting">
9361: PKGCONFIG_OVERRIDE+= foo.pc.in
9362: </pre>
9363: <p>For packages using meson, the files are generated during
9364: build and you also need to change the phase in which the
9365: replacement is done. For example:</p>
9366: <pre class="programlisting">
9367: PKGCONFIG_OVERRIDE+= output/meson-private/foo.pc
9368: PKGCONFIG_OVERRIDE_STAGE= post-build
9369: </pre>
9370: </div>
9371: <div class="sect2">
9372: <div class="titlepage"><div><div><h3 class="title">
9373: <a name="faq.info-files"></a>21.6.8. Packages installing info files</h3></div></div></div>
1.1 dsieger 9374: <p>Some packages install info files or use the
1.23 wiz 9375: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 9376: commands. <code class="varname">INFO_FILES</code> should be defined in
9377: the package Makefile so that <code class="filename">INSTALL</code> and
9378: <code class="filename">DEINSTALL</code> scripts will be generated to
9379: handle registration of the info files in the Info directory
1.23 wiz 9380: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 9381: files registration is either provided by the system, or by a
9382: special purpose package automatically added as dependency if
9383: needed.</p>
9384: <p><code class="varname">PKGINFODIR</code> is the directory under
9385: <code class="filename">${PREFIX}</code> where info files are primarily
9386: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 9387: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 9388: <p>The info files for the package should be listed in the
9389: package <code class="filename">PLIST</code>; however any split info files
9390: need not be listed.</p>
1.23 wiz 9391: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9392: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 9393: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 9394: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 9395: should be noted with the <code class="varname">TEXINFO_REQD</code>
9396: variable in the package <code class="filename">Makefile</code>. By
9397: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 9398: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 9399: does not match the required minimum, a build dependency on the
1.207 leot 9400: <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 9401: be added automatically.</p>
9402: <p>The build and installation process of the software provided
9403: by the package should not use the
1.10 hubertf 9404: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 9405: info files is the task of the package
9406: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 9407: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 9408: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 9409: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9410: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 9411: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9412: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9413: no effect except the logging of a message. The script overriding
1.10 hubertf 9414: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9415: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9416: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9417: </div>
1.41 asau 9418: <div class="sect2">
1.1 dsieger 9419: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9420: <a name="manpages"></a>21.6.9. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9421: <p>All packages that install manual pages should install them
9422: into the same directory, so that there is one common place to look
9423: for them. In pkgsrc, this place is
9424: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9425: should be used in packages. The default for
9426: <code class="varname">PKGMANDIR</code> is
1.23 wiz 9427: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9428: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9429: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9430: <h3 class="title">Note</h3>
9431: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9432: is far from complete.</p>
9433: </div>
9434: <p>The <code class="filename">PLIST</code> files can just use
9435: <code class="filename">man/</code> as the top level directory for the man
9436: page file entries, and the pkgsrc framework will convert as
9437: needed. In all other places, the correct
9438: <code class="varname">PKGMANDIR</code> must be used.</p>
9439: <p>Packages that are
9440: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 9441: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9442: <code class="filename">./configure</code>
9443: --mandir switch to set where the man pages should be installed.
9444: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9445: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9446: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9447: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 9448: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9449: Or if the <code class="filename">./configure</code> script uses
9450: a non-standard use of --mandir, you can set
9451: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.184 rillig 9452: <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 9453: information on installation of compressed manual pages.</p>
9454: </div>
1.41 asau 9455: <div class="sect2">
1.1 dsieger 9456: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9457: <a name="x11-fonts"></a>21.6.10. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9458: <p>If a package installs font files, you will need to rebuild
9459: the fonts database in the directory where they get installed at
9460: installation and deinstallation time. This can be automatically
9461: done by using the pkginstall framework.</p>
9462: <p>You can list the directories where fonts are installed in the
9463: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9464: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9465: <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 9466: Also make sure that the database file
9467: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9468: <p>Note that you should not create new directories for fonts;
9469: instead use the standard ones to avoid that the user needs to
9470: manually configure his X server to find them.</p>
9471: </div>
1.41 asau 9472: <div class="sect2">
1.1 dsieger 9473: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9474: <a name="sgml-xml-data"></a>21.6.11. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9475: <p>If a package installs SGML or XML data files that need to be
9476: registered in system-wide catalogs (like DTDs, sub-catalogs,
9477: etc.), you need to take some extra steps:</p>
1.23 wiz 9478: <div class="orderedlist"><ol class="orderedlist" type="1">
9479: <li class="listitem"><p>Include
1.1 dsieger 9480: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9481: your <code class="filename">Makefile</code>, which takes care of
9482: registering those files in system-wide catalogs at
9483: installation and deinstallation time.</p></li>
1.23 wiz 9484: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9485: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9486: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9487: any XML catalogs installed by the package.</p></li>
1.23 wiz 9488: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9489: to be added to the SGML catalog. These come in groups of
9490: three strings; see xmlcatmgr(1) for more information
9491: (specifically, arguments recognized by the 'add' action).
9492: Note that you will normally not use this variable.</p></li>
1.23 wiz 9493: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9494: to be added to the XML catalog. These come in groups of three
9495: strings; see xmlcatmgr(1) for more information (specifically,
9496: arguments recognized by the 'add' action). Note that you will
9497: normally not use this variable.</p></li>
9498: </ol></div>
9499: </div>
1.41 asau 9500: <div class="sect2">
1.1 dsieger 9501: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9502: <a name="mime-database"></a>21.6.12. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9503: <p>If a package provides extensions to the MIME database by
9504: installing <code class="filename">.xml</code> files inside
9505: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9506: need to take some extra steps to ensure that the database is kept
9507: consistent with respect to these new files:</p>
1.23 wiz 9508: <div class="orderedlist"><ol class="orderedlist" type="1">
9509: <li class="listitem"><p>Include
1.1 dsieger 9510: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9511: (avoid using the <code class="filename">buildlink3.mk</code> file from
9512: this same directory, which is reserved for inclusion from
9513: other <code class="filename">buildlink3.mk</code> files). It takes
9514: care of rebuilding the MIME database at installation and
9515: deinstallation time, and disallows any access to it directly
9516: from the package.</p></li>
1.23 wiz 9517: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9518: <code class="filename">share/mime</code> directory,
9519: <span class="emphasis"><em>except</em></span> for files saved under
9520: <code class="filename">share/mime/packages</code>. The former are
9521: handled automatically by
9522: the update-mime-database program, but the latter are
9523: package-dependent and must be removed by the package that
9524: installed them in the first place.</p></li>
1.23 wiz 9525: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9526: from the PLIST. They will be handled by the shared-mime-info
9527: package.</p></li>
9528: </ol></div>
9529: </div>
1.41 asau 9530: <div class="sect2">
1.1 dsieger 9531: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9532: <a name="intltool"></a>21.6.13. Packages using intltool</h3></div></div></div>
1.1 dsieger 9533: <p>If a package uses intltool during its build, add
9534: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9535: which forces it to use the intltool package provided by pkgsrc,
9536: instead of the one bundled with the distribution file.</p>
9537: <p>This tracks intltool's build-time dependencies and uses the
9538: latest available version; this way, the package benefits of any
9539: bug fixes that may have appeared since it was released.</p>
9540: </div>
1.41 asau 9541: <div class="sect2">
1.1 dsieger 9542: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9543: <a name="startup-scripts"></a>21.6.14. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9544: <p>If a package contains a rc.d script, it won't be copied into
9545: the startup directory by default, but you can enable it, by adding
9546: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9547: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9548: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9549: it will automatically remove the scripts when the package is
9550: deinstalled.</p>
9551: </div>
1.41 asau 9552: <div class="sect2">
1.1 dsieger 9553: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9554: <a name="tex-packages"></a>21.6.15. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9555: <p>If a package installs TeX packages into the texmf tree,
9556: the <code class="filename">ls-R</code> database of the tree needs to be
9557: updated.</p>
1.41 asau 9558: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9559: <h3 class="title">Note</h3>
1.22 jakllsch 9560: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9561: packages should install files
1.22 jakllsch 9562: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9563: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9564: </div>
1.23 wiz 9565: <div class="orderedlist"><ol class="orderedlist" type="1">
9566: <li class="listitem"><p>Include
1.22 jakllsch 9567: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9568: takes care of rebuilding the <code class="filename">ls-R</code>
9569: database at installation and deinstallation time.</p></li>
1.23 wiz 9570: <li class="listitem">
1.1 dsieger 9571: <p>If your package installs files into a texmf
9572: tree other than the one
1.22 jakllsch 9573: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9574: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9575: trees that need database update.</p>
9576: <p>If your package also installs font map files that need
1.10 hubertf 9577: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9578: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9579: set <code class="varname">TEX_MAP_FILES</code> and/or
9580: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9581: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9582: be run automatically at installation/deinstallation to
9583: enable/disable font map files for TeX output
9584: drivers.</p>
9585: </li>
1.23 wiz 9586: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9587: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9588: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9589: </ol></div>
9590: </div>
1.41 asau 9591: <div class="sect2">
1.1 dsieger 9592: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9593: <a name="emulation-packages"></a>21.6.16. Packages supporting running binaries in
1.1 dsieger 9594: emulation</h3></div></div></div>
9595: <p>There are some packages that provide libraries and
9596: executables for running binaries from a one operating system
9597: on a different one (if the latter supports it). One example
9598: is running Linux binaries on NetBSD.</p>
1.207 leot 9599: <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 9600: helps in extracting and packaging Linux rpm packages.</p>
9601: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9602: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9603: if all libraries for each installed executable can be found by
9604: the dynamic linker. Since the standard dynamic linker is run,
9605: this fails for emulation packages, because the libraries used
9606: by the emulation are not in the standard directories.</p>
9607: </div>
1.184 rillig 9608: <div class="sect2">
9609: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9610: <a name="hicolor-theme"></a>21.6.17. Packages installing hicolor icons</h3></div></div></div>
1.184 rillig 9611: <p>If a package installs images under the
9612: <code class="filename">share/icons/hicolor</code> and/or updates the
9613: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9614: database, you need to take some extra steps to make sure that the
9615: shared theme directory is handled appropriately and that the cache
9616: database is rebuilt:</p>
9617: <div class="orderedlist"><ol class="orderedlist" type="1">
9618: <li class="listitem"><p>Include
9619: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9620: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9621: entry that refers to the theme cache.</p></li>
9622: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9623: directories from the <code class="filename">share/icons/hicolor</code>
9624: hierarchy because they will be handled automatically.</p></li>
9625: </ol></div>
9626: <p>The best way to verify that the PLIST is correct with
9627: respect to the last two points is to regenerate it using
9628: <span class="command"><strong>make print-PLIST</strong></span>.</p>
9629: </div>
9630: <div class="sect2">
9631: <div class="titlepage"><div><div><h3 class="title">
1.254 wiz 9632: <a name="desktop-files"></a>21.6.18. Packages installing desktop files</h3></div></div></div>
1.184 rillig 9633: <p>If a package installs <code class="filename">.desktop</code> files
9634: under <code class="filename">share/applications</code> and these include
9635: MIME information (MimeType key), you need to take extra steps to
9636: ensure that they are registered into the MIME database:</p>
9637: <div class="orderedlist"><ol class="orderedlist" type="1">
9638: <li class="listitem"><p>Include
9639: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9640: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9641: <code class="filename">share/applications/mimeinfo.cache</code> file.
9642: It will be handled automatically.</p></li>
9643: </ol></div>
9644: <p>The best way to verify that the PLIST is correct with
9645: respect to the last point is to regenerate it using <span class="command"><strong>make
9646: print-PLIST</strong></span>.</p>
9647: </div>
9648: </div>
9649: <div class="sect1">
9650: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9651: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
9652: <p>In some cases one does not have the time to solve a problem
9653: immediately. In this case, one can plainly mark a package as broken. For
9654: this, one just sets the variable <code class="varname">BROKEN</code> to the
9655: reason why the package is broken (similar to the
9656: <code class="varname">PKG_FAIL_REASON</code> variable). A user trying to build
9657: the package will immediately be shown this message, and the build
9658: will not be even tried.</p>
9659: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9660: intervals.</p>
9661: </div>
9662: </div>
9663: <div class="chapter">
9664: <div class="titlepage"><div><div><h2 class="title">
9665: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
9666: <div class="toc">
9667: <p><b>Table of Contents</b></p>
9668: <dl class="toc">
9669: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9670: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9671: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9672: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
9673: </dl>
9674: </div>
9675: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
9676: site</a>:</p>
9677: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9678: environment, an intuitive and attractive desktop for users, and the
9679: GNOME development platform, an extensive framework for building
9680: applications that integrate into the rest of the desktop.</p></blockquote></div>
9681: <p>pkgsrc provides a seamless way to automatically build and install
9682: a complete GNOME environment <span class="emphasis"><em>under many different
9683: platforms</em></span>. We can say with confidence that pkgsrc is one of
9684: the most advanced build and packaging systems for GNOME due to its
9685: included technologies buildlink3, the wrappers and tools framework and
9686: automatic configuration file management. Lots of efforts are put into
9687: achieving a completely clean deinstallation of installed software
9688: components.</p>
9689: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9690: the above also means that great efforts are put into making GNOME work
1.201 cirnatda 9691: under this operating system.</p>
1.184 rillig 9692: <p>This chapter is aimed at pkgsrc developers and other people
9693: interested in helping our GNOME porting and packaging efforts. It
9694: provides instructions on how to manage the existing packages and some
9695: important information regarding their internals.</p>
9696: <div class="sect1">
9697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9698: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
9699: <p>pkgsrc includes three GNOME-related meta packages:</p>
9700: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.207 leot 9701: <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 9702: the core GNOME desktop environment. It only includes the necessary
9703: bits to get it to boot correctly, although it may lack important
9704: functionality for daily operation. The idea behind this package is
9705: to let end users build their own configurations on top of this one,
9706: first installing this meta package to achieve a functional setup and
9707: then adding individual applications.</p></li>
1.207 leot 9708: <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 9709: complete installation of the GNOME platform and desktop as defined
9710: by the GNOME project; this is based on the components distributed in
9711: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9712: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9713: official FTP server. Developer-only tools found in those
9714: directories are not installed unless required by some other
9715: component to work properly. Similarly, packages from the bindings
9716: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9717: in unless required as a dependency for an end-user component. This
1.207 leot 9718: 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>
9719: <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 9720: Installs all the tools required to build a GNOME component when
9721: fetched from the CVS repository. These are required to let the
9722: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9723: </ul></div>
9724: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9725: sorted in a way that eases updates: a package may depend on other
9726: packages listed before it but not on any listed after it. It is very
9727: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9728: change it to alphabetical sorting!</em></span></p>
9729: </div>
9730: <div class="sect1">
9731: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9732: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
9733: <p>Almost all GNOME applications are written in C and use a common
9734: set of tools as their build system. Things get different with the new
9735: bindings to other languages (such as Python), but the following will
9736: give you a general idea on the minimum required tools:</p>
9737: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
9738: <li class="listitem">
9739: <p>Almost all GNOME applications use the GNU Autotools as their
9740: build system. As a general rule you will need to tell this to your
9741: package:</p>
9742: <pre class="programlisting">
1.223 nia 9743: GNU_CONFIGURE= yes
9744: USE_LIBTOOL= yes
9745: USE_TOOLS+= gmake
1.184 rillig 9746: </pre>
9747: </li>
9748: <li class="listitem">
9749: <p>If the package uses pkg-config to detect dependencies, add this
9750: tool to the list of required utilities:</p>
9751: <pre class="programlisting">
1.223 nia 9752: USE_TOOLS+= pkg-config
1.184 rillig 9753: </pre>
1.207 leot 9754: <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 9755: the end of the build process to ensure that you did not miss to
9756: specify any dependency in your package and that the version
9757: requirements are all correct.</p>
9758: </li>
9759: <li class="listitem"><p>If the package uses intltool, be sure to add
9760: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9761: to handle dependencies and to force the package to use the latest
9762: available version.</p></li>
9763: <li class="listitem">
9764: <p>If the package uses gtk-doc (a documentation generation
9765: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9766: tool is rather big and the distfile should come with pregenerated
9767: documentation anyway; if it does not, it is a bug that you ought to
9768: report. For such packages you should disable gtk-doc (unless it is
9769: the default):</p>
9770: <pre class="programlisting">
1.223 nia 9771: CONFIGURE_ARGS+= --disable-gtk-doc
1.184 rillig 9772: </pre>
9773: <p>The default location of installed HTML files
9774: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9775: and should not be changed unless the package insists on installing
9776: them somewhere else. Otherwise programs as
9777: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
9778: do that with an entry similar to:</p>
9779: <pre class="programlisting">
1.223 nia 9780: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.184 rillig 9781: </pre>
9782: </li>
9783: </ul></div>
9784: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9785: files under the installation prefix to maintain databases. In this
9786: context, shared means that those exact same directories and files are
9787: used among several different packages, leading to conflicts in the
9788: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9789: handle the most common cases, so you have to forget about using
9790: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9791: omitting shared files from them. If you find yourself doing those,
9792: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9793: <p>The following table lists the common situations that result in
9794: using shared directories or files. For each of them, the appropriate
9795: solution is given. After applying the solution be sure to
9796: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9797: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9798: <div class="table">
9799: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
9800: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
9801: <colgroup>
9802: <col>
9803: <col>
9804: </colgroup>
9805: <thead><tr>
9806: <th>If the package...</th>
9807: <th>Then...</th>
9808: </tr></thead>
9809: <tbody>
9810: <tr>
9811: <td>Installs icons under the
9812: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9813: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.254 wiz 9814: <td>See <a class="xref" href="#hicolor-theme" title="21.6.17. Packages installing hicolor icons">Section 21.6.17, “Packages installing hicolor icons”</a>.</td>
1.184 rillig 9815: </tr>
9816: <tr>
9817: <td>Installs files under
9818: <code class="filename">share/mime/packages</code>.</td>
1.254 wiz 9819: <td>See <a class="xref" href="#mime-database" title="21.6.12. Packages installing extensions to the MIME database">Section 21.6.12, “Packages installing extensions to the MIME database”</a>.</td>
1.184 rillig 9820: </tr>
9821: <tr>
9822: <td>Installs <code class="filename">.desktop</code> files under
9823: <code class="filename">share/applications</code> and these include MIME
9824: information.</td>
1.254 wiz 9825: <td>See <a class="xref" href="#desktop-files" title="21.6.18. Packages installing desktop files">Section 21.6.18, “Packages installing desktop files”</a>.</td>
1.184 rillig 9826: </tr>
9827: </tbody>
9828: </table></div>
1.1 dsieger 9829: </div>
1.184 rillig 9830: <br class="table-break">
1.1 dsieger 9831: </div>
1.41 asau 9832: <div class="sect1">
1.1 dsieger 9833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 9834: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
9835: <p>When seeing GNOME as a whole, there are two kinds of
9836: updates:</p>
9837: <div class="variablelist"><dl class="variablelist">
9838: <dt><span class="term">Major update</span></dt>
9839: <dd>
9840: <p>Given that there is still a very long way for GNOME 3 (if it
9841: ever appears), we consider a major update one that goes from a
9842: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9843: where <code class="literal">Y</code> is even and greater than
9844: <code class="literal">X</code>. These are hard to achieve because they
9845: introduce lots of changes in the components' code and almost all
9846: GNOME distfiles are updated to newer versions. Some of them can
9847: even break API and ABI compatibility with the previous major
9848: version series. As a result, the update needs to be done all at
9849: once to minimize breakage.</p>
9850: <p>A major update typically consists of around 80 package
9851: updates and the addition of some new ones.</p>
9852: </dd>
9853: <dt><span class="term">Minor update</span></dt>
9854: <dd>
9855: <p>We consider a minor update one that goes from a
9856: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9857: one where <code class="literal">Y</code> is greater than
9858: <code class="literal">X</code>. These are easy to achieve because they do
9859: not update all GNOME components, can be done in an incremental way
9860: and do not break API nor ABI compatibility.</p>
9861: <p>A minor update typically consists of around 50 package
9862: updates, although the numbers here may vary a lot.</p>
9863: </dd>
9864: </dl></div>
9865: <p>In order to update the GNOME components in pkgsrc to a new stable
9866: release (either major or minor), the following steps should be
9867: followed:</p>
9868: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23 wiz 9869: <li class="listitem">
1.184 rillig 9870: <p>Get a list of all the tarballs that form the new release by
9871: using the following commands. These will leave the full list of the
9872: components' distfiles into the <code class="filename">list.txt</code>
9873: file:</p>
9874: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9875: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9876: awk '{ print $9 }' >list.txt</code></strong>
9877: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9878: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9879: awk '{ print $9 }' >>list.txt</code></strong></pre>
1.1 dsieger 9880: </li>
1.184 rillig 9881: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
9882: bump their version to the release you are updating them to. The
9883: three meta packages should be always consistent with versioning.
9884: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9885: in them.</p></li>
1.23 wiz 9886: <li class="listitem">
1.184 rillig 9887: <p>For each meta package, update all its
9888: <code class="varname">DEPENDS</code> lines to match the latest versions as
9889: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9890: newer version (even if found in the FTP) because the meta packages
9891: are supposed to list the exact versions that form a specific GNOME
9892: release. Exceptions are permitted here if a newer version solves a
9893: serious issue in the overall desktop experience; these typically
9894: come in the form of a revision bump in pkgsrc, not in newer versions
9895: from the developers.</p>
9896: <p>Packages not listed in the <code class="filename">list.txt</code> file
9897: should be updated to the latest version available (if found in
9898: pkgsrc). This is the case, for example, of the dependencies on the
1.207 leot 9899: 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 9900: </li>
1.23 wiz 9901: <li class="listitem">
1.184 rillig 9902: <p>Generate a patch from the modified meta packages and extract the
9903: list of "new" lines. This will provide you an outline on what
9904: packages need to be updated in pkgsrc and in what order:</p>
9905: <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 9906: </li>
1.184 rillig 9907: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
9908: installed packages and start over from scratch at this point.</p></li>
9909: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
9910: of <code class="filename">todo.txt</code> and update the packages listed in
9911: it in order. For major desktop updates none of these should be
9912: committed until the entire set is completed because there are chances
9913: of breaking not-yet-updated packages.</p></li>
9914: <li class="listitem"><p>Once the packages are up to date and working, commit them to
9915: the tree one by one with appropriate log messages. At the end,
9916: commit the three meta package updates and all the corresponding
9917: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9918: <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>
9919: </ol></div>
9920: </div>
9921: <div class="sect1">
9922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9923: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
9924: <p>GNOME is a very big component in pkgsrc which approaches 100
9925: packages. Please, it is very important that you always, always,
9926: <span class="strong"><strong>always</strong></span> feed back any portability
9927: 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
9928: their attention on portability issues and to ensure that future versions
9929: can be built out-of-the box on NetBSD. The less custom patches in
9930: pkgsrc, the easier further updates are. Those developers in charge of
9931: issuing major GNOME updates will be grateful if you do that.</p>
1.200 cirnatda 9932: <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
9933: GitLab</a>. Not all components use these to track bugs, but most
1.184 rillig 9934: of them do. Do not be short on your reports: always provide detailed
9935: explanations of the current failure, how it can be improved to achieve
1.200 cirnatda 9936: maximum portability and, if at all possible, provide a patch against the
9937: main Git branch. The more verbose you are, the higher chances of your
9938: patch being accepted.</p>
1.184 rillig 9939: <p>Also, please avoid using preprocessor magic to fix portability
9940: issues. While the FreeBSD GNOME people are doing a great job in porting
9941: GNOME to their operating system, the official GNOME sources are now
9942: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9943: and similar macros. This hurts portability. Please see our patching
9944: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, “Patching guidelines”</a>) for more
9945: details.</p>
9946: </div>
1.1 dsieger 9947: </div>
1.41 asau 9948: <div class="chapter">
1.1 dsieger 9949: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 9950: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9951: <div class="toc">
9952: <p><b>Table of Contents</b></p>
1.100 leot 9953: <dl class="toc">
1.154 rillig 9954: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
9955: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9956: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
9957: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
9958: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
9959: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
9960: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
9961: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9962: </dl>
9963: </div>
1.41 asau 9964: <div class="sect1">
1.1 dsieger 9965: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9966: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9967: <p>Our policy is that we accept binaries only from pkgsrc
9968: developers to guarantee that the packages don't contain any
9969: trojan horses etc. This is not to annoy anyone but rather to
9970: protect our users! You're still free to put up your home-made
9971: binary packages and tell the world where to get them. NetBSD
9972: developers doing bulk builds and wanting to upload them please
1.154 rillig 9973: 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 9974: builds)</i></a>.</p>
1.1 dsieger 9975: </div>
1.41 asau 9976: <div class="sect1">
1.1 dsieger 9977: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 9978: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.218 nia 9979: <p>Firstly, you can import new packages into
9980: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
9981: homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
9982: for details.</p>
9983: <p>Next, check that your package is complete, compiles and
1.184 rillig 9984: 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 9985: 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>
9986: tool and fix any errors that appear.</p>
9987: <p>Finally, send a report to the pkgsrc bug tracking system,
1.246 leot 9988: either with the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 9989: that, go to the web page
1.174 leot 9990: <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 9991: which contains some instructions and a link to a form where you
9992: can submit packages. The
1.207 leot 9993: <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 9994: also available as a substitute for either of the above two tools.
9995: </p>
1.1 dsieger 9996: <p>In the form of the problem report, the category should be
1.23 wiz 9997: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9998: and version number, and the description field should contain a
9999: short description of your package (contents of the COMMENT
1.218 nia 10000: variable or DESCR file are OK).</p>
1.1 dsieger 10001: </div>
1.41 asau 10002: <div class="sect1">
1.1 dsieger 10003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10004: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 10005: <p>Please note all package additions, updates, moves, and
10006: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
10007: important to keep this file up to date and conforming to the
10008: existing format, because it will be used by scripts to
1.174 leot 10009: automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 10010: sites. Additionally, check the
10011: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
10012: for the package you updated or removed, in case it was mentioned
10013: there.</p>
10014: <p>When the <code class="varname">PKGREVISION</code> of a package is
10015: bumped, the change should appear in
10016: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
10017: related or otherwise relevant. Mass bumps that result from a
10018: dependency being updated should not be mentioned. In all other
10019: cases it's the developer's decision.</p>
10020: <p>There is a make target that helps in creating proper
1.10 hubertf 10021: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 10022: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
10023: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
10024: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
10025: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 10026: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
10027: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 10028: For new packages, or package moves or removals, set the
10029: <code class="varname">CTYPE</code> variable on the command line to "Added",
10030: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 10031: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 10032: not the same as your NetBSD login name. The target also automatically
10033: removes possibly existing entries for the package in the
10034: <code class="filename">TODO</code> file. Don't forget to commit
1.66 asau 10035: the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22 jakllsch 10036: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
10037: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
10038: makes the cvs commands use the main repository.
10039: </p>
1.1 dsieger 10040: </div>
1.41 asau 10041: <div class="sect1">
1.1 dsieger 10042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10043: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130 wiz 10044: <p>For several years, there have been mirrors of pkgsrc in
10045: fossil, git, and hg. Standard practise when using these tools is to
10046: make the first line of a commit message function as a summary that
10047: can be read without the rest, such as is commonly done with "git log
10048: --oneline". For this reason, we have the following guidelines for
10049: pkgsrc commit messages:</p>
10050: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
10051: <li class="listitem"><p>Start the commit message with a line that explains the
1.131 wiz 10052: big picture in 65 characters or less. When a commit is for one
1.130 wiz 10053: package, include the name of the package. For updates, include the
10054: version to which it is updated.</p></li>
10055: <li class="listitem"><p>Leave the next line empty.</p></li>
10056: <li class="listitem"><p>Then come the details for the commit (changes in that
10057: package, reason for a change) and any relevant PRs. Wrap this
10058: section.</p></li>
10059: </ul></div>
10060: <p>Here is an example:
1.238 wiz 10061: </p>
1.130 wiz 10062: <pre class="programlisting">
1.238 wiz 10063: libxslt: update to 1.0.30
1.130 wiz 10064:
1.238 wiz 10065: Changes since 1.0.29:
10066: ...
10067: </pre>
1.130 wiz 10068: <p>
10069: </p>
10070: <p>Here is another example:
1.238 wiz 10071: </p>
1.130 wiz 10072: <pre class="programlisting">
1.238 wiz 10073: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.130 wiz 10074:
1.238 wiz 10075: (rationale)
10076: </pre>
1.130 wiz 10077: <p>
10078: </p>
10079: <p>Commit messages are final: no <span class="quote">“<span class="quote">cvs admin</span>”</span> is
10080: allowed on the pkgsrc repository to change commit messages.</p>
10081: </div>
10082: <div class="sect1">
10083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10084: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 10085: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 10086: access to the pkgsrc repository.</p>
10087: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
10088: Start by adding the directory and then files in the directory. Don't
10089: forget to add the new package to the category's
10090: <code class="filename">Makefile</code>. Make sure you don't forget any files;
10091: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
10092: <pre class="programlisting">
10093: <code class="prompt">$</code> cd .../pkgsrc/category
10094: <code class="prompt">$</code> cvs add pkgname
10095: <code class="prompt">$</code> cd pkgname
10096: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
10097: <code class="prompt">$</code> cvs add patches/p*
10098: <code class="prompt">$</code> cvs status | less
1.34 wiz 10099: <code class="prompt">$</code> cvs commit
1.33 wiz 10100: <code class="prompt">$</code> cd ..
1.236 gutterid 10101: <code class="prompt">$</code> vi Makefile # add SUBDIR+=pkgname line
1.34 wiz 10102: <code class="prompt">$</code> cvs commit Makefile
1.66 asau 10103: <code class="prompt">$</code> cd pkgname
1.73 jnemeth 10104: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33 wiz 10105: </pre>
1.1 dsieger 10106: <p>The commit message of the initial import should include part of the
10107: <code class="filename">DESCR</code> file, so people reading the mailing lists know
10108: what the package is/does.</p>
1.33 wiz 10109: <p>Also mention the new package in
10110: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
10111: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
10112: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 10113: </div>
1.41 asau 10114: <div class="sect1">
1.1 dsieger 10115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10116: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 10117: <p>Please always put a concise, appropriate and relevant summary of the
10118: changes between old and new versions into the commit log when updating
10119: a package. There are various reasons for this:</p>
1.41 asau 10120: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10121: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 10122: or its information may be overwritten by newer information.</p></li>
1.23 wiz 10123: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10124: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 10125: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 10126: repository is very useful for people who read the pkgsrc-changes mailing
10127: list, so that they can make tactical decisions about when to upgrade
10128: the package.</p></li>
10129: </ul></div>
10130: <p>Please also recognize that, just because a new version of a package
10131: has been released, it should not automatically be upgraded in the CVS
10132: repository. We prefer to be conservative in the packages that are
10133: included in pkgsrc - development or beta packages are not really the
10134: best thing for most places in which pkgsrc is used. Please use your
10135: judgement about what should go into pkgsrc, and bear in mind that
10136: stability is to be preferred above new and possibly untested features.</p>
10137: </div>
1.41 asau 10138: <div class="sect1">
1.1 dsieger 10139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10140: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20 snj 10141: <p>Renaming packages is not recommended.</p>
1.175 gutterid 10142: <p>When renaming packages, be sure to fix any references to the old name
1.20 snj 10143: in other Makefiles, options, buildlink files, etc.</p>
1.167 leot 10144: <p>
1.175 gutterid 10145: Also, when renaming a package, please add
1.167 leot 10146: the package name and version pattern(s) of the previous package
10147: to <code class="varname">SUPERSEDES</code>.
1.20 snj 10148: This may be repeated for multiple renames.
10149: The new package would be an exact replacement.
1.167 leot 10150: Example:
1.20 snj 10151: </p>
1.167 leot 10152: <pre class="programlisting">
10153: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
10154: SUPERSEDES+= optcomp-[0-9]*
10155: </pre>
1.23 wiz 10156: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 10157: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
10158: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
10159: not be an exact replacement but is a suggestion for the replaced
10160: functionality.</p>
10161: </div>
1.41 asau 10162: <div class="sect1">
1.20 snj 10163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154 rillig 10164: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20 snj 10165: <p>It is preferred that packages are not renamed or moved, but if needed
10166: please follow these steps.
10167: </p>
1.23 wiz 10168: <div class="orderedlist"><ol class="orderedlist" type="1">
10169: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
10170: <li class="listitem">
1.1 dsieger 10171: <p>Remove all CVS dirs.</p>
10172: <p>Alternatively to the first two steps you can also do:</p>
10173: <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>
10174: <p>and use that for further work.</p>
10175: </li>
1.23 wiz 10176: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
10177: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
10178: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
10179: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 10180: <code class="varname">PREV_PKGPATH</code> to the previous category/package
10181: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
10182: for doing an update using pkgsrc building; for example, it can
1.246 leot 10183: search the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 10184: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
10185: new <code class="varname">PKGPATH</code> for that moved package. Note that
10186: it may have multiple matches, so the tool should also check on the
10187: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
10188: probably has no value unless <code class="varname">SUPERSEDES</code> is not
10189: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.237 gutterid 10190: <li class="listitem"><p><span class="command"><strong>cvs add</strong></span> the modified package in the new
1.1 dsieger 10191: place.</p></li>
1.23 wiz 10192: <li class="listitem">
1.1 dsieger 10193: <p>Check if any package depends on it:
10194: </p>
10195: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
10196: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
10197: </li>
1.23 wiz 10198: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
10199: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
10200: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
10201: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
10202: <li class="listitem">
1.1 dsieger 10203: <p>Commit the changed and removed files:</p>
10204: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
10205: <p>(and any packages from step 5, of course).</p>
10206: </li>
10207: </ol></div>
10208: </div>
10209: </div>
1.41 asau 10210: <div class="chapter">
1.1 dsieger 10211: <div class="titlepage"><div><div><h2 class="title">
1.154 rillig 10212: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 10213: <p>This section contains the answers to questions that may
10214: arise when you are writing a package. If you don't find your
10215: question answered here, first have a look in the other chapters,
10216: and if you still don't have the answer, ask on the
10217: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 10218: <div class="qandaset">
1.174 leot 10219: <a name="devfaq.qandaset"></a><dl>
1.154 rillig 10220: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 10221: MAKEFLAGS, .MAKEFLAGS and
10222: MAKE_FLAGS?</a>
10223: </dt>
1.154 rillig 10224: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 10225: MAKE, GMAKE and
10226: MAKE_PROGRAM?</a>
10227: </dt>
1.154 rillig 10228: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 10229: CC, PKG_CC and
10230: PKGSRC_COMPILER?</a>
10231: </dt>
1.223 nia 10232: <dt>24.4. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 10233: VARNAME=BUILDLINK_PREFIX.foo
10234: say it's empty?</a>
10235: </dt>
1.223 nia 10236: <dt>24.5. <a href="#devfaq.master_sites">What does
1.1 dsieger 10237: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
10238: don't understand the := inside
10239: it.</a>
10240: </dt>
1.223 nia 10241: <dt>24.6. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 10242: developers?</a>
10243: </dt>
1.223 nia 10244: <dt>24.7. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 10245: documentation?</a>
10246: </dt>
1.223 nia 10247: <dt>24.8. <a href="#devfaq.too-much-time">I have a little time to kill.
1.174 leot 10248: What shall I do?</a>
1.1 dsieger 10249: </dt>
10250: </dl>
1.41 asau 10251: <table border="0" style="width: 100%;">
10252: <colgroup>
1.1 dsieger 10253: <col align="left" width="1%">
1.23 wiz 10254: <col>
1.41 asau 10255: </colgroup>
1.1 dsieger 10256: <tbody>
1.41 asau 10257: <tr class="question">
1.1 dsieger 10258: <td align="left" valign="top">
1.174 leot 10259: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1 dsieger 10260: </td>
10261: <td align="left" valign="top"><p>What is the difference between
10262: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
10263: <code class="varname">MAKE_FLAGS</code>?</p></td>
10264: </tr>
10265: <tr class="answer">
10266: <td align="left" valign="top"></td>
1.223 nia 10267: <td align="left" valign="top">
10268: <p><code class="varname">MAKEFLAGS</code> are the flags passed
1.246 leot 10269: to the pkgsrc-internal invocations of <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.</p>
1.223 nia 10270: <p><code class="varname">MAKE_FLAGS</code> are the flags that are
10271: passed to the <code class="varname">MAKE_PROGRAM</code> when building the
10272: package.</p>
10273: <p><code class="varname">.MAKEFLAGS</code> is an internal variable of
10274: <span class="command"><strong>bmake</strong></span> and should not be used by
10275: packages.</p>
10276: </td>
1.1 dsieger 10277: </tr>
1.41 asau 10278: <tr class="question">
1.1 dsieger 10279: <td align="left" valign="top">
1.174 leot 10280: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1 dsieger 10281: </td>
10282: <td align="left" valign="top"><p>What is the difference between
10283: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
10284: <code class="varname">MAKE_PROGRAM</code>?</p></td>
10285: </tr>
10286: <tr class="answer">
10287: <td align="left" valign="top"></td>
1.223 nia 10288: <td align="left" valign="top">
10289: <p><code class="varname">MAKE</code> is the path to the
1.246 leot 10290: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.223 nia 10291: infrastructure.</p>
10292: <p><code class="varname">GMAKE</code> is the path to GNU Make, but you
10293: need to say <code class="varname">USE_TOOLS+=gmake</code> to use
10294: that.</p>
10295: <p><code class="varname">MAKE_PROGRAM</code> is the path to the Make
10296: program that is used for building the package.</p>
10297: </td>
1.1 dsieger 10298: </tr>
1.41 asau 10299: <tr class="question">
1.1 dsieger 10300: <td align="left" valign="top">
1.174 leot 10301: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1 dsieger 10302: </td>
10303: <td align="left" valign="top"><p>What is the difference between
10304: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
10305: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
10306: </tr>
10307: <tr class="answer">
10308: <td align="left" valign="top"></td>
10309: <td align="left" valign="top">
1.223 nia 10310: <p><code class="varname">CC</code> is the path to the real C
10311: compiler, which can be configured by the pkgsrc user.</p>
10312: <p><code class="varname">PKG_CC</code> is the path to the compiler
10313: wrapper.</p>
10314: <p><code class="varname">PKGSRC_COMPILER</code> is
10315: <span class="emphasis"><em>not</em></span> a path to a compiler, but the type of
10316: compiler that should be used. See
10317: <code class="filename">mk/compiler.mk</code> for more information about
10318: the latter variable.</p>
1.1 dsieger 10319: </td>
10320: </tr>
1.41 asau 10321: <tr class="question">
1.1 dsieger 10322: <td align="left" valign="top">
1.223 nia 10323: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.4.</b></p>
1.1 dsieger 10324: </td>
1.10 hubertf 10325: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 10326: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
10327: say it's empty?</p></td>
10328: </tr>
10329: <tr class="answer">
10330: <td align="left" valign="top"></td>
10331: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 10332: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
10333: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 10334: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 10335: command.</p></td>
10336: </tr>
1.41 asau 10337: <tr class="question">
1.1 dsieger 10338: <td align="left" valign="top">
1.223 nia 10339: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.5.</b></p>
1.1 dsieger 10340: </td>
10341: <td align="left" valign="top"><p>What does
1.108 rillig 10342: <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
10343: don't understand the <code class="code">:=</code> inside
1.1 dsieger 10344: it.</p></td>
10345: </tr>
10346: <tr class="answer">
10347: <td align="left" valign="top"></td>
1.223 nia 10348: <td align="left" valign="top"><p>The <code class="code">:=</code> is not an
10349: assignment operator, even though it may look like one.
1.1 dsieger 10350: Instead, it is a degenerate form of
1.108 rillig 10351: <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.246 leot 10352: which is documented in the <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108 rillig 10353: commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1 dsieger 10354: case of <code class="varname">MASTER_SITE_*</code>,
10355: <em class="replaceable"><code>old_string</code></em> is the empty string and
10356: <em class="replaceable"><code>new_string</code></em> is
1.108 rillig 10357: <code class="code">package/</code>. That's where the
10358: <code class="code">:</code> and the <code class="code">=</code> fall
1.1 dsieger 10359: together.</p></td>
10360: </tr>
1.41 asau 10361: <tr class="question">
1.1 dsieger 10362: <td align="left" valign="top">
1.223 nia 10363: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.6.</b></p>
1.1 dsieger 10364: </td>
10365: <td align="left" valign="top"><p>Which mailing lists are there for package
10366: developers?</p></td>
10367: </tr>
10368: <tr class="answer">
10369: <td align="left" valign="top"></td>
1.41 asau 10370: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174 leot 10371: <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 10372: <dd><p>This is a list for technical discussions related
10373: to pkgsrc development, e.g. soliciting feedback for changes to
10374: pkgsrc infrastructure, proposed new features, questions related
10375: to porting pkgsrc to a new platform, advice for maintaining a
10376: package, patches that affect many packages, help requests moved
10377: from pkgsrc-users when an infrastructure bug is found,
10378: etc.</p></dd>
1.174 leot 10379: <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 10380: <dd><p>All bug reports in category "pkg" sent with
1.246 leot 10381: <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/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 10382: directly; use one of the other mailing
10383: lists.</p></dd>
10384: </dl></div></td>
10385: </tr>
1.41 asau 10386: <tr class="question">
1.1 dsieger 10387: <td align="left" valign="top">
1.223 nia 10388: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.7.</b></p>
1.1 dsieger 10389: </td>
10390: <td align="left" valign="top"><p>Where is the pkgsrc
10391: documentation?</p></td>
10392: </tr>
10393: <tr class="answer">
10394: <td align="left" valign="top"></td>
10395: <td align="left" valign="top">
10396: <p>There are many places where you can find
10397: documentation about pkgsrc:</p>
1.41 asau 10398: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10399: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 10400: of chapters that explain large parts of pkgsrc, but some
10401: chapters tend to be outdated. Which ones they are is hard to
10402: say.</p></li>
1.174 leot 10403: <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 10404: about certain features, announcements of new parts of the pkgsrc
10405: infrastructure and sometimes even announcements that a certain
10406: feature has been marked as obsolete. The benefit here is that
10407: each message has a date appended to it.</p></li>
1.23 wiz 10408: <li class="listitem"><p>Many of the files in the
1.1 dsieger 10409: <code class="filename">mk/</code> directory start with a comment that
10410: describes the purpose of the file and how it can be used by the
10411: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 10412: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 10413: help</strong></span>.</p></li>
1.23 wiz 10414: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 10415: information, but they tend to be highly abbreviated, especially
10416: for actions that occur often. Some contain a detailed
10417: description of what has changed, but they are geared towards the
10418: other pkgsrc developers, not towards an average pkgsrc user.
10419: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10420: don't know what has been before, these messages may not be worth
10421: too much to you.</p></li>
1.23 wiz 10422: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10423: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 10424: mind of the developer who wrote the code. To get this
1.10 hubertf 10425: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 10426: to see who has written it and ask on the
10427: <code class="literal">tech-pkg</code> mailing list, so that others can
10428: find your questions later (see above). To be sure that the
10429: developer in charge reads the mail, you may CC him or
10430: her.</p></li>
10431: </ul></div>
1.184 rillig 10432: </td>
10433: </tr>
10434: <tr class="question">
10435: <td align="left" valign="top">
1.223 nia 10436: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.8.</b></p>
1.184 rillig 10437: </td>
1.223 nia 10438: <td align="left" valign="top"><p>I have a little time to kill.
1.184 rillig 10439: What shall I do?</p></td>
10440: </tr>
10441: <tr class="answer">
10442: <td align="left" valign="top"></td>
10443: <td align="left" valign="top">
10444: <p>This is not really an FAQ yet, but here's the answer
10445: anyway.</p>
1.41 asau 10446: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184 rillig 10447: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.207 leot 10448: <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 10449: will tell you about newer versions of installed packages that are
10450: available, but not yet updated in pkgsrc.</p></li>
10451: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
10452: — it contains a list of suggested new packages and a list of
10453: cleanups and enhancements for pkgsrc that would be nice to
10454: have.</p></li>
10455: <li class="listitem"><p>Review packages for which review was requested on
10456: the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
10457: mailing list.</p></li>
1.1 dsieger 10458: </ul></div>
1.184 rillig 10459: </td>
1.1 dsieger 10460: </tr>
10461: </tbody>
1.184 rillig 10462: </table>
1.1 dsieger 10463: </div>
10464: </div>
10465: </div>
1.41 asau 10466: <div class="part">
1.1 dsieger 10467: <div class="titlepage"><div><div><h1 class="title">
10468: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10469: <div class="partintro">
1.1 dsieger 10470: <div></div>
10471: <p>This part of the guide deals with everything
10472: from the infrastructure that is behind the interfaces described
10473: in the developer's guide. A casual package maintainer should not
10474: need anything from this part.</p>
10475: <div class="toc">
10476: <p><b>Table of Contents</b></p>
1.100 leot 10477: <dl class="toc">
1.184 rillig 10478: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10479: <dd><dl>
1.184 rillig 10480: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10481: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10482: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10483: <dd><dl>
1.184 rillig 10484: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10485: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10486: </dl></dd>
1.184 rillig 10487: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10488: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10489: <dd><dl>
1.184 rillig 10490: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10491: <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 10492: </dl></dd>
1.184 rillig 10493: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10494: <dd><dl>
1.184 rillig 10495: <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>
10496: <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 10497: </dl></dd>
10498: </dl></dd>
1.184 rillig 10499: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1 dsieger 10500: <dd><dl>
1.184 rillig 10501: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10502: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10503: <dd><dl>
1.184 rillig 10504: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10505: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10506: </dl></dd>
10507: </dl></dd>
1.184 rillig 10508: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
10509: <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 10510: </dl>
10511: </div>
10512: </div>
1.41 asau 10513: <div class="chapter">
1.1 dsieger 10514: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10515: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10516: <div class="toc">
10517: <p><b>Table of Contents</b></p>
1.100 leot 10518: <dl class="toc">
1.184 rillig 10519: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
10520: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
10521: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1 dsieger 10522: <dd><dl>
1.184 rillig 10523: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
10524: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1 dsieger 10525: </dl></dd>
1.184 rillig 10526: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
10527: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10528: <dd><dl>
1.184 rillig 10529: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
10530: <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 10531: </dl></dd>
1.184 rillig 10532: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10533: <dd><dl>
1.184 rillig 10534: <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>
10535: <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 10536: </dl></dd>
10537: </dl>
10538: </div>
10539: <p>The pkgsrc infrastructure consists of many small Makefile
10540: fragments. Each such fragment needs a properly specified
10541: interface. This chapter explains how such an interface looks
10542: like.</p>
1.41 asau 10543: <div class="sect1">
1.1 dsieger 10544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10545: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10546: <p>Whenever a variable is defined in the pkgsrc
10547: infrastructure, the location and the way of definition provide
10548: much information about the intended use of that variable.
10549: Additionally, more documentation may be found in a header
10550: comment or in this pkgsrc guide.</p>
10551: <p>A special file is
10552: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10553: variables that are intended to be user-defined. They are either
10554: defined using the <code class="literal">?=</code> operator or they are
10555: left undefined because defining them to anything would
1.23 wiz 10556: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10557: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10558: file.</p>
10559: <p>Outside this file, the following conventions apply:
10560: Variables that are defined using the <code class="literal">?=</code>
10561: operator may be overridden by a package.</p>
10562: <p>Variables that are defined using the <code class="literal">=</code>
10563: operator may be used read-only at run-time.</p>
10564: <p>Variables whose name starts with an underscore must not be
10565: accessed outside the pkgsrc infrastructure at all. They may
10566: change without further notice.</p>
1.41 asau 10567: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10568: <h3 class="title">Note</h3>
10569: <p>These conventions are currently not applied
10570: consistently to the complete pkgsrc
10571: infrastructure.</p>
10572: </div>
10573: </div>
1.41 asau 10574: <div class="sect1">
1.1 dsieger 10575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10576: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10577: <p>All variables that contain lists of things should default
10578: to being empty. Two examples that do not follow this rule are
10579: <code class="varname">USE_LANGUAGES</code> and
10580: <code class="varname">DISTFILES</code>. These variables cannot simply be
10581: modified using the <code class="literal">+=</code> operator in package
10582: <code class="filename">Makefile</code>s (or other files included by
10583: them), since there is no guarantee whether the variable is
10584: already set or not, and what its value is. In the case of
1.23 wiz 10585: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10586: the default value and just define it as in the following
10587: example.</p>
10588: <pre class="programlisting">
10589: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10590: </pre>
10591: <p>Because of the selection of this default value, the same
10592: value appears in many package Makefiles. Similarly for
10593: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10594: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10595: doesn't stand out. Nevertheless it is mentioned in many
10596: files.</p>
10597: </div>
1.41 asau 10598: <div class="sect1">
1.1 dsieger 10599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10600: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.41 asau 10601: <div class="sect2">
1.1 dsieger 10602: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10603: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.1 dsieger 10604: <p>Variable evaluation takes place either at load time or at
10605: runtime, depending on the context in which they occur. The
10606: contexts where variables are evaluated at load time are:</p>
1.41 asau 10607: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10608: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10609: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10610: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10611: <code class="literal">.for</code>,</p></li>
1.23 wiz 10612: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10613: </ul></div>
10614: <p>A special exception are references to the iteration
10615: variables of <code class="literal">.for</code> loops, which are expanded
10616: inline, no matter in which context they appear.</p>
10617: <p>As the values of variables may change during load time,
10618: care must be taken not to evaluate them by accident. Typical
10619: examples for variables that should not be evaluated at load time
10620: are <code class="varname">DEPENDS</code> and
10621: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10622: clear, here is an example:</p>
10623: <pre class="programlisting">
10624: CONFIGURE_ARGS= # none
10625: CFLAGS= -O
10626: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10627:
10628: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10629:
10630: CFLAGS+= -Wall
1.111 sevan 10631: </pre>
1.1 dsieger 10632: <p>This code shows how the use of the <code class="literal">:=</code>
10633: operator can quickly lead to unexpected results. The first
10634: paragraph is fairly common code. The second paragraph evaluates
10635: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10636: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10637: <code class="literal">-Wall</code> is appended to the
10638: <code class="varname">CFLAGS</code>, but this addition will not appear in
10639: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10640: paragraphs from above typically occur in completely unrelated
10641: files.</p>
10642: </div>
1.41 asau 10643: <div class="sect2">
1.1 dsieger 10644: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10645: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10646: <p>After all the files have been loaded, the values of the
10647: variables cannot be changed anymore. Variables that are used in
10648: the shell commands are expanded at this point.</p>
10649: </div>
10650: </div>
1.41 asau 10651: <div class="sect1">
1.1 dsieger 10652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10653: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10654: <p>There are many ways in which the definition and use of a
1.108 rillig 10655: variable can be restricted in order to detect bugs and violations
10656: of the (mostly unwritten) policies. A package can be checked with
10657: <code class="literal">pkglint -Wall</code> to see whether it meets these
10658: rules.</p>
1.1 dsieger 10659: </div>
1.41 asau 10660: <div class="sect1">
1.1 dsieger 10661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10662: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10663: <p>Most of the <code class="filename">.mk</code> files fall into one
10664: of the following classes. Cases where a file falls into more
10665: than one class should be avoided as it often leads to subtle
10666: bugs.</p>
1.41 asau 10667: <div class="sect2">
1.1 dsieger 10668: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10669: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10670: <p>In a traditional imperative programming language some of
10671: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10672: procedures. They take some input parameters and—after
10673: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10674: variables in <code class="filename">Makefile</code>s have global scope
10675: care must be taken not to use parameter names that have already
10676: another meaning. For example, <code class="varname">PKGNAME</code> is a
10677: bad choice for a parameter name.</p>
10678: <p>Procedures are completely evaluated at preprocessing time.
10679: That is, when calling a procedure all input parameters must be
10680: completely resolvable. For example,
10681: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10682: parameter since it is very likely that further text will be
10683: added after calling the procedure, which would effectively apply
10684: the procedure to only a part of the variable. Also, references
1.108 rillig 10685: to other variables will be modified after calling the
1.1 dsieger 10686: procedure.</p>
10687: <p>A procedure can declare its output parameters either as
10688: suitable for use in preprocessing directives or as only
10689: available at runtime. The latter alternative is for variables
10690: that contain references to other runtime variables.</p>
10691: <p>Procedures shall be written such that it is possible to
10692: call the procedure more than once. That is, the file must not
10693: contain multiple-inclusion guards.</p>
10694: <p>Examples for procedures are
10695: <code class="filename">mk/bsd.options.mk</code> and
10696: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10697: that the parameters are evaluated at load time, they should be
10698: assigned using the <code class="literal">:=</code> operator, which should
10699: be used only for this purpose.</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.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10704: <p>Action files take some input parameters and may define
10705: runtime variables. They shall not define loadtime variables.
10706: There are action files that are included implicitly by the
10707: pkgsrc infrastructure, while other must be included
10708: explicitly.</p>
10709: <p>An example for action files is
10710: <code class="filename">mk/subst.mk</code>.</p>
10711: </div>
10712: </div>
1.41 asau 10713: <div class="sect1">
1.1 dsieger 10714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10715: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10716: <p>Package <code class="filename">Makefile</code>s usually consist of
10717: a set of variable definitions, and include the file
10718: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10719: Before that, they may also include various other
10720: <code class="filename">*.mk</code> files if they need to query the
10721: availability of certain features like the type of compiler or
10722: the X11 implementation. Due to the heavy use of preprocessor
10723: directives like <code class="literal">.if</code> and
10724: <code class="literal">.for</code>, the order in which the files are loaded
10725: matters.</p>
10726: <p>This section describes at which point the various files
10727: are loaded and gives reasons for that order.</p>
1.41 asau 10728: <div class="sect2">
1.1 dsieger 10729: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10730: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10731: </h3></div></div></div>
10732: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10733: is to define some essential variables like
10734: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10735: <code class="varname">MACHINE_ARCH</code>.</p>
10736: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10737: 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 10738: After that, those variables
1.1 dsieger 10739: that have not been overridden by the user are loaded from
10740: <code class="filename">mk/defaults/mk.conf</code>.</p>
10741: <p>After the user settings, the system settings and platform
10742: settings are loaded, which may override the user
10743: settings.</p>
10744: <p>Then, the tool definitions are loaded. The tool wrappers
10745: are not yet in effect. This only happens when building a
10746: package, so the proper variables must be used instead of the
10747: direct tool names.</p>
10748: <p>As the last steps, some essential variables from the
10749: wrapper and the package system flavor are loaded, as well as the
10750: variables that have been cached in earlier phases of a package
10751: build.</p>
10752: </div>
1.41 asau 10753: <div class="sect2">
1.1 dsieger 10754: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10755: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10756: </h3></div></div></div>
10757: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10758: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10759: loaded, which fill default values for those variables that have
10760: not been defined by the package. These variables may later
10761: be used even in unrelated files.</p>
10762: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10763: provides the target <code class="literal">error-check</code> that is added
10764: as a special dependency to all other targets that use
10765: <code class="varname">DELAYED_ERROR_MSG</code> or
10766: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10767: <p>Then, the package-specific hacks from
10768: <code class="filename">hacks.mk</code> are included.</p>
10769: <p>Then, various other files follow. Most of them don't have
10770: any dependencies on what they need to have included before or
10771: after them, though some do.</p>
10772: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10773: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10774: restricts the use of these variables to all the files that have
10775: been included before. Appearances in later files will be
10776: silently ignored.</p>
10777: <p>Then, the files for the main targets are included, in the
10778: order of later execution, though the actual order should not
10779: matter.</p>
10780: <p>At last, some more files are included that don't set any
10781: interesting variables but rather just define make targets to be
10782: executed.</p>
10783: </div>
10784: </div>
10785: </div>
1.41 asau 10786: <div class="chapter">
1.1 dsieger 10787: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10788: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.1 dsieger 10789: <div class="toc">
10790: <p><b>Table of Contents</b></p>
1.100 leot 10791: <dl class="toc">
1.184 rillig 10792: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
10793: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1 dsieger 10794: <dd><dl>
1.184 rillig 10795: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
10796: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1 dsieger 10797: </dl></dd>
10798: </dl>
10799: </div>
10800: <p>The pkgsrc infrastructure consists of a large codebase,
10801: and there are many corners where every little bit of a file is
10802: well thought out, making pkgsrc likely to fail as soon as
10803: anything is changed near those parts. To prevent most changes
10804: from breaking anything, a suite of regression tests should go
10805: along with every important part of the pkgsrc infrastructure.
10806: This chapter describes how regression tests work in pkgsrc and
10807: how you can add new tests.</p>
1.41 asau 10808: <div class="sect1">
1.1 dsieger 10809: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10810: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.207 leot 10811: <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 10812: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10813: can simply run that command, which will run all tests in the
1.168 rillig 10814: <code class="filename">regress/</code> directory.</p>
1.1 dsieger 10815: </div>
1.41 asau 10816: <div class="sect1">
1.1 dsieger 10817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10818: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.168 rillig 10819: <p>Every directory in the <code class="filename">regress/</code>
10820: directory that contains a file called <code class="filename">spec</code>
1.1 dsieger 10821: is considered a regression test. This file is a shell program
1.10 hubertf 10822: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10823: The following functions can be overridden to suit your
10824: needs.</p>
1.41 asau 10825: <div class="sect2">
1.1 dsieger 10826: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10827: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.108 rillig 10828: <p>These functions do not take any parameters. Although they
10829: are called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, they don't stop at the
1.174 leot 10830: first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108 rillig 10831: question</a> for details.</p>
1.41 asau 10832: <div class="variablelist"><dl class="variablelist">
1.108 rillig 10833: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1 dsieger 10834: <dd><p>This function prepares the environment for the
10835: test. By default it does nothing.</p></dd>
1.108 rillig 10836: <dt><span class="term"><code class="varname">do_test</code></span></dt>
10837: <dd>
10838: <p>This function runs the actual test. By default,
1.1 dsieger 10839: it calls <code class="varname">TEST_MAKE</code> with the arguments
10840: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10841: error messages into the file
1.108 rillig 10842: <code class="varname">TEST_OUTFILE</code>.</p>
10843: <p>When defining this function, make sure that all output that
10844: needs to be checked is written to the correct output file.
10845: Example:</p>
10846: <pre class="programlisting">
10847: do_test() {
1.112 rillig 10848: echo "Example output"
1.108 rillig 10849: } 1>$TEST_OUTFILE 2>&1
10850: </pre>
10851: </dd>
10852: <dt><span class="term"><code class="varname">check_result</code></span></dt>
10853: <dd>
10854: <p>This function is run after the test and is
1.1 dsieger 10855: typically used to compare the actual output from the one that is
10856: expected. It can make use of the various helper functions from
1.108 rillig 10857: the next section. Example:</p>
10858: <pre class="programlisting">
10859: check_result() {
1.112 rillig 10860: exit_status 0
10861: output_require "Example"
10862: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10863: output_prohibit "no such file or directory"
1.168 rillig 10864: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 10865: }
10866: </pre>
10867: </dd>
10868: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1 dsieger 10869: <dd><p>This function cleans everything up after the
10870: test has been run. By default it does nothing.</p></dd>
10871: </dl></div>
10872: </div>
1.41 asau 10873: <div class="sect2">
1.1 dsieger 10874: <div class="titlepage"><div><div><h3 class="title">
1.184 rillig 10875: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.41 asau 10876: <div class="variablelist"><dl class="variablelist">
1.168 rillig 10877: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
10878: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108 rillig 10879: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1 dsieger 10880: <dd><p>This function compares the exitcode of the
1.108 rillig 10881: <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1 dsieger 10882: If they differ, the test will fail.</p></dd>
1.108 rillig 10883: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
10884: <dd>
10885: <p>This function checks for each of its parameters
10886: if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1 dsieger 10887: extended regular expression. If it does not, the test will
1.108 rillig 10888: fail. Example:</p>
10889: <pre class="programlisting">
10890: output_require "looks fine"
10891: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
10892: </pre>
10893: </dd>
1.177 leot 10894: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1 dsieger 10895: <dd><p>This function checks for each of its parameters
1.10 hubertf 10896: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10897: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10898: If any of the regular expressions matches, the test will
10899: fail.</p></dd>
10900: </dl></div>
10901: </div>
10902: </div>
10903: </div>
1.41 asau 10904: <div class="chapter">
1.1 dsieger 10905: <div class="titlepage"><div><div><h2 class="title">
1.184 rillig 10906: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10907: <div class="toc">
10908: <p><b>Table of Contents</b></p>
1.184 rillig 10909: <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 10910: </div>
10911: <p>The pkgsrc system has already been ported to many
10912: operating systems, hardware architectures and compilers. This
10913: chapter explains the necessary steps to make pkgsrc even more
10914: portable.</p>
1.41 asau 10915: <div class="sect1">
1.1 dsieger 10916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184 rillig 10917: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10918: <p>To port pkgsrc to a new operating system (called
10919: <code class="literal">MyOS</code> in this example), you need to touch the
10920: following files:</p>
1.41 asau 10921: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10922: <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>
10923: <dd><p>This file contains some basic definitions, for
10924: example the name of the C
10925: compiler.</p></dd>
10926: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10927: <dd><p>Insert code that defines the variables
10928: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
1.212 wiz 10929: <code class="varname">OPSYS_VERSION</code>, <code class="varname">LOWER_VENDOR</code>,
1.1 dsieger 10930: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10931: <code class="varname">APPEND_ELF</code>, and the other variables that
10932: appear in this file.</p></dd>
10933: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10934: <dd><p>This file contains the platform-specific
10935: definitions that are used by pkgsrc. Start by copying one of the
10936: other files and edit it to your
10937: needs.</p></dd>
10938: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10939: <dd><p>This file defines the paths to all the tools
10940: that are needed by one or the other package in pkgsrc, as well
10941: as by pkgsrc itself. Find out where these tools are on your
10942: platform and add them.</p></dd>
10943: </dl></div>
10944: <p>Now, you should be able to build some basic packages, like
1.207 leot 10945: <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 10946: </div>
10947: </div>
10948: </div>
1.41 asau 10949: <div class="appendix">
10950: <div class="titlepage"><div><div><h1 class="title">
10951: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10952: <div class="toc">
10953: <p><b>Table of Contents</b></p>
1.100 leot 10954: <dl class="toc">
1.1 dsieger 10955: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10956: <dd><dl>
10957: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10958: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10959: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172 rillig 10960: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1 dsieger 10961: </dl></dd>
10962: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10963: </dl>
10964: </div>
10965: <p>We checked to find a piece of software that wasn't in the packages
10966: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10967: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10968: present in the tree is beyond us, but it's useful for the purposes of
10969: this exercise.</p>
1.41 asau 10970: <div class="sect1">
1.1 dsieger 10971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10972: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10973: <div class="sect2">
1.1 dsieger 10974: <div class="titlepage"><div><div><h3 class="title">
10975: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10976: <pre class="programlisting">
10977: # $NetBSD$
10978: #
10979:
10980: DISTNAME= bison-1.25
10981: CATEGORIES= devel
1.171 rillig 10982: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 10983:
1.29 dholland 10984: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 10985: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 10986: COMMENT= GNU yacc clone
10987:
10988: GNU_CONFIGURE= yes
1.46 wiz 10989: INFO_FILES= yes
1.1 dsieger 10990:
10991: .include "../../mk/bsd.pkg.mk"
10992: </pre>
10993: </div>
1.41 asau 10994: <div class="sect2">
1.1 dsieger 10995: <div class="titlepage"><div><div><h3 class="title">
10996: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10997: <pre class="programlisting">
10998: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.246 leot 10999: improvements. Why you would want this when Berkeley <a class="citerefentry" href="//man.NetBSD.org/NetBSD-9.3/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 11000: of the NetBSD source tree is beyond me.
11001: </pre>
11002: </div>
1.41 asau 11003: <div class="sect2">
1.1 dsieger 11004: <div class="titlepage"><div><div><h3 class="title">
11005: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
11006: <pre class="programlisting">
11007: @comment $NetBSD$
11008: bin/bison
11009: man/man1/bison.1.gz
11010: share/bison.simple
11011: share/bison.hairy
11012: </pre>
11013: </div>
1.41 asau 11014: <div class="sect2">
1.1 dsieger 11015: <div class="titlepage"><div><div><h3 class="title">
1.172 rillig 11016: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1 dsieger 11017: <p>The NetBSD package system comes with
1.207 leot 11018: <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 11019: which helps to check the contents of these
11020: files. After installation it is quite easy to use, just change to the
1.171 rillig 11021: directory of the package you wish to examine and run
1.10 hubertf 11022: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 11023: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171 rillig 11024: ERROR: Makefile: Each package must define its LICENSE.
11025: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
11026: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
11027: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
11028: 1 error, 2 warnings and 1 note found.
11029: (Run "pkglint -e" to show explanations.)
11030: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 11031: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1 dsieger 11032: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170 rillig 11033: more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1 dsieger 11034: -Wall</strong></span> for a very thorough check.</p>
11035: </div>
11036: </div>
1.41 asau 11037: <div class="sect1">
1.1 dsieger 11038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11039: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
11040: <p>Create the directory where the package lives,
11041: plus any auxiliary directories:</p>
11042: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
11043: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
11044: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
11045: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
11046: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.184 rillig 11047: <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 11048: then continue with fetching the distfile:</p>
11049: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
11050: >> bison-1.25.tar.gz doesn't seem to exist on this system.
11051: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
11052: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11053: ftp: Error retrieving file: 500 Internal error
11054:
11055: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
11056: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11057: ftp: Error retrieving file: 500 Internal error
11058:
11059: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
11060: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
11061: Successfully retrieved file.</pre>
11062: <p>Generate the checksum of the distfile into
11063: <code class="filename">distinfo</code>:</p>
11064: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
11065: <p>Now compile:</p>
11066: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11067: >> Checksum OK for bison-1.25.tar.gz.
11068: ===> Extracting for bison-1.25
11069: ===> Patching for bison-1.25
11070: ===> Ignoring empty patch directory
11071: ===> Configuring for bison-1.25
11072: creating cache ./config.cache
11073: checking for gcc... cc
11074: checking whether we are using GNU C... yes
11075: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
11076: checking how to run the C preprocessor... cc -E
11077: checking for minix/config.h... no
11078: checking for POSIXized ISC... no
11079: checking whether cross-compiling... no
11080: checking for ANSI C header files... yes
11081: checking for string.h... yes
11082: checking for stdlib.h... yes
11083: checking for memory.h... yes
11084: checking for working const... yes
11085: checking for working alloca.h... no
11086: checking for alloca... yes
11087: checking for strerror... yes
11088: updating cache ./config.cache
11089: creating ./config.status
11090: creating Makefile
11091: ===> Building for bison-1.25
11092: 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
11093: 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
11094: 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
11095: 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
11096: 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
11097: 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
11098: 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
11099: 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
11100: 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
11101: 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
11102: 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
11103: 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
11104: 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
11105: 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
11106: 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
11107: 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
11108: 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
11109: 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
11110: 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
11111: 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
11112: 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
11113: 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
11114: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
11115: rm -f bison.s1
11116: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
11117: <p>Everything seems OK, so install the files:</p>
11118: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11119: >> Checksum OK for bison-1.25.tar.gz.
11120: ===> Installing for bison-1.25
11121: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
11122: rm -f /usr/pkg/bin/bison
11123: cd /usr/pkg/share; rm -f bison.simple bison.hairy
11124: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
11125: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11126: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11127: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11128: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11129: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
11130: ===> Registering installation for bison-1.25</pre>
11131: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 11132: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 11133: binary package, do this now:</p>
11134: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11135: >> Checksum OK for bison-1.25.tar.gz.
11136: ===> Building package for bison-1.25
11137: Creating package bison-1.25.tgz
11138: Registering depends:.
11139: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11140: <p>Now that you don't need the source and object files
11141: any more, clean up:</p>
11142: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11143: ===> Cleaning for bison-1.25</pre>
11144: </div>
11145: </div>
1.41 asau 11146: <div class="appendix">
11147: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 11148: <a name="hardening"></a>Appendix B. Security hardening</h1></div></div></div>
1.1 dsieger 11149: <div class="toc">
11150: <p><b>Table of Contents</b></p>
1.100 leot 11151: <dl class="toc">
1.207 leot 11152: <dt><span class="sect1"><a href="#hardening.mechanisms">B.1. Mechanisms</a></span></dt>
11153: <dd><dl>
11154: <dt><span class="sect2"><a href="#hardening.mechanisms.enabled">B.1.1. Enabled by default</a></span></dt>
11155: <dt><span class="sect2"><a href="#hardening.mechanisms.disabled">B.1.2. Not enabled by default</a></span></dt>
11156: </dl></dd>
11157: <dt><span class="sect1"><a href="#hardening.caveats">B.2. Caveats</a></span></dt>
11158: <dd><dl>
11159: <dt><span class="sect2"><a href="#hardening.caveats.pie">B.2.1. Problems with PKGSRC_MKPIE</a></span></dt>
11160: <dt><span class="sect2"><a href="#hardening.caveats.fortify">B.2.2. Problems with PKGSRC_USE_FORTIFY</a></span></dt>
11161: <dt><span class="sect2"><a href="#hardening.caveats.relro">B.2.3. Problems with PKGSRC_USE_RELRO</a></span></dt>
11162: <dt><span class="sect2"><a href="#hardening.caveats.ssp">B.2.4. Problems with PKGSRC_USE_SSP</a></span></dt>
11163: </dl></dd>
11164: <dt><span class="sect1"><a href="#hardening.audit">B.3. Auditing the system</a></span></dt>
11165: <dd><dl>
11166: <dt><span class="sect2"><a href="#hardening.audit.pie">B.3.1. Checking for PIE</a></span></dt>
11167: <dt><span class="sect2"><a href="#hardening.audit.relropartial">B.3.2. Checking for partial RELRO</a></span></dt>
11168: <dt><span class="sect2"><a href="#hardening.audit.relrofull">B.3.3. Checking for full RELRO</a></span></dt>
11169: <dt><span class="sect2"><a href="#hardening.audit.ssp">B.3.4. Checking for SSP</a></span></dt>
11170: </dl></dd>
1.1 dsieger 11171: </dl>
11172: </div>
1.207 leot 11173: <p>
11174: A number of mechanisms are available in pkgsrc to improve the security of the
11175: resulting system. This page describes the mechanisms, and gives hints
11176: about detecting and fixing problems.
11177: </p>
11178: <p>
11179: Mechanisms can be enabled individually in
11180: <code class="filename">mk.conf</code>, and are
11181: individually described below.
11182: </p>
11183: <p>
11184: Typically, a feature will cause some programs to fail to build or work
11185: when first enabled. This can be due to latent problems in the
11186: program, and can be due to other reasons. After enough testing to
11187: have confidence that user problems will be quite rare, individual
11188: mechanisms will be enabled by default.
11189: </p>
11190: <p>
11191: For each mechanism, see the Caveats section below for an explanation
11192: of what might go wrong at compile time and at run time, and how to
11193: notice and address these problems.
11194: </p>
1.41 asau 11195: <div class="sect1">
1.1 dsieger 11196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11197: <a name="hardening.mechanisms"></a>B.1. Mechanisms</h2></div></div></div>
11198: <div class="sect2">
11199: <div class="titlepage"><div><div><h3 class="title">
11200: <a name="hardening.mechanisms.enabled"></a>B.1.1. Enabled by default</h3></div></div></div>
11201: <div class="sect3">
11202: <div class="titlepage"><div><div><h4 class="title">
11203: <a name="hardening.mechanisms.enabled.fortify"></a>B.1.1.1. PKGSRC_USE_FORTIFY</h4></div></div></div>
11204: <p>
11205: This allows substitute wrappers to be used for some commonly used
11206: library functions that do not have built-in bounds checking - but
11207: could in some cases.
11208: </p>
11209: <p>
11210: Two mitigation levels are available:
11211: </p>
11212: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11213: <li class="listitem"><p>"weak" only enables checks at compile-time.</p></li>
11214: <li class="listitem"><p>"strong" enables checks at compile-time and runtime.</p></li>
11215: </ul></div>
11216: <p>
11217: "strong" has been enabled by default since pkgsrc-2017Q3.
11218: </p>
11219: </div>
11220: <div class="sect3">
11221: <div class="titlepage"><div><div><h4 class="title">
11222: <a name="hardening.mechanisms.enabled.ssp"></a>B.1.1.2. PKGSRC_USE_SSP</h4></div></div></div>
11223: <p>
11224: This enables a stack-smashing protection mitigation. It is done by adding a
11225: guard variable to functions with vulnerable objects. The guards are initialized
11226: when a function is entered and then checked when the function exits. The guard
11227: check will fail and the program forcibly exited if the variable was modified in
11228: the meantime. This can happen in case of buffer overflows or memory corruption,
11229: and therefore exposing these bugs.
11230: </p>
11231: <p>
11232: Different mitigation levels are available:
11233: </p>
11234: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11235: <li class="listitem"><p>"yes", which will only protect functions considered vulnerable
11236: by the compiler;</p></li>
11237: <li class="listitem"><p>"all", which will protect every function;</p></li>
11238: <li class="listitem"><p>"strong", the default, which will apply a better balance between the
11239: two settings above.</p></li>
11240: </ul></div>
11241: <p>
11242: This mitigation is supported by both GCC and clang. It may be supported in
11243: additional compilers, possibly under a different name. It is particularly useful
11244: for unsafe programming languages, such as C/C++.
11245: </p>
11246: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11247: <li class="listitem"><p>"yes" is enabled by default where known supported since pkgsrc-2017Q3.</p></li>
11248: <li class="listitem"><p>"strong" is enabled by default where known supported since pkgsrc-2021Q4.</p></li>
11249: </ul></div>
11250: <p>More details can be found here:</p>
11251: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11252: <a class="ulink" href="https://en.wikipedia.org/wiki/Buffer_overflow_protection" target="_top">Buffer overflow protection on Wikipedia</a>
11253: </p></li></ul></div>
11254: </div>
11255: <div class="sect3">
11256: <div class="titlepage"><div><div><h4 class="title">
11257: <a name="hardening.mechanisms.enabled.pie"></a>B.1.1.3. PKGSRC_MKPIE</h4></div></div></div>
11258: <p>
11259: This requests the creation of PIE (Position Independent Executables) for all
11260: executables. The PIE mechanism is normally used for shared libraries, so that
11261: they can be loaded at differing addresses at runtime. PIE itself does not have
11262: useful security properties; however, it is necessary to fully leverage some,
11263: such as ASLR. Some operating systems support Address Space Layout Randomization
11264: (ASLR), which causes different addresses to be used each time a program is run.
11265: This makes it more difficult for an attacker to guess addresses and thus makes
11266: exploits harder to construct. With PIE, ASLR can really be applied to the entire
11267: program, instead of the stack and heap only.
11268: </p>
11269: <p>
11270: PIE executables will only be built for toolchains that are known to support PIE.
11271: Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
11272: </p>
11273: <p>
11274: <code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
11275: </p>
1.1 dsieger 11276: </div>
1.210 gutterid 11277: <div class="sect3">
11278: <div class="titlepage"><div><div><h4 class="title">
1.219 nia 11279: <a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
1.207 leot 11280: <p>
11281: This also makes the exploitation of some security vulnerabilities more
11282: difficult in some cases.
11283: </p>
11284: <p>Two different mitigation levels are available:</p>
11285: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11286: <li class="listitem"><p>
1.219 nia 11287: partial (the default): the ELF sections are reordered so that internal data sections
1.207 leot 11288: precede the program's own data sections, and non-PLT GOT is read-only;
11289: </p></li>
11290: <li class="listitem"><p>
11291: full: in addition to partial RELRO, every relocation is performed immediately
1.218 nia 11292: when starting the program, allowing the entire GOT to be read-only. This
11293: can greatly slow down startup of large programs.
1.207 leot 11294: </p></li>
11295: </ul></div>
11296: <p>
11297: This is currently supported by GCC. Many software distributions now enable this
1.220 nia 11298: feature by default, at the "partial" level.
1.207 leot 11299: </p>
11300: <p>
11301: More details can be found here:
11302: </p>
11303: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11304: <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>
11305: </p></li></ul></div>
1.1 dsieger 11306: </div>
1.219 nia 11307: </div>
11308: <div class="sect2">
11309: <div class="titlepage"><div><div><h3 class="title">
11310: <a name="hardening.mechanisms.disabled"></a>B.1.2. Not enabled by default</h3></div></div></div>
11311: <div class="sect3">
11312: <div class="titlepage"><div><div><h4 class="title">
11313: <a name="hardening.mechanisms.disabled.repro"></a>B.1.2.1. PKGSRC_MKREPRO</h4></div></div></div>
11314: <p>
11315: With this option, pkgsrc will try to build packages reproducibly. This allows
11316: packages built from the same tree and with the same options, to produce
11317: identical results bit by bit. This option should be combined with ASLR and
11318: <code class="varname">PKGSRC_MKPIE</code> to avoid predictable address offsets for
11319: attackers attempting to exploit security vulnerabilities.
11320: </p>
11321: <p>
11322: More details can be found here:
11323: </p>
11324: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
11325: <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>
11326: </p></li></ul></div>
11327: <p>
11328: More work likely needs to be done before pkgsrc is fully reproducible.
11329: </p>
11330: </div>
1.207 leot 11331: <div class="sect3">
11332: <div class="titlepage"><div><div><h4 class="title">
1.219 nia 11333: <a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
1.207 leot 11334: <p>
11335: This uses <code class="literal">-fstack-check</code> with GCC for
11336: another stack protection mitigation.
11337: </p>
11338: <p>
11339: It asks the compiler to generate code verifying that it does not corrupt the
11340: stack. According to GCC's manual page, this is really only useful for
11341: multi-threaded programs.
11342: </p>
1.1 dsieger 11343: </div>
11344: </div>
11345: </div>
1.41 asau 11346: <div class="sect1">
1.1 dsieger 11347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11348: <a name="hardening.caveats"></a>B.2. Caveats</h2></div></div></div>
11349: <div class="sect2">
11350: <div class="titlepage"><div><div><h3 class="title">
11351: <a name="hardening.caveats.pie"></a>B.2.1. Problems with PKGSRC_MKPIE</h3></div></div></div>
11352: <div class="sect3">
11353: <div class="titlepage"><div><div><h4 class="title">
11354: <a name="hardening.caveats.pie.build"></a>B.2.1.1. Packages failing to build</h4></div></div></div>
11355: <p>
11356: A number of packages may fail to build with this option enabled. The
11357: failures are often related to the absence of the <code class="literal">-fPIC</code>
11358: compilation flag when building libraries or executables (or ideally
11359: <code class="literal">-fPIE</code> in the latter case). This flag is added to the
11360: <code class="varname">CFLAGS</code> already, but requires the package to
11361: actually support it.
11362: </p>
11363: <div class="sect4">
11364: <div class="titlepage"><div><div><h5 class="title">
11365: <a name="hardening.caveats.pie.build.fix"></a>B.2.1.1.1. How to fix</h5></div></div></div>
11366: <p>
11367: These instructions are meant as a reference only; they likely need to be adapted
11368: for many packages individually.
11369: </p>
11370: <p>
11371: For packages using <code class="filename">Makefiles</code>:
11372: </p>
11373: <pre class="programlisting">
11374: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
11375: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
11376: </pre>
11377: <p>
11378: For packages using <code class="filename">Imakefiles</code>:
11379: </p>
11380: <pre class="programlisting">
11381: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
11382: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
11383: </pre>
11384: </div>
11385: </div>
11386: <div class="sect3">
11387: <div class="titlepage"><div><div><h4 class="title">
11388: <a name="hardening.caveats.pie.crash"></a>B.2.1.2. Run-time crashes</h4></div></div></div>
11389: <p>
11390: Some programs may fail to run, or crash at random times once built as PIE. Two
11391: scenarios are essentially possible. This is nearly always due to a bug in
11392: the program being exposed due to ASLR.
11393: </p>
11394: </div>
11395: <div class="sect3">
11396: <div class="titlepage"><div><div><h4 class="title">
11397: <a name="hardening.caveats.pie.disable"></a>B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis</h4></div></div></div>
11398: <p>
11399: Ideally, packages should be fixed for compatibility with MKPIE.
11400: However, in some cases this is very difficult, due to complex build systems,
11401: packages using non-standard toolchains, or programming languages with odd
11402: bootstrapping mechanisms.
11403: </p>
11404: <p>
11405: To disable <code class="varname">PKGSRC_MKPIE</code> on a per-package basis, set
11406: <code class="varname">MKPIE_SUPPORTED= no</code> in the package's Makefile before
11407: <code class="filename">bsd.prefs.mk</code> is included.
11408: </p>
11409: </div>
11410: </div>
11411: <div class="sect2">
11412: <div class="titlepage"><div><div><h3 class="title">
11413: <a name="hardening.caveats.fortify"></a>B.2.2. Problems with PKGSRC_USE_FORTIFY</h3></div></div></div>
11414: <div class="sect3">
11415: <div class="titlepage"><div><div><h4 class="title">
11416: <a name="hardening.caveats.fortify.build"></a>B.2.2.1. Packages failing to build</h4></div></div></div>
11417: <p>
11418: This feature makes use of pre-processing directives to look for hardened,
11419: alternative implementations of essential library calls. Some programs may fail
11420: to build as a result; this usually happens for those trying too hard to be
11421: portable, or otherwise abusing definitions in the standard library.
11422: </p>
11423: </div>
11424: <div class="sect3">
11425: <div class="titlepage"><div><div><h4 class="title">
11426: <a name="hardening.caveats.fortify.crash"></a>B.2.2.2. Run-time crashes</h4></div></div></div>
11427: <p>
11428: This feature may cause some programs to crash, usually indicating an
11429: actual bug in the program. The fix will typically involve patching the
11430: original program's source code.
11431: </p>
11432: </div>
11433: <div class="sect3">
11434: <div class="titlepage"><div><div><h4 class="title">
11435: <a name="hardening.caveats.fortify.opt"></a>B.2.2.3. Optimization is required</h4></div></div></div>
11436: <p>
11437: At least in the case of GCC, FORTIFY will only be applied if optimization is
11438: applied while compiling. This means that the <code class="varname">CFLAGS</code> should
11439: also contain <code class="literal">-O</code>, <code class="literal">-O2</code> or another
11440: optimization level. This cannot easily be applied globally, as some packages
11441: may require specific optimization levels.
11442: </p>
11443: </div>
11444: <div class="sect3">
11445: <div class="titlepage"><div><div><h4 class="title">
11446: <a name="hardening.caveats.fortify.disable"></a>B.2.2.4. Disabling FORTIFY on a per-package basis</h4></div></div></div>
11447: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11448: <h3 class="title">Note</h3>
11449: <p>FORTIFY should not be disabled to work around runtime crashes in
11450: the program! This is a very bad idea and will expose you to security
11451: vulnerabilities.
11452: </p>
11453: </div>
11454: <p>
11455: To disable FORTIFY on a per-package basis, set the following
11456: in the package's <code class="filename">Makefile</code>
11457: before <code class="filename">bsd.prefs.mk</code> is included:
11458: </p>
11459: <pre class="programlisting">
11460: FORTIFY_SUPPORTED= no
11461: </pre>
11462: </div>
11463: </div>
11464: <div class="sect2">
11465: <div class="titlepage"><div><div><h3 class="title">
11466: <a name="hardening.caveats.relro"></a>B.2.3. Problems with PKGSRC_USE_RELRO</h3></div></div></div>
11467: <div class="sect3">
11468: <div class="titlepage"><div><div><h4 class="title">
11469: <a name="hardening.caveats.relro.performance"></a>B.2.3.1. Performance impact</h4></div></div></div>
11470: <p>
11471: For better protection, full RELRO requires every symbol to be resolved when the
11472: program starts, rather than simply when required at run-time. This will have
11473: more impact on programs using a lot of symbols, or linked to libraries exposing
11474: a lot of symbols. Therefore, daemons or programs otherwise running in
11475: background are affected only when started. Programs loading plug-ins at
11476: run-time are affected when loading the plug-ins.
11477: </p>
11478: <p>
11479: The impact is not expected to be noticeable on modern hardware, except in some
11480: cases for big programs.
11481: </p>
11482: </div>
11483: <div class="sect3">
11484: <div class="titlepage"><div><div><h4 class="title">
11485: <a name="hardening.caveats.relro.crash"></a>B.2.3.2. Run-time crashes</h4></div></div></div>
11486: <p>
11487: Some programs handle plug-ins and dependencies in a way that conflicts with
11488: RELRO: for instance, with an initialization routine listing any other plug-in
11489: required. With full RELRO, the missing symbols are resolved before the
11490: initialization routine can run, and the dynamic loader will not be able to find
11491: them directly and abort as a result. Unfortunately, this is how Xorg loads its
11492: drivers. Partial RELRO can be applied instead in this case.
11493: </p>
11494: </div>
11495: <div class="sect3">
11496: <div class="titlepage"><div><div><h4 class="title">
11497: <a name="hardening.caveats.relro.disable"></a>B.2.3.3. Disabling RELRO on a per-package basis</h4></div></div></div>
11498: <p>
11499: To disable RELRO on a per-package basis, set the following
11500: in the package's <code class="filename">Makefile</code>
11501: before <code class="filename">bsd.prefs.mk</code> is included:
11502: </p>
11503: <pre class="programlisting">
11504: RELRO_SUPPORTED= no
11505: </pre>
1.209 nia 11506: <p>
11507: It is also possible to at most enable partial RELRO, by
11508: setting <code class="varname">RELRO_SUPPORTED</code> to <code class="literal">partial</code>.
11509: </p>
1.207 leot 11510: </div>
11511: </div>
11512: <div class="sect2">
11513: <div class="titlepage"><div><div><h3 class="title">
11514: <a name="hardening.caveats.ssp"></a>B.2.4. Problems with PKGSRC_USE_SSP</h3></div></div></div>
11515: <div class="sect3">
11516: <div class="titlepage"><div><div><h4 class="title">
11517: <a name="hardening.caveats.ssp.build"></a>B.2.4.1. Packages failing to build</h4></div></div></div>
11518: <p>
11519: The stack-smashing protection provided by this option does not work for some
11520: programs. The most common situation in which this happens is when the program
11521: allocates variables on the stack, with the size determined at run-time.
11522: </p>
11523: </div>
11524: <div class="sect3">
11525: <div class="titlepage"><div><div><h4 class="title">
11526: <a name="hardening.caveats.ssp.crash"></a>B.2.4.2. Run-time crashes</h4></div></div></div>
11527: <p>
11528: Again, this feature may cause some programs to crash via a
11529: <code class="varname">SIGABRT</code>, usually indicating an actual bug in the program.
11530: </p>
11531: <p>
11532: On NetBSD <code class="varname">LOG_CRIT</code> level syslog
11533: messages are sent and - by default -
11534: appended to <code class="filename">/var/log/messages</code>, e.g.:
11535: </p>
11536: <pre class="programlisting">
11537: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
11538: </pre>
11539: <p>
11540: (where <code class="literal">hostname</code> is the hostname(1) and
11541: <code class="literal">program</code> is the basename(1) of the program crashed).
11542: </p>
11543: <p>
11544: Patching the original program is then required.
11545: </p>
11546: <p>
11547: Rebuilding the package via:
11548: </p>
11549: <pre class="programlisting">
11550: <strong class="userinput"><code>% env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace</code></strong>
11551: </pre>
11552: <p>
11553: and inspecting the backtrace of the coredump via the debugger
11554: should point out the problematic call by inspecting the frame
11555: calling the _chk() (SSP) function.
11556: </p>
11557: </div>
11558: <div class="sect3">
11559: <div class="titlepage"><div><div><h4 class="title">
11560: <a name="hardening.caveats.ssp.performance"></a>B.2.4.3. Performance impact</h4></div></div></div>
11561: <p>
11562: The compiler emits extra code when using this feature: a check for buffer
11563: overflows is performed when entering and exiting functions, requiring an extra
11564: variable on the stack. The level of protection can otherwise be adjusted to
11565: affect only those functions considered more sensitive by the compiler (with
11566: -fstack-protector instead of -fstack-protector-all).
11567: </p>
11568: <p>
11569: The impact is not expected to be noticeable on modern hardware. However,
11570: programs with a hard requirement to run at the fastest possible speed should
11571: avoid using this feature, or using libraries built with this feature.
11572: </p>
11573: </div>
11574: <div class="sect3">
11575: <div class="titlepage"><div><div><h4 class="title">
11576: <a name="hardening.caveats.ssp.disable"></a>B.2.4.4. Disabling SSP on a per-package basis</h4></div></div></div>
11577: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11578: <h3 class="title">Note</h3>
11579: <p>SSP should not be disabled to work around runtime crashes in
11580: the program! This is a very bad idea and will expose you to security
11581: vulnerabilities.</p>
11582: </div>
11583: <p>
11584: To disable SSP on a per-package basis, set the following
11585: in the package's <code class="filename">Makefile</code>
11586: before <code class="filename">bsd.prefs.mk</code> is included:
11587: </p>
11588: <pre class="programlisting">
11589: SSP_SUPPORTED= no
11590: </pre>
11591: </div>
11592: </div>
11593: </div>
11594: <div class="sect1">
11595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11596: <a name="hardening.audit"></a>B.3. Auditing the system</h2></div></div></div>
11597: <p>
11598: The illusion of security is worse than having no security at all. This section
11599: lists a number of ways to ensure the security features requested are actually
11600: effective.
11601: </p>
11602: <p>
11603: These instructions were obtained and tested on a system derived from NetBSD 7
11604: (amd64). YMMV.
11605: </p>
11606: <div class="sect2">
11607: <div class="titlepage"><div><div><h3 class="title">
11608: <a name="hardening.audit.pie"></a>B.3.1. Checking for PIE</h3></div></div></div>
11609: <p>
11610: The ELF executable type in use changes for binaries built as PIE; without:
11611: </p>
11612: <pre class="programlisting">
11613: <strong class="userinput"><code>$ file /path/to/bin/ary</code></strong>
11614: /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
11615: </pre>
11616: <p>as opposed to the following binary, built as PIE:</p>
11617: <pre class="programlisting">
11618: <strong class="userinput"><code>$ file /path/to/pie/bin/ary</code></strong>
11619: /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
11620: </pre>
11621: <p>
11622: The latter result is then what is expected.
11623: </p>
11624: </div>
11625: <div class="sect2">
11626: <div class="titlepage"><div><div><h3 class="title">
11627: <a name="hardening.audit.relropartial"></a>B.3.2. Checking for partial RELRO</h3></div></div></div>
11628: <p>
11629: The following command should list a section called RELRO:
11630: </p>
11631: <pre class="programlisting">
11632: <strong class="userinput"><code>$ objdump -p /path/to/bin/ary</code></strong>
11633:
11634: /path/to/bin/ary: file format elf64-x86-64
11635:
11636: Program Header:
11637: [...]
11638: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
11639: </pre>
11640: <p>
11641: This check is now performed automatically if
11642: <code class="varname">PKG_DEVELOPER</code> is set and RELRO is enabled.
11643: </p>
11644: </div>
11645: <div class="sect2">
11646: <div class="titlepage"><div><div><h3 class="title">
11647: <a name="hardening.audit.relrofull"></a>B.3.3. Checking for full RELRO</h3></div></div></div>
11648: <p>
11649: The dynamic loader will apply RELRO immediately when detecting the presence of
11650: the <code class="varname">BIND_NOW</code> flag:
11651: </p>
11652: <pre class="programlisting">
11653: <strong class="userinput"><code>$ objdump -x /path/to/bin/ary</code></strong>
11654:
11655: /path/to/bin/ary: file format elf64-x86-64
11656:
11657: Dynamic Section:
11658: [...]
11659: BIND_NOW 0x0000000000000000
11660: </pre>
11661: <p>
11662: This has to be combined with partial RELRO (see above) to be fully efficient.
11663: </p>
11664: <p>
11665: This check is now performed automatically (where supported) if
11666: <code class="varname">PKG_DEVELOPER</code> is set.
11667: </p>
11668: </div>
11669: <div class="sect2">
11670: <div class="titlepage"><div><div><h3 class="title">
11671: <a name="hardening.audit.ssp"></a>B.3.4. Checking for SSP</h3></div></div></div>
1.208 nia 11672: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11673: <h3 class="title">Note</h3>
11674: <p>
11675: Checking for SSP using this method only works where the operating system
11676: uses <code class="literal">libssp</code>. <code class="literal">libssp</code> is not used
11677: on recent NetBSD/FreeBSD/Linux versions.
11678: </p>
11679: </div>
1.207 leot 11680: <p>
11681: Building objects, binaries and libraries with SSP will affect the presence of
11682: additional symbols in the resulting file:
11683: </p>
11684: <pre class="programlisting">
11685: <strong class="userinput"><code>$ nm /path/to/bin/ary</code></strong>
11686: [...]
11687: U __stack_chk_fail
11688: 0000000000600ea0 B __stack_chk_guard
11689: </pre>
11690: <p>
11691: This is an indicator that the program was indeed built with support for SSP.
11692: </p>
11693: <p>
11694: This check is now performed automatically (where supported) if
11695: <code class="varname">PKG_DEVELOPER</code> is set and SSP is enabled.
11696: </p>
11697: </div>
11698: </div>
11699: </div>
11700: <div class="appendix">
11701: <div class="titlepage"><div><div><h1 class="title">
11702: <a name="logs"></a>Appendix C. Build logs</h1></div></div></div>
11703: <div class="toc">
11704: <p><b>Table of Contents</b></p>
11705: <dl class="toc">
11706: <dt><span class="sect1"><a href="#logs.building">C.1. Building figlet</a></span></dt>
11707: <dt><span class="sect1"><a href="#logs.package">C.2. Packaging figlet</a></span></dt>
11708: </dl>
11709: </div>
11710: <div class="sect1">
11711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11712: <a name="logs.building"></a>C.1. Building figlet</h2></div></div></div>
11713: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11714: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11715: => figlet221.tar.gz doesn't seem to exist on this system.
11716: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11717: => [172219 bytes]
11718: Connected to ftp.plig.net.
11719: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11720: 331 Guest login ok, send your complete e-mail address as password.
11721: 230-You are user #5 of 500 simultaneous users allowed.
11722: 230-
11723: 230- ___ _ _ _
11724: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11725: 230- | _| _| . |_| . | | | . |_| . | _| . |
11726: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11727: 230- |_| |_| |___| |___|
11728: 230-
11729: 230-** Welcome to ftp.plig.org **
11730: 230-
11731: 230-Please note that all transfers from this FTP site are logged. If you
11732: 230-do not like this, please disconnect now.
11733: 230-
11734: 230-This archive is available via
11735: 230-
11736: 230-HTTP: http://ftp.plig.org/
11737: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11738: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11739: 230-
11740: 230-Please email comments, bug reports and requests for packages to be
11741: 230-mirrored to ftp-admin@plig.org.
11742: 230-
11743: 230-
11744: 230 Logged in anonymously.
11745: Remote system type is UNIX.
11746: Using binary mode to transfer files.
11747: 200 Type okay.
11748: 250 "/pub" is new cwd.
11749: 250-"/pub/figlet" is new cwd.
11750: 250-
11751: 250-Welcome to the figlet archive at ftp.figlet.org
11752: 250-
11753: 250- ftp://ftp.figlet.org/pub/figlet/
11754: 250-
11755: 250-The official FIGlet web page is:
11756: 250- http://www.figlet.org/
11757: 250-
11758: 250-If you have questions, please mailto:info@figlet.org. If you want to
11759: 250-contribute a font or something else, you can email us.
11760: 250
11761: 250 "/pub/figlet/program" is new cwd.
11762: 250 "/pub/figlet/program/unix" is new cwd.
11763: local: figlet221.tar.gz remote: figlet221.tar.gz
11764: 502 Unimplemented command.
11765: 227 Entering Passive Mode (195,40,6,41,246,104)
11766: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11767: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11768: 226 Transfer completed.
11769: 172219 bytes received in 00:02 (75.99 KB/s)
11770: 221 Goodbye.
11771: => Checksum OK for figlet221.tar.gz.
11772: ===> Extracting for figlet-2.2.1nb2
11773: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11774: ===> Patching for figlet-2.2.1nb2
11775: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11776: ===> Overriding tools for figlet-2.2.1nb2
11777: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11778: ===> Configuring for figlet-2.2.1nb2
11779: ===> Building for figlet-2.2.1nb2
11780: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11781: chmod a+x figlet
11782: gcc -O2 -o chkfont chkfont.c
11783: => Unwrapping files-to-be-installed.
11784: <code class="prompt">#</code>
11785: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11786: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11787: ===> Installing for figlet-2.2.1nb2
11788: install -d -o root -g wheel -m 755 /usr/pkg/bin
11789: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11790: mkdir -p /usr/pkg/share/figlet
11791: cp figlet /usr/pkg/bin
11792: cp chkfont /usr/pkg/bin
11793: chmod 555 figlist showfigfonts
11794: cp figlist /usr/pkg/bin
11795: cp showfigfonts /usr/pkg/bin
11796: cp fonts/*.flf /usr/pkg/share/figlet
11797: cp fonts/*.flc /usr/pkg/share/figlet
11798: cp figlet.6 /usr/pkg/man/man6
11799: ===> Registering installation for figlet-2.2.1nb2
11800: <code class="prompt">#</code></pre>
11801: </div>
11802: <div class="sect1">
11803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11804: <a name="logs.package"></a>C.2. Packaging figlet</h2></div></div></div>
11805: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11806: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11807: ===> Packaging figlet-2.2.1nb2
11808: ===> Building binary package for figlet-2.2.1nb2
11809: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11810: Using SrcDir value of /usr/pkg
11811: Registering depends:.
11812: <code class="prompt">#</code></pre>
11813: </div>
11814: </div>
11815: <div class="appendix">
11816: <div class="titlepage"><div><div><h1 class="title">
11817: <a name="ftp-layout"></a>Appendix D. Directory layout of the pkgsrc FTP server</h1></div></div></div>
11818: <div class="toc">
11819: <p><b>Table of Contents</b></p>
11820: <dl class="toc">
11821: <dt><span class="sect1"><a href="#ftp-distfiles">D.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11822: <dt><span class="sect1"><a href="#ftp-misc">D.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11823: <dt><span class="sect1"><a href="#ftp-packages">D.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11824: <dt><span class="sect1"><a href="#ftp-reports">D.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11825: <dt><span class="sect1"><a href="#ftp-source">D.5. <code class="filename">current</code>,
11826: <code class="filename">stable</code>,
11827: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11828: source packages</a></span></dt>
11829: </dl>
11830: </div>
11831: <p>As in other big projects, the directory layout of pkgsrc
11832: is quite complex for newbies. This chapter explains where you
11833: find things on the FTP server. The base directory on
11834: <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>.
11835: On other servers it may be different, but inside this directory,
11836: everything should look the same, no matter on which server you
11837: are. This directory contains some subdirectories, which are
11838: explained below.</p>
11839: <div class="sect1">
11840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11841: <a name="ftp-distfiles"></a>D.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11842: <p>The directory <code class="filename">distfiles</code> contains lots
11843: of archive files from all pkgsrc packages, which are mirrored
11844: here. The subdirectories are called after their package names
11845: and are used when the distributed files have names that don't
11846: explicitly contain a version number or are otherwise too generic
11847: (for example <code class="filename">release.tar.gz</code>).</p>
11848: </div>
11849: <div class="sect1">
11850: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11851: <a name="ftp-misc"></a>D.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11852: <p>This directory contains things that individual pkgsrc
11853: developers find worth publishing.</p>
11854: </div>
11855: <div class="sect1">
11856: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11857: <a name="ftp-packages"></a>D.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11858: <p>This directory contains binary packages for the various
11859: platforms that are supported by pkgsrc.
11860: 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>
11861: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
11862: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
11863: operating system for which the packages have been built. The
11864: name is taken from the output of the <span class="command"><strong>uname</strong></span>
11865: command, so it may differ from the one you are used to
11866: hear.</p></li>
11867: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
11868: architecture of the platform for which the packages have been
11869: built. It also includes the <code class="varname">ABI</code> (Application
11870: Binary Interface) for platforms that have several of
11871: them.</p></li>
11872: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.255 ! wiz 11873: the operating system. Typically it is the version defining an
! 11874: ABI, e.g. 9.0.</p></li>
1.207 leot 11875: <li class="listitem"><p><code class="varname">TAG</code> is either
1.255 ! wiz 11876: <code class="literal">20<em class="replaceable"><code>YY</code></em>Q<em class="replaceable"><code>N</code></em></code>
! 11877: for a stable branch, or <code class="literal">current</code> for packages
1.207 leot 11878: built from the HEAD branch. The latter should only be used when
1.255 ! wiz 11879: the packages are updated on a regular basis.</p></li>
1.207 leot 11880: </ul></div>
1.255 ! wiz 11881: <p>The rationale for this scheme is that users can first
! 11882: search by OPSYS and ARCH, since these are more or less
! 11883: unchangeable. After that, there is a management set of
! 11884: directories with OSVERSION and TAG.</p>
! 11885: <p>See also <code class="filename">README.md</code> in
! 11886: <code class="filename">packages</code> for more details, including
! 11887: about symlinks.</p>
1.207 leot 11888: <p>In each of these directories, there is a
11889: whole binary packages collection for a specific platform. It has a directory called
11890: <code class="filename">All</code> which contains all binary packages.
1.255 ! wiz 11891: </p>
1.207 leot 11892: </div>
11893: <div class="sect1">
11894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11895: <a name="ftp-reports"></a>D.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 11896: <p>Here are the reports from bulk builds, for those who want
11897: to fix packages that didn't build on some of the platforms. The
1.207 leot 11898: 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 11899: </div>
1.41 asau 11900: <div class="sect1">
1.8 rillig 11901: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 11902: <a name="ftp-source"></a>D.5. <code class="filename">current</code>,
1.148 leot 11903: <code class="filename">stable</code>,
1.22 jakllsch 11904: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11905: source packages</h2></div></div></div>
1.23 wiz 11906: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 11907: that is the files that define how to create binary packages from
11908: source archives.</p>
1.149 leot 11909: <p>Each of the <code class="filename">current</code>,
11910: <code class="filename">stable</code> and
11911: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11912: directories share the same structure. They each contain a
11913: <code class="filename">pkgsrc</code> directory and
11914: <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1 dsieger 11915: <p>The directory <code class="filename">pkgsrc</code> contains a
11916: snapshot of the CVS repository, which is updated regularly. The
1.149 leot 11917: file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
11918: as the directory, ready to be downloaded as a whole.</p>
11919: <p>The <code class="filename">current</code> directory contains files
11920: related to the HEAD branch of the CVS repository.
11921: In this directory there is an additional file called
11922: <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
11923: all pkgsrc <code class="filename">README</code>s with information about
11924: categories and packages.
11925: </p>
11926: <p>The <code class="filename">stable</code> directory is a symlink to
11927: the latest
11928: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11929: </p>
11930: <p>The
11931: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
11932: directories contain files related to the
11933: <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
11934: stable branch of the CVS repository. In these directories there is
11935: an additional file called
11936: <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 11937: which contains the state of pkgsrc when it was branched.</p>
11938: </div>
11939: </div>
1.41 asau 11940: <div class="appendix">
11941: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 11942: <a name="help-topics"></a>Appendix E. Help topics</h1></div></div></div>
1.154 rillig 11943: <p>
11944: The following list contains all help topics that are available
11945: when running <span class="command"><strong>bmake help topic=:index</strong></span>.
11946: </p>
1.156 leot 11947: <table border="0" summary="Simple list" class="simplelist">
11948: <tr>
11949: <td>#!</td>
11950: <td>-lintl</td>
11951: </tr>
11952: <tr>
1.205 wiz 11953: <td>32bit</td>
1.156 leot 11954: <td>64bit</td>
1.205 wiz 11955: </tr>
11956: <tr>
1.156 leot 11957: <td>ABI</td>
1.205 wiz 11958: <td>ACCEPTABLE_LICENSES</td>
1.156 leot 11959: </tr>
11960: <tr>
11961: <td>ACROREAD_FONTPATH</td>
1.205 wiz 11962: <td>ADDITIONAL</td>
1.156 leot 11963: </tr>
11964: <tr>
11965: <td>AFAIK</td>
1.205 wiz 11966: <td>AIX</td>
1.156 leot 11967: </tr>
11968: <tr>
1.255 ! wiz 11969: <td>ALLOW_NETWORK_ACCESS</td>
1.243 gutterid 11970: <td>ALLOW_NEWER_COMPILER</td>
1.156 leot 11971: </tr>
11972: <tr>
1.255 ! wiz 11973: <td>ALLOW_VULNERABLE_PACKAGES</td>
1.243 gutterid 11974: <td>ALL_ENV</td>
1.254 wiz 11975: </tr>
11976: <tr>
1.255 ! wiz 11977: <td>ALSA_PC</td>
1.249 gutterid 11978: <td>ALTERNATIVES_SRC</td>
1.246 leot 11979: </tr>
11980: <tr>
1.255 ! wiz 11981: <td>AMANDA_TMP</td>
1.249 gutterid 11982: <td>AMANDA_USER</td>
1.241 rillig 11983: </tr>
11984: <tr>
1.255 ! wiz 11985: <td>AMANDA_VAR</td>
1.249 gutterid 11986: <td>APACHE_GROUP</td>
1.238 wiz 11987: </tr>
11988: <tr>
1.255 ! wiz 11989: <td>APACHE_MODULE_NAME</td>
1.249 gutterid 11990: <td>APACHE_MODULE_SRC</td>
1.233 wiz 11991: </tr>
11992: <tr>
1.255 ! wiz 11993: <td>APACHE_MODULE_SRCDIR</td>
1.249 gutterid 11994: <td>APACHE_PKG_PREFIX</td>
1.227 wiz 11995: </tr>
11996: <tr>
1.255 ! wiz 11997: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.249 gutterid 11998: <td>APACHE_SUEXEC_DOCROOT</td>
1.223 nia 11999: </tr>
12000: <tr>
1.255 ! wiz 12001: <td>APACHE_USER</td>
! 12002: <td>ARLA_CACHE</td>
1.217 rillig 12003: </tr>
12004: <tr>
1.254 wiz 12005: <td>AUDIT_PACKAGES_FLAGS</td>
1.255 ! wiz 12006: <td>AUTOCONF_REQD</td>
1.214 leot 12007: </tr>
12008: <tr>
1.254 wiz 12009: <td>AUTOMAKE_OVERRIDE</td>
1.255 ! wiz 12010: <td>AUTOMAKE_REQD</td>
1.212 wiz 12011: </tr>
12012: <tr>
1.254 wiz 12013: <td>AUTO_MKDIRS</td>
1.255 ! wiz 12014: <td>AUX</td>
1.197 leot 12015: </tr>
12016: <tr>
1.249 gutterid 12017: <td>BDB185_DEFAULT</td>
1.255 ! wiz 12018: <td>BDBBASE</td>
1.177 leot 12019: </tr>
12020: <tr>
1.249 gutterid 12021: <td>BDB_ACCEPTED</td>
1.255 ! wiz 12022: <td>BDB_DEFAULT</td>
1.161 leot 12023: </tr>
12024: <tr>
1.249 gutterid 12025: <td>BDB_LIBS</td>
1.255 ! wiz 12026: <td>BDB_TYPE</td>
1.159 rillig 12027: </tr>
12028: <tr>
1.249 gutterid 12029: <td>BINCIMAP_GROUP</td>
1.255 ! wiz 12030: <td>BINCIMAP_LOG_USER</td>
1.156 leot 12031: </tr>
12032: <tr>
1.246 leot 12033: <td>BINCIMAP_USER</td>
1.255 ! wiz 12034: <td>BIND_DIR</td>
1.254 wiz 12035: </tr>
12036: <tr>
12037: <td>BIND_GROUP</td>
1.255 ! wiz 12038: <td>BIND_USER</td>
1.156 leot 12039: </tr>
12040: <tr>
1.254 wiz 12041: <td>BINOWN</td>
1.255 ! wiz 12042: <td>BINPKG_SITES</td>
1.156 leot 12043: </tr>
12044: <tr>
1.254 wiz 12045: <td>BIN_INSTALL_FLAGS</td>
1.255 ! wiz 12046: <td>BISON_PKGDATADIR</td>
1.156 leot 12047: </tr>
12048: <tr>
1.254 wiz 12049: <td>BLAS</td>
1.255 ! wiz 12050: <td>BLAS_ACCEPTED</td>
1.156 leot 12051: </tr>
12052: <tr>
1.254 wiz 12053: <td>BLAS_C_INTERFACE</td>
1.255 ! wiz 12054: <td>BLAS_INCLUDES</td>
1.156 leot 12055: </tr>
12056: <tr>
1.254 wiz 12057: <td>BLAS_INDEX64</td>
1.255 ! wiz 12058: <td>BLAS_LIBS</td>
1.156 leot 12059: </tr>
12060: <tr>
1.254 wiz 12061: <td>BLAS_PC</td>
1.255 ! wiz 12062: <td>BLAS_TYPE</td>
1.156 leot 12063: </tr>
12064: <tr>
1.254 wiz 12065: <td>BOOTSTRAP_DEPENDS</td>
1.255 ! wiz 12066: <td>BROKEN</td>
1.156 leot 12067: </tr>
12068: <tr>
1.254 wiz 12069: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.255 ! wiz 12070: <td>BROKEN_ON_PLATFORM</td>
1.156 leot 12071: </tr>
12072: <tr>
1.254 wiz 12073: <td>BSDSRCDIR</td>
1.255 ! wiz 12074: <td>BSDXSRCDIR</td>
1.198 leot 12075: </tr>
12076: <tr>
1.254 wiz 12077: <td>BSD_MAKE_ENV</td>
1.255 ! wiz 12078: <td>BUILDLINK_AUTO_DIRS</td>
1.229 gutterid 12079: </tr>
12080: <tr>
1.254 wiz 12081: <td>BUILDLINK_AUTO_VARS</td>
1.255 ! wiz 12082: <td>BUILDLINK_CFLAGS</td>
1.156 leot 12083: </tr>
12084: <tr>
1.254 wiz 12085: <td>BUILDLINK_CONTENTS_FILTER</td>
1.255 ! wiz 12086: <td>BUILDLINK_CPPFLAGS</td>
1.156 leot 12087: </tr>
12088: <tr>
1.254 wiz 12089: <td>BUILDLINK_DEPMETHOD</td>
1.255 ! wiz 12090: <td>BUILDLINK_FILES</td>
1.156 leot 12091: </tr>
12092: <tr>
1.216 gutterid 12093: <td>BUILDLINK_FILES_CMD</td>
1.255 ! wiz 12094: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.205 wiz 12095: </tr>
12096: <tr>
1.216 gutterid 12097: <td>BUILDLINK_LDFLAGS</td>
1.255 ! wiz 12098: <td>BUILDLINK_LIBS</td>
1.156 leot 12099: </tr>
12100: <tr>
1.216 gutterid 12101: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.255 ! wiz 12102: <td>BUILDLINK_PKGNAME</td>
1.156 leot 12103: </tr>
12104: <tr>
1.216 gutterid 12105: <td>BUILDLINK_PREFIX</td>
1.255 ! wiz 12106: <td>BUILDLINK_RPATHDIRS</td>
1.156 leot 12107: </tr>
12108: <tr>
1.216 gutterid 12109: <td>BUILDLINK_TREE</td>
1.255 ! wiz 12110: <td>BUILD_DEFS</td>
1.156 leot 12111: </tr>
12112: <tr>
1.216 gutterid 12113: <td>BUILD_DEFS_EFFECTS</td>
1.255 ! wiz 12114: <td>BUILD_DEPENDS</td>
1.156 leot 12115: </tr>
12116: <tr>
1.216 gutterid 12117: <td>BUILD_DIRS</td>
1.255 ! wiz 12118: <td>BUILD_ENV_SHELL</td>
1.156 leot 12119: </tr>
12120: <tr>
1.216 gutterid 12121: <td>BUILD_MAKE_CMD</td>
1.255 ! wiz 12122: <td>BUILD_MAKE_FLAGS</td>
1.156 leot 12123: </tr>
12124: <tr>
1.216 gutterid 12125: <td>BUILD_TARGET</td>
1.255 ! wiz 12126: <td>BUILTIN_FIND_FILES</td>
1.156 leot 12127: </tr>
12128: <tr>
1.216 gutterid 12129: <td>BUILTIN_FIND_FILES_VAR</td>
1.255 ! wiz 12130: <td>BUILTIN_FIND_GREP</td>
1.156 leot 12131: </tr>
12132: <tr>
1.216 gutterid 12133: <td>BUILTIN_FIND_HEADERS</td>
1.255 ! wiz 12134: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.156 leot 12135: </tr>
12136: <tr>
1.216 gutterid 12137: <td>BUILTIN_FIND_PKGCONFIG</td>
1.255 ! wiz 12138: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.156 leot 12139: </tr>
12140: <tr>
1.216 gutterid 12141: <td>BUILTIN_PKG</td>
1.255 ! wiz 12142: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.195 gutterid 12143: </tr>
12144: <tr>
1.216 gutterid 12145: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.255 ! wiz 12146: <td>BUILTIN_VERSION_SCRIPT</td>
1.156 leot 12147: </tr>
12148: <tr>
1.216 gutterid 12149: <td>BUILTIN_X11_TYPE</td>
1.255 ! wiz 12150: <td>BUILTIN_X11_VERSION</td>
1.156 leot 12151: </tr>
12152: <tr>
1.216 gutterid 12153: <td>CACTI_GROUP</td>
1.255 ! wiz 12154: <td>CACTI_USER</td>
1.156 leot 12155: </tr>
12156: <tr>
1.216 gutterid 12157: <td>CANNA_GROUP</td>
1.255 ! wiz 12158: <td>CANNA_USER</td>
1.156 leot 12159: </tr>
12160: <tr>
1.216 gutterid 12161: <td>CAT</td>
1.255 ! wiz 12162: <td>CBLAS_LIBS</td>
1.156 leot 12163: </tr>
12164: <tr>
1.229 gutterid 12165: <td>CBLAS_PC</td>
1.255 ! wiz 12166: <td>CCACHE_BASE</td>
1.156 leot 12167: </tr>
12168: <tr>
1.189 bacon 12169: <td>CCACHE_DIR</td>
1.255 ! wiz 12170: <td>CCACHE_LOGFILE</td>
1.156 leot 12171: </tr>
12172: <tr>
1.189 bacon 12173: <td>CC_VERSION</td>
1.255 ! wiz 12174: <td>CC_VERSION_STRING</td>
1.156 leot 12175: </tr>
12176: <tr>
1.189 bacon 12177: <td>CDRECORD_CONF</td>
1.255 ! wiz 12178: <td>CDROM_PKG_URL_DIR</td>
1.156 leot 12179: </tr>
12180: <tr>
1.189 bacon 12181: <td>CDROM_PKG_URL_HOST</td>
1.255 ! wiz 12182: <td>CHANGES</td>
1.223 nia 12183: </tr>
12184: <tr>
1.254 wiz 12185: <td>CHECKOUT_DATE</td>
1.255 ! wiz 12186: <td>CHECK_COMPILER</td>
1.254 wiz 12187: </tr>
12188: <tr>
12189: <td>CHECK_FAKEHOME</td>
1.255 ! wiz 12190: <td>CHECK_FILES</td>
1.246 leot 12191: </tr>
12192: <tr>
1.254 wiz 12193: <td>CHECK_FILES_ONLY_PREFIX</td>
1.255 ! wiz 12194: <td>CHECK_FILES_SKIP</td>
1.241 rillig 12195: </tr>
12196: <tr>
1.249 gutterid 12197: <td>CHECK_FILES_STRICT</td>
1.255 ! wiz 12198: <td>CHECK_HEADERS</td>
1.238 wiz 12199: </tr>
12200: <tr>
1.249 gutterid 12201: <td>CHECK_HEADERS_SKIP</td>
1.255 ! wiz 12202: <td>CHECK_INTERPRETER</td>
1.233 wiz 12203: </tr>
12204: <tr>
1.249 gutterid 12205: <td>CHECK_INTERPRETER_SKIP</td>
1.255 ! wiz 12206: <td>CHECK_PERMS</td>
1.227 wiz 12207: </tr>
12208: <tr>
1.249 gutterid 12209: <td>CHECK_PERMS_AUTOFIX</td>
1.255 ! wiz 12210: <td>CHECK_PERMS_SKIP</td>
1.217 rillig 12211: </tr>
12212: <tr>
1.249 gutterid 12213: <td>CHECK_PIE</td>
1.255 ! wiz 12214: <td>CHECK_PIE_SKIP</td>
1.214 leot 12215: </tr>
12216: <tr>
1.249 gutterid 12217: <td>CHECK_PIE_SUPPORTED</td>
1.255 ! wiz 12218: <td>CHECK_PORTABILITY</td>
1.212 wiz 12219: </tr>
12220: <tr>
1.249 gutterid 12221: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.255 ! wiz 12222: <td>CHECK_PORTABILITY_SKIP</td>
1.205 wiz 12223: </tr>
12224: <tr>
1.249 gutterid 12225: <td>CHECK_RELRO</td>
1.255 ! wiz 12226: <td>CHECK_RELRO_SKIP</td>
1.197 leot 12227: </tr>
12228: <tr>
1.249 gutterid 12229: <td>CHECK_RELRO_SUPPORTED</td>
1.255 ! wiz 12230: <td>CHECK_SHLIBS</td>
1.177 leot 12231: </tr>
12232: <tr>
1.249 gutterid 12233: <td>CHECK_SHLIBS_SKIP</td>
1.255 ! wiz 12234: <td>CHECK_SHLIBS_SUPPORTED</td>
1.161 leot 12235: </tr>
12236: <tr>
1.249 gutterid 12237: <td>CHECK_SHLIBS_TOXIC</td>
1.255 ! wiz 12238: <td>CHECK_SSP</td>
1.216 gutterid 12239: </tr>
12240: <tr>
1.249 gutterid 12241: <td>CHECK_SSP_SKIP</td>
1.255 ! wiz 12242: <td>CHECK_SSP_SUPPORTED</td>
1.159 rillig 12243: </tr>
12244: <tr>
1.249 gutterid 12245: <td>CHECK_STRIPPED</td>
1.255 ! wiz 12246: <td>CHECK_STRIPPED_SKIP</td>
1.156 leot 12247: </tr>
12248: <tr>
1.249 gutterid 12249: <td>CHECK_WRKREF</td>
1.255 ! wiz 12250: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.156 leot 12251: </tr>
12252: <tr>
1.249 gutterid 12253: <td>CHECK_WRKREF_SKIP</td>
1.255 ! wiz 12254: <td>CLAMAV_DBDIR</td>
1.156 leot 12255: </tr>
12256: <tr>
1.249 gutterid 12257: <td>CLAMAV_GROUP</td>
1.255 ! wiz 12258: <td>CLAMAV_USER</td>
1.156 leot 12259: </tr>
12260: <tr>
1.249 gutterid 12261: <td>CLANGBASE</td>
1.255 ! wiz 12262: <td>CLEANDEPENDS</td>
1.156 leot 12263: </tr>
12264: <tr>
1.254 wiz 12265: <td>CLT</td>
1.255 ! wiz 12266: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.254 wiz 12267: </tr>
12268: <tr>
12269: <td>CMAKE_INSTALL_NAME_DIR</td>
1.255 ! wiz 12270: <td>CMAKE_INSTALL_PREFIX</td>
1.156 leot 12271: </tr>
12272: <tr>
1.254 wiz 12273: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.255 ! wiz 12274: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.156 leot 12275: </tr>
12276: <tr>
1.254 wiz 12277: <td>CMAKE_PREFIX_PATH</td>
1.255 ! wiz 12278: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.156 leot 12279: </tr>
12280: <tr>
1.254 wiz 12281: <td>COMMON_LISP_DOCFILES</td>
1.255 ! wiz 12282: <td>COMMON_LISP_EXAMPLES</td>
1.254 wiz 12283: </tr>
12284: <tr>
12285: <td>COMMON_LISP_EXTRAFILES</td>
1.255 ! wiz 12286: <td>COMMON_LISP_PACKAGES</td>
1.254 wiz 12287: </tr>
12288: <tr>
12289: <td>COMMON_LISP_SYSTEM</td>
1.255 ! wiz 12290: <td>COMPILER_RPATH_FLAG</td>
1.156 leot 12291: </tr>
12292: <tr>
1.226 gutterid 12293: <td>COMPILER_USE_SYMLINKS</td>
1.255 ! wiz 12294: <td>CONFIGURE_ARGS</td>
1.156 leot 12295: </tr>
12296: <tr>
1.226 gutterid 12297: <td>CONFIGURE_DIRS</td>
1.255 ! wiz 12298: <td>CONFIGURE_ENV</td>
1.156 leot 12299: </tr>
12300: <tr>
1.226 gutterid 12301: <td>CONFIGURE_ENV_SHELL</td>
1.255 ! wiz 12302: <td>CONFIGURE_HAS_INFODIR</td>
1.156 leot 12303: </tr>
12304: <tr>
1.226 gutterid 12305: <td>CONFIGURE_HAS_MANDIR</td>
1.255 ! wiz 12306: <td>CONFIGURE_SCRIPT</td>
1.156 leot 12307: </tr>
12308: <tr>
1.226 gutterid 12309: <td>CONFIG_SHELL</td>
1.255 ! wiz 12310: <td>CONFIG_SHELL_FLAGS</td>
1.156 leot 12311: </tr>
12312: <tr>
1.226 gutterid 12313: <td>CONF_FILES</td>
1.255 ! wiz 12314: <td>CONF_FILES_MODE</td>
1.156 leot 12315: </tr>
12316: <tr>
1.226 gutterid 12317: <td>CONF_FILES_PERMS</td>
1.255 ! wiz 12318: <td>CONSERVER_DEFAULTHOST</td>
1.156 leot 12319: </tr>
12320: <tr>
1.226 gutterid 12321: <td>CONSERVER_DEFAULTPORT</td>
1.255 ! wiz 12322: <td>CP</td>
1.156 leot 12323: </tr>
12324: <tr>
1.232 gutterid 12325: <td>CPE</td>
1.255 ! wiz 12326: <td>CPE_EDITION</td>
1.232 gutterid 12327: </tr>
12328: <tr>
12329: <td>CPE_LANG</td>
1.255 ! wiz 12330: <td>CPE_OTHER</td>
1.232 gutterid 12331: </tr>
12332: <tr>
12333: <td>CPE_PART</td>
1.255 ! wiz 12334: <td>CPE_PRODUCT</td>
1.232 gutterid 12335: </tr>
12336: <tr>
12337: <td>CPE_SW_EDITION</td>
1.255 ! wiz 12338: <td>CPE_TARGET_HW</td>
1.232 gutterid 12339: </tr>
12340: <tr>
12341: <td>CPE_TARGET_SW</td>
1.255 ! wiz 12342: <td>CPE_UPDATE</td>
1.232 gutterid 12343: </tr>
12344: <tr>
12345: <td>CPE_URI</td>
1.255 ! wiz 12346: <td>CPE_VENDOR</td>
1.232 gutterid 12347: </tr>
12348: <tr>
12349: <td>CPE_VERSION</td>
1.255 ! wiz 12350: <td>CPP</td>
1.156 leot 12351: </tr>
12352: <tr>
1.232 gutterid 12353: <td>CPP_PRECOMP_FLAGS</td>
1.255 ! wiz 12354: <td>CREATE_WRKDIR_SYMLINK</td>
1.156 leot 12355: </tr>
12356: <tr>
1.232 gutterid 12357: <td>CROSSBASE</td>
1.255 ! wiz 12358: <td>CTFCONVERT</td>
1.156 leot 12359: </tr>
12360: <tr>
1.232 gutterid 12361: <td>CTF_FILES_SKIP</td>
1.255 ! wiz 12362: <td>CTF_SUPPORTED</td>
1.156 leot 12363: </tr>
12364: <tr>
1.232 gutterid 12365: <td>CTYPE</td>
1.255 ! wiz 12366: <td>CUPS_GROUP</td>
1.156 leot 12367: </tr>
12368: <tr>
1.232 gutterid 12369: <td>CUPS_SYSTEM_GROUPS</td>
1.255 ! wiz 12370: <td>CUPS_USER</td>
1.177 leot 12371: </tr>
12372: <tr>
1.232 gutterid 12373: <td>CURSES_DEFAULT</td>
1.255 ! wiz 12374: <td>CURSES_TYPE</td>
1.227 wiz 12375: </tr>
12376: <tr>
1.254 wiz 12377: <td>CVS_EXTRACTDIR</td>
1.255 ! wiz 12378: <td>CVS_MODULE</td>
1.254 wiz 12379: </tr>
12380: <tr>
12381: <td>CVS_PROJECT</td>
1.255 ! wiz 12382: <td>CVS_REPOSITORIES</td>
1.254 wiz 12383: </tr>
12384: <tr>
12385: <td>CVS_ROOT</td>
1.255 ! wiz 12386: <td>CVS_ROOT_GNU</td>
1.254 wiz 12387: </tr>
12388: <tr>
12389: <td>CVS_ROOT_NONGNU</td>
1.255 ! wiz 12390: <td>CVS_ROOT_SOURCEFORGE</td>
1.254 wiz 12391: </tr>
12392: <tr>
12393: <td>CVS_TAG</td>
1.255 ! wiz 12394: <td>CXX</td>
1.254 wiz 12395: </tr>
12396: <tr>
12397: <td>CYRUS_GROUP</td>
1.255 ! wiz 12398: <td>CYRUS_IDLE</td>
1.246 leot 12399: </tr>
12400: <tr>
1.254 wiz 12401: <td>CYRUS_USER</td>
1.255 ! wiz 12402: <td>DAEMONTOOLS_GROUP</td>
1.238 wiz 12403: </tr>
12404: <tr>
1.254 wiz 12405: <td>DAEMONTOOLS_LOG_USER</td>
1.255 ! wiz 12406: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.233 wiz 12407: </tr>
12408: <tr>
1.254 wiz 12409: <td>DARWIN_REQUIRES_FILTER</td>
1.255 ! wiz 12410: <td>DBUS_GROUP</td>
1.217 rillig 12411: </tr>
12412: <tr>
1.254 wiz 12413: <td>DBUS_USER</td>
1.255 ! wiz 12414: <td>DEFANG_GROUP</td>
1.214 leot 12415: </tr>
12416: <tr>
1.254 wiz 12417: <td>DEFANG_USER</td>
1.255 ! wiz 12418: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.212 wiz 12419: </tr>
12420: <tr>
1.254 wiz 12421: <td>DEFAULT_DISTFILES</td>
1.255 ! wiz 12422: <td>DEFAULT_IRC_SERVER</td>
1.205 wiz 12423: </tr>
12424: <tr>
1.254 wiz 12425: <td>DEFAULT_SERIAL_DEVICE</td>
1.255 ! wiz 12426: <td>DEF_UMASK</td>
1.197 leot 12427: </tr>
12428: <tr>
1.254 wiz 12429: <td>DEINSTALLDEPENDS</td>
1.255 ! wiz 12430: <td>DEINSTALL_SRC</td>
1.159 rillig 12431: </tr>
12432: <tr>
1.254 wiz 12433: <td>DEINSTALL_TEMPLATES</td>
1.255 ! wiz 12434: <td>DELAYED_ERROR_MSG</td>
1.156 leot 12435: </tr>
12436: <tr>
1.254 wiz 12437: <td>DELAYED_WARNING_MSG</td>
1.255 ! wiz 12438: <td>DEPENDS</td>
1.156 leot 12439: </tr>
12440: <tr>
1.254 wiz 12441: <td>DEPENDS_TARGET</td>
1.255 ! wiz 12442: <td>DEPENDS_TYPE</td>
1.195 gutterid 12443: </tr>
12444: <tr>
1.254 wiz 12445: <td>DESTDIR</td>
1.255 ! wiz 12446: <td>DESTDIR_VARNAME</td>
1.156 leot 12447: </tr>
12448: <tr>
1.254 wiz 12449: <td>DIALER_GROUP</td>
1.255 ! wiz 12450: <td>DIGEST_REQD</td>
1.156 leot 12451: </tr>
12452: <tr>
1.254 wiz 12453: <td>DISTDIR</td>
1.255 ! wiz 12454: <td>DISTFILES</td>
1.156 leot 12455: </tr>
12456: <tr>
1.254 wiz 12457: <td>DISTINFO_FILE</td>
1.255 ! wiz 12458: <td>DISTNAME</td>
1.156 leot 12459: </tr>
12460: <tr>
1.254 wiz 12461: <td>DIST_PATH</td>
1.255 ! wiz 12462: <td>DIST_SUBDIR</td>
1.156 leot 12463: </tr>
12464: <tr>
1.254 wiz 12465: <td>DJBDNS_AXFR_USER</td>
1.255 ! wiz 12466: <td>DJBDNS_CACHE_USER</td>
1.156 leot 12467: </tr>
12468: <tr>
1.254 wiz 12469: <td>DJBDNS_DJBDNS_GROUP</td>
1.255 ! wiz 12470: <td>DJBDNS_LOG_USER</td>
1.156 leot 12471: </tr>
12472: <tr>
1.254 wiz 12473: <td>DJBDNS_RBL_USER</td>
1.255 ! wiz 12474: <td>DJBDNS_TINY_USER</td>
1.156 leot 12475: </tr>
12476: <tr>
1.254 wiz 12477: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.255 ! wiz 12478: <td>DL_AUTO_VARS</td>
1.156 leot 12479: </tr>
12480: <tr>
1.254 wiz 12481: <td>DL_CFLAGS</td>
1.255 ! wiz 12482: <td>DL_LDFLAGS</td>
1.156 leot 12483: </tr>
12484: <tr>
1.254 wiz 12485: <td>DL_LIBS</td>
1.255 ! wiz 12486: <td>DNS</td>
1.156 leot 12487: </tr>
12488: <tr>
1.254 wiz 12489: <td>DOCOWN</td>
1.255 ! wiz 12490: <td>DOWNLOADED_DISTFILE</td>
1.156 leot 12491: </tr>
12492: <tr>
1.254 wiz 12493: <td>DQCACHE_GROUP</td>
1.255 ! wiz 12494: <td>DQCACHE_USER</td>
1.156 leot 12495: </tr>
12496: <tr>
1.254 wiz 12497: <td>DT_LAYOUT</td>
1.255 ! wiz 12498: <td>DYNAMIC_SITES_CMD</td>
1.156 leot 12499: </tr>
12500: <tr>
1.254 wiz 12501: <td>DYNAMIC_SITES_SCRIPT</td>
1.255 ! wiz 12502: <td>ECHO</td>
1.156 leot 12503: </tr>
12504: <tr>
1.254 wiz 12505: <td>ECHO_N</td>
1.255 ! wiz 12506: <td>ELK_GUI</td>
1.156 leot 12507: </tr>
12508: <tr>
1.254 wiz 12509: <td>EMACS_TYPE</td>
1.255 ! wiz 12510: <td>EMULDIR</td>
1.243 gutterid 12511: </tr>
12512: <tr>
1.254 wiz 12513: <td>EMULSUBDIR</td>
1.255 ! wiz 12514: <td>EMULSUBDIRSLASH</td>
1.218 nia 12515: </tr>
12516: <tr>
1.254 wiz 12517: <td>EMUL_ARCH</td>
1.255 ! wiz 12518: <td>EMUL_DISTRO</td>
1.156 leot 12519: </tr>
12520: <tr>
1.254 wiz 12521: <td>EMUL_EXEC_FMT</td>
1.255 ! wiz 12522: <td>EMUL_IS_NATIVE</td>
1.156 leot 12523: </tr>
12524: <tr>
1.254 wiz 12525: <td>EMUL_MODULES</td>
1.255 ! wiz 12526: <td>EMUL_OPSYS</td>
1.156 leot 12527: </tr>
12528: <tr>
1.254 wiz 12529: <td>EMUL_PKG_FMT</td>
1.255 ! wiz 12530: <td>EMUL_PLATFORM</td>
1.156 leot 12531: </tr>
12532: <tr>
1.254 wiz 12533: <td>EMUL_PLATFORMS</td>
1.255 ! wiz 12534: <td>EMUL_PREFER</td>
1.156 leot 12535: </tr>
12536: <tr>
1.254 wiz 12537: <td>EMUL_REQD</td>
1.255 ! wiz 12538: <td>EMUL_TYPE</td>
1.156 leot 12539: </tr>
12540: <tr>
1.254 wiz 12541: <td>ERROR_MSG</td>
1.255 ! wiz 12542: <td>EXIM_GROUP</td>
1.156 leot 12543: </tr>
12544: <tr>
1.254 wiz 12545: <td>EXIM_USER</td>
1.255 ! wiz 12546: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.156 leot 12547: </tr>
12548: <tr>
1.254 wiz 12549: <td>EXTRACTOR</td>
1.255 ! wiz 12550: <td>EXTRACT_CMD</td>
1.156 leot 12551: </tr>
12552: <tr>
1.254 wiz 12553: <td>EXTRACT_CMD_DEFAULT</td>
1.255 ! wiz 12554: <td>EXTRACT_DIR</td>
1.156 leot 12555: </tr>
12556: <tr>
1.254 wiz 12557: <td>EXTRACT_ELEMENTS</td>
1.255 ! wiz 12558: <td>EXTRACT_ENV</td>
1.156 leot 12559: </tr>
12560: <tr>
1.254 wiz 12561: <td>EXTRACT_ONLY</td>
1.255 ! wiz 12562: <td>EXTRACT_OPTS</td>
1.156 leot 12563: </tr>
12564: <tr>
1.254 wiz 12565: <td>EXTRACT_SUFX</td>
1.255 ! wiz 12566: <td>EXTRACT_USING</td>
1.156 leot 12567: </tr>
12568: <tr>
1.254 wiz 12569: <td>FAIL</td>
1.255 ! wiz 12570: <td>FAILOVER_FETCH</td>
1.223 nia 12571: </tr>
12572: <tr>
1.254 wiz 12573: <td>FAIL_MSG</td>
1.255 ! wiz 12574: <td>FAKE_NCURSES</td>
1.156 leot 12575: </tr>
12576: <tr>
1.254 wiz 12577: <td>FAM</td>
1.255 ! wiz 12578: <td>FAM_ACCEPTED</td>
1.156 leot 12579: </tr>
12580: <tr>
1.254 wiz 12581: <td>FAM_DEFAULT</td>
1.255 ! wiz 12582: <td>FAM_SERVER</td>
1.156 leot 12583: </tr>
12584: <tr>
1.254 wiz 12585: <td>FCPATH</td>
1.255 ! wiz 12586: <td>FEATURE_CPPFLAGS</td>
1.156 leot 12587: </tr>
12588: <tr>
1.254 wiz 12589: <td>FEATURE_LDFLAGS</td>
1.255 ! wiz 12590: <td>FEATURE_LIBS</td>
1.156 leot 12591: </tr>
12592: <tr>
1.254 wiz 12593: <td>FETCH_AFTER_ARGS</td>
1.255 ! wiz 12594: <td>FETCH_BEFORE_ARGS</td>
1.156 leot 12595: </tr>
12596: <tr>
1.254 wiz 12597: <td>FETCH_CMD</td>
1.255 ! wiz 12598: <td>FETCH_OUTPUT_ARGS</td>
1.156 leot 12599: </tr>
12600: <tr>
1.254 wiz 12601: <td>FETCH_PROXY</td>
1.255 ! wiz 12602: <td>FETCH_RESUME_ARGS</td>
1.156 leot 12603: </tr>
12604: <tr>
1.254 wiz 12605: <td>FETCH_TIMEOUT</td>
1.255 ! wiz 12606: <td>FETCH_USE_IPV4_ONLY</td>
1.156 leot 12607: </tr>
12608: <tr>
1.254 wiz 12609: <td>FETCH_USING</td>
1.255 ! wiz 12610: <td>FILES_SUBST</td>
1.177 leot 12611: </tr>
12612: <tr>
1.254 wiz 12613: <td>FILES_SUBST_SED</td>
1.255 ! wiz 12614: <td>FIX_SYSTEM_HEADERS</td>
1.241 rillig 12615: </tr>
12616: <tr>
1.254 wiz 12617: <td>FONTDIR</td>
1.255 ! wiz 12618: <td>FONTS_DIRS</td>
1.156 leot 12619: </tr>
12620: <tr>
1.243 gutterid 12621: <td>FONTS_VERBOSE</td>
1.255 ! wiz 12622: <td>FOO_HACKS_MK</td>
1.177 leot 12623: </tr>
12624: <tr>
1.244 gutterid 12625: <td>FORCE_CXX_STD</td>
1.255 ! wiz 12626: <td>FORCE_C_STD</td>
1.244 gutterid 12627: </tr>
12628: <tr>
1.254 wiz 12629: <td>FOSSIL_EXTRACTDIR</td>
1.255 ! wiz 12630: <td>FOSSIL_REPO</td>
1.254 wiz 12631: </tr>
12632: <tr>
12633: <td>FOSSIL_REPOSITORIES</td>
1.255 ! wiz 12634: <td>FOSSIL_VERSION</td>
1.254 wiz 12635: </tr>
12636: <tr>
1.243 gutterid 12637: <td>FOX_USE_XUNICODE</td>
1.255 ! wiz 12638: <td>FREEWNN_GROUP</td>
1.156 leot 12639: </tr>
12640: <tr>
1.243 gutterid 12641: <td>FREEWNN_USER</td>
1.255 ! wiz 12642: <td>FTP_PKG_URL_DIR</td>
1.156 leot 12643: </tr>
12644: <tr>
1.243 gutterid 12645: <td>FTP_PKG_URL_HOST</td>
1.255 ! wiz 12646: <td>GAMEDATAMODE</td>
1.156 leot 12647: </tr>
12648: <tr>
1.243 gutterid 12649: <td>GAMEDATA_PERMS</td>
1.255 ! wiz 12650: <td>GAMEDIRMODE</td>
1.156 leot 12651: </tr>
12652: <tr>
1.243 gutterid 12653: <td>GAMEDIR_PERMS</td>
1.255 ! wiz 12654: <td>GAMEGRP</td>
1.156 leot 12655: </tr>
12656: <tr>
1.243 gutterid 12657: <td>GAMEMODE</td>
1.255 ! wiz 12658: <td>GAMEOWN</td>
1.156 leot 12659: </tr>
12660: <tr>
1.243 gutterid 12661: <td>GAMES_GROUP</td>
1.255 ! wiz 12662: <td>GAMES_USER</td>
1.156 leot 12663: </tr>
12664: <tr>
1.243 gutterid 12665: <td>GCC</td>
1.255 ! wiz 12666: <td>GCCBASE</td>
1.156 leot 12667: </tr>
12668: <tr>
1.243 gutterid 12669: <td>GCC_REQD</td>
1.255 ! wiz 12670: <td>GCC_VERSION_SUFFIX</td>
1.156 leot 12671: </tr>
12672: <tr>
1.243 gutterid 12673: <td>GEM_BUILD</td>
1.255 ! wiz 12674: <td>GEM_CLEANBUILD</td>
1.156 leot 12675: </tr>
12676: <tr>
1.243 gutterid 12677: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.255 ! wiz 12678: <td>GEM_DOCDIR</td>
1.156 leot 12679: </tr>
12680: <tr>
1.243 gutterid 12681: <td>GEM_EXTSDIR</td>
1.255 ! wiz 12682: <td>GEM_HOME</td>
1.177 leot 12683: </tr>
12684: <tr>
1.243 gutterid 12685: <td>GEM_KEEPBUILD</td>
1.255 ! wiz 12686: <td>GEM_LIBDIR</td>
1.156 leot 12687: </tr>
12688: <tr>
1.243 gutterid 12689: <td>GEM_NAME</td>
1.255 ! wiz 12690: <td>GEM_PATH</td>
1.156 leot 12691: </tr>
12692: <tr>
1.243 gutterid 12693: <td>GEM_PLUGINSDIR</td>
1.255 ! wiz 12694: <td>GEM_SPECFILE</td>
1.198 leot 12695: </tr>
12696: <tr>
1.243 gutterid 12697: <td>GENERATE_PLIST</td>
1.255 ! wiz 12698: <td>GHC</td>
1.156 leot 12699: </tr>
12700: <tr>
1.243 gutterid 12701: <td>GHOSTSCRIPT_REQD</td>
1.255 ! wiz 12702: <td>GITHUB_PROJECT</td>
1.156 leot 12703: </tr>
12704: <tr>
1.243 gutterid 12705: <td>GITHUB_RELEASE</td>
1.255 ! wiz 12706: <td>GITHUB_SUBMODULES</td>
1.177 leot 12707: </tr>
12708: <tr>
1.243 gutterid 12709: <td>GITHUB_TAG</td>
1.255 ! wiz 12710: <td>GITHUB_TYPE</td>
1.159 rillig 12711: </tr>
12712: <tr>
1.243 gutterid 12713: <td>GITLAB_PROJECT</td>
1.255 ! wiz 12714: <td>GITLAB_RELEASE</td>
1.223 nia 12715: </tr>
12716: <tr>
1.243 gutterid 12717: <td>GITLAB_SUBMODULES</td>
1.255 ! wiz 12718: <td>GITLAB_TAG</td>
1.223 nia 12719: </tr>
12720: <tr>
1.243 gutterid 12721: <td>GITLAB_TYPE</td>
1.255 ! wiz 12722: <td>GIT_BRANCH</td>
1.223 nia 12723: </tr>
12724: <tr>
1.254 wiz 12725: <td>GIT_ENV</td>
1.255 ! wiz 12726: <td>GIT_EXTRACTDIR</td>
1.254 wiz 12727: </tr>
12728: <tr>
12729: <td>GIT_REPO</td>
1.255 ! wiz 12730: <td>GIT_REPOSITORIES</td>
1.254 wiz 12731: </tr>
12732: <tr>
12733: <td>GIT_REVISION</td>
1.255 ! wiz 12734: <td>GIT_TAG</td>
1.254 wiz 12735: </tr>
12736: <tr>
1.242 gutterid 12737: <td>GNU</td>
1.255 ! wiz 12738: <td>GNU_CONFIGURE</td>
1.254 wiz 12739: </tr>
12740: <tr>
12741: <td>GNU_CONFIGURE_INFODIR</td>
1.255 ! wiz 12742: <td>GNU_CONFIGURE_MANDIR</td>
1.246 leot 12743: </tr>
12744: <tr>
1.254 wiz 12745: <td>GNU_CONFIGURE_QUIET</td>
1.255 ! wiz 12746: <td>GNU_CONFIGURE_STRICT</td>
1.241 rillig 12747: </tr>
12748: <tr>
1.254 wiz 12749: <td>GODEP_REDIRECTS</td>
1.255 ! wiz 12750: <td>GO_BUILD_PATTERN</td>
1.233 wiz 12751: </tr>
12752: <tr>
1.254 wiz 12753: <td>GO_DEPS</td>
1.255 ! wiz 12754: <td>GO_DIST_BASE</td>
1.156 leot 12755: </tr>
12756: <tr>
1.254 wiz 12757: <td>GO_EXTRA_MOD_DIRS</td>
1.255 ! wiz 12758: <td>GO_MODULE_FILES</td>
1.156 leot 12759: </tr>
12760: <tr>
1.254 wiz 12761: <td>GO_SRCPATH</td>
1.255 ! wiz 12762: <td>GROUP_SPECIFIC_PKGS</td>
1.156 leot 12763: </tr>
12764: <tr>
1.254 wiz 12765: <td>GRUB_NETWORK_CARDS</td>
1.255 ! wiz 12766: <td>GRUB_PRESET_COMMAND</td>
1.238 wiz 12767: </tr>
12768: <tr>
1.254 wiz 12769: <td>GRUB_SCAN_ARGS</td>
1.255 ! wiz 12770: <td>GZIP</td>
1.156 leot 12771: </tr>
12772: <tr>
1.254 wiz 12773: <td>HASKELL_COMPILER</td>
1.255 ! wiz 12774: <td>HASKELL_DISABLE_EXECUTABLES</td>
1.156 leot 12775: </tr>
12776: <tr>
1.255 ! wiz 12777: <td>HASKELL_DISABLE_LIBRARIES</td>
1.233 wiz 12778: <td>HASKELL_ENABLE_DYNAMIC_EXECUTABLE</td>
1.217 rillig 12779: </tr>
12780: <tr>
1.255 ! wiz 12781: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.222 gutterid 12782: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.226 gutterid 12783: </tr>
12784: <tr>
1.255 ! wiz 12785: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.236 gutterid 12786: <td>HASKELL_ENABLE_TESTS</td>
1.220 nia 12787: </tr>
12788: <tr>
1.255 ! wiz 12789: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.232 gutterid 12790: <td>HASKELL_PKG_NAME</td>
1.229 gutterid 12791: </tr>
12792: <tr>
1.255 ! wiz 12793: <td>HASKELL_UNRESTRICT_DEPENDENCIES</td>
1.226 gutterid 12794: <td>HEADER_TEMPLATES</td>
1.254 wiz 12795: </tr>
12796: <tr>
1.255 ! wiz 12797: <td>HG_REPO</td>
1.254 wiz 12798: <td>HG_REPOSITORIES</td>
1.214 leot 12799: </tr>
12800: <tr>
1.255 ! wiz 12801: <td>HG_TAG</td>
1.254 wiz 12802: <td>HOMEPAGE</td>
1.246 leot 12803: </tr>
12804: <tr>
1.255 ! wiz 12805: <td>HOST_PKGTOOLS_ARGS</td>
1.254 wiz 12806: <td>HOST_SPECIFIC_PKGS</td>
1.241 rillig 12807: </tr>
12808: <tr>
1.255 ! wiz 12809: <td>HOWL_GROUP</td>
1.254 wiz 12810: <td>HOWL_USER</td>
1.233 wiz 12811: </tr>
12812: <tr>
1.255 ! wiz 12813: <td>ICCBASE</td>
1.254 wiz 12814: <td>ICECAST_CHROOTDIR</td>
1.227 wiz 12815: </tr>
12816: <tr>
1.255 ! wiz 12817: <td>ICON_THEMES</td>
1.254 wiz 12818: <td>IDOBASE</td>
1.223 nia 12819: </tr>
12820: <tr>
1.255 ! wiz 12821: <td>IGNORE_CCACHE</td>
1.254 wiz 12822: <td>IGNORE_INFO_DIRS</td>
1.156 leot 12823: </tr>
12824: <tr>
1.255 ! wiz 12825: <td>IGNORE_INTERACTIVE_FETCH</td>
1.254 wiz 12826: <td>IMAKE</td>
1.156 leot 12827: </tr>
12828: <tr>
1.255 ! wiz 12829: <td>IMAKEOPTS</td>
1.254 wiz 12830: <td>IMAKE_MAKE</td>
1.191 bacon 12831: </tr>
12832: <tr>
1.255 ! wiz 12833: <td>IMAKE_MANINSTALL</td>
1.254 wiz 12834: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.156 leot 12835: </tr>
12836: <tr>
1.255 ! wiz 12837: <td>IMDICTDIR</td>
1.254 wiz 12838: <td>INCOMPAT_CURSES</td>
1.156 leot 12839: </tr>
12840: <tr>
1.255 ! wiz 12841: <td>INFO_DIR</td>
1.254 wiz 12842: <td>INFO_FILES</td>
1.156 leot 12843: </tr>
12844: <tr>
1.255 ! wiz 12845: <td>INFO_MSG</td>
1.254 wiz 12846: <td>INIT_SYSTEM</td>
1.156 leot 12847: </tr>
12848: <tr>
1.255 ! wiz 12849: <td>INN_DATA_DIR</td>
1.254 wiz 12850: <td>INN_GROUP</td>
1.156 leot 12851: </tr>
12852: <tr>
1.255 ! wiz 12853: <td>INN_USER</td>
1.254 wiz 12854: <td>INSTALLATION_DIRS</td>
1.156 leot 12855: </tr>
12856: <tr>
1.255 ! wiz 12857: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.254 wiz 12858: <td>INSTALL_ENV</td>
1.156 leot 12859: </tr>
12860: <tr>
1.255 ! wiz 12861: <td>INSTALL_SH_OVERRIDE</td>
1.254 wiz 12862: <td>INSTALL_SRC</td>
1.156 leot 12863: </tr>
12864: <tr>
1.255 ! wiz 12865: <td>INSTALL_TEMPLATES</td>
1.254 wiz 12866: <td>INSTALL_UNSTRIPPED</td>
12867: </tr>
12868: <tr>
1.255 ! wiz 12869: <td>IRCD_HYBRID_IRC_GROUP</td>
1.249 gutterid 12870: <td>IRCD_HYBRID_IRC_USER</td>
1.172 rillig 12871: </tr>
12872: <tr>
1.255 ! wiz 12873: <td>IRCD_HYBRID_MAXCONN</td>
1.249 gutterid 12874: <td>IRCD_HYBRID_NICLEN</td>
1.156 leot 12875: </tr>
12876: <tr>
1.255 ! wiz 12877: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.249 gutterid 12878: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.156 leot 12879: </tr>
12880: <tr>
1.255 ! wiz 12881: <td>IRCD_HYBRID_TOPICLEN</td>
1.249 gutterid 12882: <td>IRIX</td>
1.156 leot 12883: </tr>
12884: <tr>
1.255 ! wiz 12885: <td>IRRD_USE_PGP</td>
1.249 gutterid 12886: <td>JABBERD_GROUP</td>
1.156 leot 12887: </tr>
12888: <tr>
1.255 ! wiz 12889: <td>JABBERD_LOGDIR</td>
1.249 gutterid 12890: <td>JABBERD_PIDDIR</td>
1.156 leot 12891: </tr>
12892: <tr>
1.255 ! wiz 12893: <td>JABBERD_SPOOLDIR</td>
1.243 gutterid 12894: <td>JABBERD_USER</td>
1.156 leot 12895: </tr>
12896: <tr>
1.255 ! wiz 12897: <td>JAVA_APP_PATH</td>
1.254 wiz 12898: <td>JAVA_APP_TARGETS</td>
12899: </tr>
12900: <tr>
1.255 ! wiz 12901: <td>JAVA_BINPREFIX</td>
1.249 gutterid 12902: <td>JAVA_CLASSPATH</td>
1.246 leot 12903: </tr>
12904: <tr>
1.255 ! wiz 12905: <td>JAVA_HOME</td>
1.249 gutterid 12906: <td>JAVA_LD_LIBRARY_PATH</td>
1.156 leot 12907: </tr>
12908: <tr>
1.255 ! wiz 12909: <td>JAVA_NAME</td>
1.249 gutterid 12910: <td>JAVA_UNLIMIT</td>
1.233 wiz 12911: </tr>
12912: <tr>
1.255 ! wiz 12913: <td>JAVA_WRAPPERS</td>
1.249 gutterid 12914: <td>JPEG_ACCEPTED</td>
1.156 leot 12915: </tr>
12916: <tr>
1.255 ! wiz 12917: <td>JPEG_DEFAULT</td>
1.249 gutterid 12918: <td>KERBEROS</td>
1.227 wiz 12919: </tr>
12920: <tr>
1.255 ! wiz 12921: <td>KERMIT_SUID_UUCP</td>
1.249 gutterid 12922: <td>KJS_USE_PCRE</td>
1.177 leot 12923: </tr>
12924: <tr>
1.255 ! wiz 12925: <td>KNEWS_DOMAIN_FILE</td>
1.249 gutterid 12926: <td>KNEWS_DOMAIN_NAME</td>
1.156 leot 12927: </tr>
12928: <tr>
1.255 ! wiz 12929: <td>KRB5_ACCEPTED</td>
1.249 gutterid 12930: <td>KRB5_DEFAULT</td>
1.217 rillig 12931: </tr>
12932: <tr>
1.255 ! wiz 12933: <td>LANGUAGES</td>
1.249 gutterid 12934: <td>LAPACKE_LIBS</td>
1.156 leot 12935: </tr>
12936: <tr>
1.255 ! wiz 12937: <td>LAPACKE_PC</td>
1.249 gutterid 12938: <td>LAPACK_LIBS</td>
1.156 leot 12939: </tr>
12940: <tr>
1.255 ! wiz 12941: <td>LAPACK_PC</td>
1.249 gutterid 12942: <td>LATEX2HTML_ICONPATH</td>
1.156 leot 12943: </tr>
12944: <tr>
1.255 ! wiz 12945: <td>LDCONFIG_ADD_CMD</td>
1.249 gutterid 12946: <td>LDCONFIG_REMOVE_CMD</td>
1.156 leot 12947: </tr>
12948: <tr>
1.255 ! wiz 12949: <td>LDD</td>
1.249 gutterid 12950: <td>LEAFNODE_DATA_DIR</td>
1.156 leot 12951: </tr>
12952: <tr>
1.255 ! wiz 12953: <td>LEAFNODE_GROUP</td>
1.249 gutterid 12954: <td>LEAFNODE_USER</td>
1.177 leot 12955: </tr>
12956: <tr>
1.255 ! wiz 12957: <td>LIBDVDCSS_HOMEPAGE</td>
1.249 gutterid 12958: <td>LIBDVDCSS_MASTER_SITES</td>
1.156 leot 12959: </tr>
12960: <tr>
1.255 ! wiz 12961: <td>LIBIMAGEQUANT_TYPE</td>
1.249 gutterid 12962: <td>LIBRSVG_TYPE</td>
1.156 leot 12963: </tr>
12964: <tr>
1.255 ! wiz 12965: <td>LIBTOOL</td>
1.249 gutterid 12966: <td>LIBTOOLIZE_PLIST</td>
1.156 leot 12967: </tr>
12968: <tr>
1.255 ! wiz 12969: <td>LIBTOOL_M4_OVERRIDE</td>
1.249 gutterid 12970: <td>LIBUSB_TYPE</td>
1.156 leot 12971: </tr>
12972: <tr>
1.255 ! wiz 12973: <td>LICENSE</td>
1.249 gutterid 12974: <td>LINKER_RPATH_FLAG</td>
1.254 wiz 12975: </tr>
12976: <tr>
1.255 ! wiz 12977: <td>LINK_RPATH_FLAG</td>
1.254 wiz 12978: <td>LINUX_BASE_NODEPS</td>
1.205 wiz 12979: </tr>
12980: <tr>
1.255 ! wiz 12981: <td>LINUX_BASE_PREFERRED</td>
1.254 wiz 12982: <td>LINUX_BASE_REQUIRED</td>
1.241 rillig 12983: </tr>
12984: <tr>
1.255 ! wiz 12985: <td>LINUX_LOCALES</td>
1.244 gutterid 12986: <td>LOCALBASE</td>
1.156 leot 12987: </tr>
12988: <tr>
1.255 ! wiz 12989: <td>LOCALBASE_LOCKTYPE</td>
1.244 gutterid 12990: <td>LOCALPATCHES</td>
1.255 ! wiz 12991: </tr>
! 12992: <tr>
1.242 gutterid 12993: <td>LOVE_DATA</td>
1.255 ! wiz 12994: <td>LOVE_GAME</td>
1.238 wiz 12995: </tr>
12996: <tr>
1.242 gutterid 12997: <td>LOVE_VERSION</td>
1.255 ! wiz 12998: <td>LOWER_OPSYS</td>
! 12999: </tr>
! 13000: <tr>
! 13001: <td>LOWER_OPSYS_VERSUFFIX</td>
! 13002: <td>LOWER_VARIANT_VERSION</td>
1.223 nia 13003: </tr>
13004: <tr>
1.255 ! wiz 13005: <td>LOWER_VENDOR</td>
1.244 gutterid 13006: <td>LP32PLATFORMS</td>
1.177 leot 13007: </tr>
13008: <tr>
1.255 ! wiz 13009: <td>LP64PLATFORMS</td>
1.244 gutterid 13010: <td>LUA_BUSTED_ARGS</td>
1.214 leot 13011: </tr>
13012: <tr>
1.255 ! wiz 13013: <td>LUA_CDIR</td>
1.244 gutterid 13014: <td>LUA_COMPILER</td>
1.197 leot 13015: </tr>
13016: <tr>
1.255 ! wiz 13017: <td>LUA_DOCDIR</td>
1.244 gutterid 13018: <td>LUA_EXAMPLESDIR</td>
1.156 leot 13019: </tr>
13020: <tr>
1.255 ! wiz 13021: <td>LUA_INCDIR</td>
1.244 gutterid 13022: <td>LUA_INTERPRETER</td>
1.156 leot 13023: </tr>
13024: <tr>
1.255 ! wiz 13025: <td>LUA_LDIR</td>
1.244 gutterid 13026: <td>LUA_LINKER_MAGIC</td>
1.221 nia 13027: </tr>
13028: <tr>
1.255 ! wiz 13029: <td>LUA_PKGPREFIX</td>
1.244 gutterid 13030: <td>LUA_SELF_CONFLICT</td>
1.218 nia 13031: </tr>
13032: <tr>
1.255 ! wiz 13033: <td>LUA_USE_BUSTED</td>
1.244 gutterid 13034: <td>LUA_VERSIONS_ACCEPTED</td>
1.218 nia 13035: </tr>
13036: <tr>
1.255 ! wiz 13037: <td>LUA_VERSIONS_INCOMPATIBLE</td>
1.244 gutterid 13038: <td>LUA_VERSION_DEFAULT</td>
1.218 nia 13039: </tr>
13040: <tr>
1.255 ! wiz 13041: <td>LUA_VERSION_REQD</td>
1.244 gutterid 13042: <td>Lua</td>
1.218 nia 13043: </tr>
13044: <tr>
1.255 ! wiz 13045: <td>MACHINE_PLATFORM</td>
1.244 gutterid 13046: <td>MAILAGENT_DOMAIN</td>
1.218 nia 13047: </tr>
13048: <tr>
1.255 ! wiz 13049: <td>MAILAGENT_EMAIL</td>
1.244 gutterid 13050: <td>MAILAGENT_FQDN</td>
1.218 nia 13051: </tr>
13052: <tr>
1.255 ! wiz 13053: <td>MAILAGENT_ORGANIZATION</td>
1.244 gutterid 13054: <td>MAJORDOMO_HOMEDIR</td>
1.254 wiz 13055: </tr>
13056: <tr>
1.255 ! wiz 13057: <td>MAJOR_OS_VERSION</td>
1.249 gutterid 13058: <td>MAKEINFO_ARGS</td>
1.246 leot 13059: </tr>
13060: <tr>
1.255 ! wiz 13061: <td>MAKE_DIRS</td>
1.249 gutterid 13062: <td>MAKE_DIRS_PERMS</td>
1.205 wiz 13063: </tr>
13064: <tr>
1.255 ! wiz 13065: <td>MAKE_ENV</td>
1.249 gutterid 13066: <td>MAKE_FILE</td>
1.233 wiz 13067: </tr>
13068: <tr>
1.255 ! wiz 13069: <td>MAKE_FLAGS</td>
1.249 gutterid 13070: <td>MAKE_JOBS</td>
1.227 wiz 13071: </tr>
13072: <tr>
1.255 ! wiz 13073: <td>MAKE_JOBS_SAFE</td>
1.249 gutterid 13074: <td>MAKE_PROGRAM</td>
1.156 leot 13075: </tr>
13076: <tr>
1.255 ! wiz 13077: <td>MANCOMPRESSED_IF_MANZ</td>
1.249 gutterid 13078: <td>MANINSTALL</td>
1.212 wiz 13079: </tr>
13080: <tr>
1.255 ! wiz 13081: <td>MANZ</td>
1.249 gutterid 13082: <td>MARIADB_VERSIONS_ALL</td>
1.156 leot 13083: </tr>
13084: <tr>
1.255 ! wiz 13085: <td>MASTER_SITES</td>
1.249 gutterid 13086: <td>MASTER_SITE_BACKUP</td>
1.156 leot 13087: </tr>
13088: <tr>
1.255 ! wiz 13089: <td>MASTER_SITE_LOCAL</td>
1.249 gutterid 13090: <td>MASTER_SITE_MOZILLA</td>
1.156 leot 13091: </tr>
13092: <tr>
1.255 ! wiz 13093: <td>MASTER_SITE_OVERRIDE</td>
1.249 gutterid 13094: <td>MASTER_SITE_PERL_CPAN</td>
1.156 leot 13095: </tr>
13096: <tr>
1.255 ! wiz 13097: <td>MASTER_SORT</td>
1.249 gutterid 13098: <td>MASTER_SORT_RANDOM</td>
1.189 bacon 13099: </tr>
13100: <tr>
1.255 ! wiz 13101: <td>MASTER_SORT_REGEX</td>
1.249 gutterid 13102: <td>MECAB_CHARSET</td>
1.156 leot 13103: </tr>
13104: <tr>
1.255 ! wiz 13105: <td>MEDIATOMB_GROUP</td>
1.249 gutterid 13106: <td>MEDIATOMB_USER</td>
1.156 leot 13107: </tr>
13108: <tr>
1.255 ! wiz 13109: <td>MIPSPROBASE</td>
1.249 gutterid 13110: <td>MIREDO_GROUP</td>
1.156 leot 13111: </tr>
13112: <tr>
1.255 ! wiz 13113: <td>MIREDO_USER</td>
1.249 gutterid 13114: <td>MISSING_FEATURES</td>
1.156 leot 13115: </tr>
13116: <tr>
1.255 ! wiz 13117: <td>MKDIR</td>
1.249 gutterid 13118: <td>MKPIE_SUPPORTED</td>
1.156 leot 13119: </tr>
13120: <tr>
1.255 ! wiz 13121: <td>MLDONKEY_GROUP</td>
1.249 gutterid 13122: <td>MLDONKEY_HOME</td>
1.156 leot 13123: </tr>
13124: <tr>
1.255 ! wiz 13125: <td>MLDONKEY_USER</td>
1.249 gutterid 13126: <td>MONOTONE_GROUP</td>
1.156 leot 13127: </tr>
13128: <tr>
1.255 ! wiz 13129: <td>MONOTONE_USER</td>
1.249 gutterid 13130: <td>MOTIFBASE</td>
1.156 leot 13131: </tr>
13132: <tr>
1.255 ! wiz 13133: <td>MOTIF_TYPE</td>
1.249 gutterid 13134: <td>MOTIF_TYPE_DEFAULT</td>
1.156 leot 13135: </tr>
13136: <tr>
1.255 ! wiz 13137: <td>MPI_TYPE</td>
1.249 gutterid 13138: <td>MSGFMT_STRIP_MSGCTXT</td>
1.207 leot 13139: </tr>
13140: <tr>
1.255 ! wiz 13141: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.232 gutterid 13142: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.241 rillig 13143: </tr>
13144: <tr>
1.255 ! wiz 13145: <td>MUST</td>
1.244 gutterid 13146: <td>MV</td>
1.156 leot 13147: </tr>
13148: <tr>
1.255 ! wiz 13149: <td>MYSQL_CHARSET</td>
1.244 gutterid 13150: <td>MYSQL_DATADIR</td>
1.238 wiz 13151: </tr>
13152: <tr>
1.255 ! wiz 13153: <td>MYSQL_EXTRA_CHARSET</td>
1.244 gutterid 13154: <td>MYSQL_GROUP</td>
1.223 nia 13155: </tr>
13156: <tr>
1.255 ! wiz 13157: <td>MYSQL_USER</td>
1.244 gutterid 13158: <td>MYSQL_VERSION</td>
1.214 leot 13159: </tr>
13160: <tr>
1.255 ! wiz 13161: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.244 gutterid 13162: <td>MYSQL_VERSION_DEFAULT</td>
1.197 leot 13163: </tr>
13164: <tr>
1.255 ! wiz 13165: <td>NAGIOSCMD_GROUP</td>
1.244 gutterid 13166: <td>NAGIOSDIR</td>
1.205 wiz 13167: </tr>
13168: <tr>
1.255 ! wiz 13169: <td>NAGIOS_GROUP</td>
1.244 gutterid 13170: <td>NAGIOS_USER</td>
1.156 leot 13171: </tr>
13172: <tr>
1.242 gutterid 13173: <td>NATIVE_EXEC_FMT</td>
1.255 ! wiz 13174: <td>NATIVE_LOWER_OPSYS</td>
1.156 leot 13175: </tr>
13176: <tr>
1.255 ! wiz 13177: <td>NATIVE_LOWER_VENDOR</td>
1.244 gutterid 13178: <td>NATIVE_MACHINE_PLATFORM</td>
1.156 leot 13179: </tr>
13180: <tr>
1.255 ! wiz 13181: <td>NATIVE_OPSYS_VERSION</td>
! 13182: <td>NATIVE_OS_VARIANT</td>
! 13183: </tr>
! 13184: <tr>
! 13185: <td>NATIVE_OS_VERSION</td>
1.244 gutterid 13186: <td>NBPAX_PROGRAM_PREFIX</td>
1.255 ! wiz 13187: </tr>
! 13188: <tr>
1.242 gutterid 13189: <td>NETBSD_LOGIN_NAME</td>
1.255 ! wiz 13190: <td>NMH_EDITOR</td>
1.156 leot 13191: </tr>
13192: <tr>
1.242 gutterid 13193: <td>NMH_MTA</td>
1.255 ! wiz 13194: <td>NMH_PAGER</td>
1.195 gutterid 13195: </tr>
13196: <tr>
1.242 gutterid 13197: <td>NODE_VERSIONS_ACCEPTED</td>
1.255 ! wiz 13198: <td>NODE_VERSIONS_INCOMPATIBLE</td>
1.156 leot 13199: </tr>
13200: <tr>
1.242 gutterid 13201: <td>NODE_VERSION_DEFAULT</td>
1.255 ! wiz 13202: <td>NODE_VERSION_REQD</td>
1.156 leot 13203: </tr>
13204: <tr>
1.242 gutterid 13205: <td>NOLOGIN</td>
1.255 ! wiz 13206: <td>NOTE</td>
1.156 leot 13207: </tr>
13208: <tr>
1.242 gutterid 13209: <td>NOT_FOR_PLATFORM</td>
1.255 ! wiz 13210: <td>NOT_PAX_ASLR_SAFE</td>
1.156 leot 13211: </tr>
13212: <tr>
1.242 gutterid 13213: <td>NOT_PAX_MPROTECT_SAFE</td>
1.255 ! wiz 13214: <td>NO_BUILD</td>
1.156 leot 13215: </tr>
13216: <tr>
1.242 gutterid 13217: <td>NO_CHECKSUM</td>
1.255 ! wiz 13218: <td>NO_CONFIGURE</td>
1.229 gutterid 13219: </tr>
13220: <tr>
1.242 gutterid 13221: <td>NO_SKIP</td>
1.255 ! wiz 13222: <td>NS_PREFERRED</td>
1.218 nia 13223: </tr>
13224: <tr>
1.242 gutterid 13225: <td>NULLMAILER_GROUP</td>
1.255 ! wiz 13226: <td>NULLMAILER_USER</td>
1.218 nia 13227: </tr>
13228: <tr>
1.255 ! wiz 13229: <td>OBJECT_FMT</td>
1.242 gutterid 13230: <td>OBJHOSTNAME</td>
1.156 leot 13231: </tr>
13232: <tr>
1.244 gutterid 13233: <td>OBJMACHINE</td>
1.242 gutterid 13234: <td>OCAML_FINDLIB_DIRS</td>
1.178 rillig 13235: </tr>
13236: <tr>
1.244 gutterid 13237: <td>OCAML_FINDLIB_REGISTER</td>
1.242 gutterid 13238: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.156 leot 13239: </tr>
13240: <tr>
1.244 gutterid 13241: <td>OCAML_SITELIBDIR</td>
1.242 gutterid 13242: <td>OMF</td>
1.156 leot 13243: </tr>
13244: <tr>
1.244 gutterid 13245: <td>ONLY_FOR_COMPILER</td>
1.242 gutterid 13246: <td>ONLY_FOR_PLATFORM</td>
1.156 leot 13247: </tr>
13248: <tr>
1.244 gutterid 13249: <td>OPENSSH_CHROOT</td>
1.242 gutterid 13250: <td>OPENSSH_GROUP</td>
1.156 leot 13251: </tr>
13252: <tr>
1.244 gutterid 13253: <td>OPENSSH_USER</td>
1.242 gutterid 13254: <td>OPSYS</td>
1.156 leot 13255: </tr>
13256: <tr>
1.244 gutterid 13257: <td>OPSYS_EMULDIR</td>
1.242 gutterid 13258: <td>OPSYS_VERSION</td>
1.156 leot 13259: </tr>
13260: <tr>
1.244 gutterid 13261: <td>OS</td>
1.242 gutterid 13262: <td>OSS_TYPE</td>
1.156 leot 13263: </tr>
13264: <tr>
1.244 gutterid 13265: <td>OSX</td>
1.254 wiz 13266: <td>OSX_PATH_TO_M4</td>
13267: </tr>
13268: <tr>
13269: <td>OSX_PATH_TO_YACC</td>
13270: <td>OS_HAVE_ALSA</td>
13271: </tr>
13272: <tr>
13273: <td>OS_HAVE_RCD</td>
1.239 dholland 13274: <td>OS_VARIANT</td>
1.241 rillig 13275: </tr>
13276: <tr>
1.244 gutterid 13277: <td>OS_VERSION</td>
1.241 rillig 13278: <td>OTF_FONTS_DIR</td>
1.238 wiz 13279: </tr>
13280: <tr>
1.244 gutterid 13281: <td>OVERRIDE_DIRDEPTH</td>
1.241 rillig 13282: <td>OVERRIDE_GEMSPEC</td>
1.156 leot 13283: </tr>
13284: <tr>
1.244 gutterid 13285: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.254 wiz 13286: <td>OVERRIDE_ROCKSPEC</td>
13287: </tr>
13288: <tr>
1.249 gutterid 13289: <td>OWN_DIRS</td>
1.254 wiz 13290: <td>OWN_DIRS_PERMS</td>
1.246 leot 13291: </tr>
13292: <tr>
1.249 gutterid 13293: <td>P4GROUP</td>
1.254 wiz 13294: <td>P4PORT</td>
1.233 wiz 13295: </tr>
13296: <tr>
1.249 gutterid 13297: <td>P4ROOT</td>
1.254 wiz 13298: <td>P4USER</td>
1.214 leot 13299: </tr>
13300: <tr>
1.249 gutterid 13301: <td>PACKAGES</td>
1.254 wiz 13302: <td>PALMOS_DEFAULT_SDK</td>
1.227 wiz 13303: </tr>
13304: <tr>
1.249 gutterid 13305: <td>PAMBASE</td>
1.254 wiz 13306: <td>PAM_DEFAULT</td>
1.205 wiz 13307: </tr>
13308: <tr>
1.249 gutterid 13309: <td>PAPERSIZE</td>
1.254 wiz 13310: <td>PASSIVE_FETCH</td>
1.161 leot 13311: </tr>
13312: <tr>
1.249 gutterid 13313: <td>PATCHDIR</td>
1.254 wiz 13314: <td>PATCHFILES</td>
1.156 leot 13315: </tr>
13316: <tr>
1.249 gutterid 13317: <td>PATCH_ARGS</td>
1.254 wiz 13318: <td>PATCH_DEBUG</td>
1.156 leot 13319: </tr>
13320: <tr>
1.249 gutterid 13321: <td>PATCH_DIST_ARGS</td>
1.254 wiz 13322: <td>PATCH_DIST_CAT</td>
1.156 leot 13323: </tr>
13324: <tr>
1.249 gutterid 13325: <td>PATCH_DIST_STRIP</td>
1.254 wiz 13326: <td>PATCH_FUZZ_FACTOR</td>
1.156 leot 13327: </tr>
13328: <tr>
1.249 gutterid 13329: <td>PATCH_STRIP</td>
1.254 wiz 13330: <td>PATH</td>
1.156 leot 13331: </tr>
13332: <tr>
1.233 wiz 13333: <td>PCCBASE</td>
1.254 wiz 13334: <td>PEAR</td>
13335: </tr>
13336: <tr>
13337: <td>PEAR_CHANNEL</td>
13338: <td>PEAR_CHANNEL_ALIAS</td>
1.246 leot 13339: </tr>
13340: <tr>
1.254 wiz 13341: <td>PEAR_CHANNEL_VERSION</td>
1.244 gutterid 13342: <td>PEAR_CMD</td>
1.254 wiz 13343: </tr>
13344: <tr>
1.249 gutterid 13345: <td>PEAR_LIB</td>
1.254 wiz 13346: <td>PEAR_PACKAGE_XML</td>
1.227 wiz 13347: </tr>
13348: <tr>
1.249 gutterid 13349: <td>PERL5</td>
1.254 wiz 13350: <td>PERL5_CONFIGURE</td>
1.156 leot 13351: </tr>
13352: <tr>
1.249 gutterid 13353: <td>PERL5_CONFIGURE_DIRS</td>
1.254 wiz 13354: <td>PERL5_LDFLAGS</td>
1.217 rillig 13355: </tr>
13356: <tr>
1.249 gutterid 13357: <td>PERL5_LICENSE</td>
1.254 wiz 13358: <td>PERL5_MODULE_TYPE</td>
1.205 wiz 13359: </tr>
13360: <tr>
1.249 gutterid 13361: <td>PERL5_PACKLIST</td>
1.254 wiz 13362: <td>PERL5_PACKLIST_DIR</td>
1.177 leot 13363: </tr>
13364: <tr>
1.249 gutterid 13365: <td>PERL5_PERLBASE</td>
1.254 wiz 13366: <td>PERL5_SITEBASE</td>
1.161 leot 13367: </tr>
13368: <tr>
1.249 gutterid 13369: <td>PERL5_USE_PACKLIST</td>
1.254 wiz 13370: <td>PERL5_VENDORBASE</td>
1.161 leot 13371: </tr>
13372: <tr>
1.249 gutterid 13373: <td>PFCTL</td>
1.254 wiz 13374: <td>PFVAR_H</td>
1.156 leot 13375: </tr>
13376: <tr>
1.249 gutterid 13377: <td>PF_VERSION</td>
1.254 wiz 13378: <td>PGGROUP</td>
1.156 leot 13379: </tr>
13380: <tr>
1.249 gutterid 13381: <td>PGHOME</td>
1.254 wiz 13382: <td>PGPKGSRCDIR</td>
1.156 leot 13383: </tr>
13384: <tr>
1.249 gutterid 13385: <td>PGSQL_TYPE</td>
1.254 wiz 13386: <td>PGSQL_VERSION</td>
1.156 leot 13387: </tr>
13388: <tr>
1.249 gutterid 13389: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.254 wiz 13390: <td>PGSQL_VERSION_DEFAULT</td>
1.156 leot 13391: </tr>
13392: <tr>
1.249 gutterid 13393: <td>PGUSER</td>
1.254 wiz 13394: <td>PG_LIB_EXT</td>
1.156 leot 13395: </tr>
13396: <tr>
1.249 gutterid 13397: <td>PHP</td>
1.254 wiz 13398: <td>PHPCOMMON_MK</td>
1.156 leot 13399: </tr>
13400: <tr>
1.249 gutterid 13401: <td>PHPPKGSRCDIR</td>
1.254 wiz 13402: <td>PHP_BASE_VERS</td>
1.156 leot 13403: </tr>
13404: <tr>
1.249 gutterid 13405: <td>PHP_CHECK_INSTALLED</td>
1.254 wiz 13406: <td>PHP_EXTENSION_DIR</td>
1.156 leot 13407: </tr>
13408: <tr>
1.249 gutterid 13409: <td>PHP_INITIAL_TEENY</td>
1.254 wiz 13410: <td>PHP_PKG_PREFIX</td>
1.156 leot 13411: </tr>
13412: <tr>
1.249 gutterid 13413: <td>PHP_VERSION</td>
1.254 wiz 13414: <td>PHP_VERSIONS_ACCEPTED</td>
1.156 leot 13415: </tr>
13416: <tr>
1.249 gutterid 13417: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.254 wiz 13418: <td>PHP_VERSION_DEFAULT</td>
1.156 leot 13419: </tr>
13420: <tr>
1.249 gutterid 13421: <td>PHP_VERSION_REQD</td>
1.254 wiz 13422: <td>PILRC_USE_GTK</td>
1.156 leot 13423: </tr>
13424: <tr>
1.249 gutterid 13425: <td>PKGCONFIG_BASE</td>
1.254 wiz 13426: <td>PKGCONFIG_FILE</td>
1.156 leot 13427: </tr>
13428: <tr>
1.249 gutterid 13429: <td>PKGCONFIG_OVERRIDE</td>
1.254 wiz 13430: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.156 leot 13431: </tr>
13432: <tr>
1.249 gutterid 13433: <td>PKGDIR</td>
1.254 wiz 13434: <td>PKGGNUDIR</td>
1.156 leot 13435: </tr>
13436: <tr>
1.249 gutterid 13437: <td>PKGINFODIR</td>
1.254 wiz 13438: <td>PKGLOCALEDIR</td>
1.156 leot 13439: </tr>
13440: <tr>
1.249 gutterid 13441: <td>PKGMANDIR</td>
1.254 wiz 13442: <td>PKGNAME</td>
1.156 leot 13443: </tr>
13444: <tr>
1.249 gutterid 13445: <td>PKGNAME_REQD</td>
1.254 wiz 13446: <td>PKGPATH</td>
1.156 leot 13447: </tr>
13448: <tr>
1.249 gutterid 13449: <td>PKGREVISION</td>
1.254 wiz 13450: <td>PKGSRC_BLAS_TYPES</td>
1.156 leot 13451: </tr>
13452: <tr>
1.249 gutterid 13453: <td>PKGSRC_CHANGES</td>
1.254 wiz 13454: <td>PKGSRC_COMPILER</td>
1.156 leot 13455: </tr>
13456: <tr>
1.249 gutterid 13457: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.254 wiz 13458: <td>PKGSRC_LOCKTYPE</td>
1.156 leot 13459: </tr>
13460: <tr>
1.249 gutterid 13461: <td>PKGSRC_MAKE_ENV</td>
1.254 wiz 13462: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.156 leot 13463: </tr>
13464: <tr>
1.249 gutterid 13465: <td>PKGSRC_MKPIE</td>
1.254 wiz 13466: <td>PKGSRC_MKREPRO</td>
1.156 leot 13467: </tr>
13468: <tr>
1.249 gutterid 13469: <td>PKGSRC_OVERRIDE_MKPIE</td>
1.254 wiz 13470: <td>PKGSRC_RUN_TEST</td>
1.177 leot 13471: </tr>
13472: <tr>
1.249 gutterid 13473: <td>PKGSRC_SETENV</td>
1.254 wiz 13474: <td>PKGSRC_SLEEPSECS</td>
1.156 leot 13475: </tr>
13476: <tr>
1.249 gutterid 13477: <td>PKGSRC_TODO</td>
1.254 wiz 13478: <td>PKGSRC_USE_CTF</td>
1.159 rillig 13479: </tr>
13480: <tr>
1.249 gutterid 13481: <td>PKGSRC_USE_FORTIFY</td>
1.254 wiz 13482: <td>PKGSRC_USE_MKTOOLS</td>
1.156 leot 13483: </tr>
13484: <tr>
1.249 gutterid 13485: <td>PKGSRC_USE_RELRO</td>
1.254 wiz 13486: <td>PKGSRC_USE_SSP</td>
1.156 leot 13487: </tr>
13488: <tr>
1.249 gutterid 13489: <td>PKGSRC_USE_STACK_CHECK</td>
1.254 wiz 13490: <td>PKGTASKS_DATAFILE</td>
1.156 leot 13491: </tr>
13492: <tr>
1.249 gutterid 13493: <td>PKGTOOLS_ARGS</td>
1.254 wiz 13494: <td>PKGTOOLS_ENV</td>
1.156 leot 13495: </tr>
13496: <tr>
1.249 gutterid 13497: <td>PKG_ALTERNATIVES</td>
1.254 wiz 13498: <td>PKG_APACHE</td>
1.156 leot 13499: </tr>
13500: <tr>
1.249 gutterid 13501: <td>PKG_APACHE_ACCEPTED</td>
1.254 wiz 13502: <td>PKG_APACHE_DEFAULT</td>
1.156 leot 13503: </tr>
13504: <tr>
1.249 gutterid 13505: <td>PKG_BEST_EXISTS</td>
1.254 wiz 13506: <td>PKG_BUILD_OPTIONS</td>
1.156 leot 13507: </tr>
13508: <tr>
1.249 gutterid 13509: <td>PKG_COMPRESSION</td>
1.254 wiz 13510: <td>PKG_CONFIG</td>
1.156 leot 13511: </tr>
13512: <tr>
1.249 gutterid 13513: <td>PKG_CONFIG_PERMS</td>
1.254 wiz 13514: <td>PKG_CREATE_USERGROUP</td>
1.156 leot 13515: </tr>
13516: <tr>
1.255 ! wiz 13517: <td>PKG_DBDIR</td>
1.249 gutterid 13518: <td>PKG_DB_TMPDIR</td>
1.156 leot 13519: </tr>
13520: <tr>
1.255 ! wiz 13521: <td>PKG_DEBUG_LEVEL</td>
1.249 gutterid 13522: <td>PKG_DEFAULT_OPTIONS</td>
1.156 leot 13523: </tr>
13524: <tr>
1.255 ! wiz 13525: <td>PKG_DESTDIR_SUPPORT</td>
1.249 gutterid 13526: <td>PKG_DEVELOPER</td>
1.156 leot 13527: </tr>
13528: <tr>
1.255 ! wiz 13529: <td>PKG_DISABLED_OPTIONS</td>
1.249 gutterid 13530: <td>PKG_FATAL_ERRORS</td>
1.233 wiz 13531: </tr>
13532: <tr>
1.255 ! wiz 13533: <td>PKG_FC</td>
1.249 gutterid 13534: <td>PKG_FILELIST_CMD</td>
1.246 leot 13535: </tr>
13536: <tr>
1.255 ! wiz 13537: <td>PKG_GECOS</td>
1.249 gutterid 13538: <td>PKG_GID</td>
1.156 leot 13539: </tr>
13540: <tr>
1.255 ! wiz 13541: <td>PKG_GROUPS</td>
1.249 gutterid 13542: <td>PKG_GROUPS_VARS</td>
1.156 leot 13543: </tr>
13544: <tr>
1.255 ! wiz 13545: <td>PKG_HOME</td>
1.249 gutterid 13546: <td>PKG_INIT_SCRIPTS</td>
1.156 leot 13547: </tr>
13548: <tr>
1.255 ! wiz 13549: <td>PKG_JAVA_HOME</td>
1.249 gutterid 13550: <td>PKG_JVM</td>
1.156 leot 13551: </tr>
13552: <tr>
1.255 ! wiz 13553: <td>PKG_JVMS_ACCEPTED</td>
1.249 gutterid 13554: <td>PKG_JVM_DEFAULT</td>
1.156 leot 13555: </tr>
13556: <tr>
1.255 ! wiz 13557: <td>PKG_LEGACY_OPTIONS</td>
1.249 gutterid 13558: <td>PKG_LIBTOOL</td>
1.156 leot 13559: </tr>
13560: <tr>
1.255 ! wiz 13561: <td>PKG_MKSYMLINKS</td>
1.249 gutterid 13562: <td>PKG_OPTIONS</td>
1.156 leot 13563: </tr>
13564: <tr>
1.255 ! wiz 13565: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.249 gutterid 13566: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.156 leot 13567: </tr>
13568: <tr>
1.255 ! wiz 13569: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.249 gutterid 13570: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.156 leot 13571: </tr>
13572: <tr>
1.255 ! wiz 13573: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.249 gutterid 13574: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.226 gutterid 13575: </tr>
13576: <tr>
1.255 ! wiz 13577: <td>PKG_OPTIONS_VAR</td>
1.249 gutterid 13578: <td>PKG_PHP</td>
1.156 leot 13579: </tr>
13580: <tr>
1.255 ! wiz 13581: <td>PKG_PHP_MAJOR_VERS</td>
1.249 gutterid 13582: <td>PKG_PHP_VERSION</td>
1.156 leot 13583: </tr>
13584: <tr>
1.255 ! wiz 13585: <td>PKG_RCD_SCRIPTS</td>
1.249 gutterid 13586: <td>PKG_REFCOUNT_DBDIR</td>
1.156 leot 13587: </tr>
13588: <tr>
1.255 ! wiz 13589: <td>PKG_REGISTER_SHELLS</td>
1.249 gutterid 13590: <td>PKG_RESUME_TRANSFERS</td>
1.156 leot 13591: </tr>
13592: <tr>
1.255 ! wiz 13593: <td>PKG_SHELL</td>
1.249 gutterid 13594: <td>PKG_SUGGESTED_OPTIONS</td>
1.156 leot 13595: </tr>
13596: <tr>
1.255 ! wiz 13597: <td>PKG_SUPPORTED_OPTIONS</td>
1.249 gutterid 13598: <td>PKG_SYSCONFBASE</td>
1.156 leot 13599: </tr>
13600: <tr>
1.255 ! wiz 13601: <td>PKG_SYSCONFBASEDIR</td>
1.249 gutterid 13602: <td>PKG_SYSCONFDIR</td>
1.156 leot 13603: </tr>
13604: <tr>
1.255 ! wiz 13605: <td>PKG_SYSCONFDIR_PERMS</td>
1.249 gutterid 13606: <td>PKG_SYSCONFSUBDIR</td>
1.156 leot 13607: </tr>
13608: <tr>
1.255 ! wiz 13609: <td>PKG_SYSCONFVAR</td>
1.249 gutterid 13610: <td>PKG_TOOLS_BIN</td>
1.156 leot 13611: </tr>
13612: <tr>
1.255 ! wiz 13613: <td>PKG_UID</td>
1.249 gutterid 13614: <td>PKG_UPDATE_FONTS_DB</td>
1.156 leot 13615: </tr>
13616: <tr>
1.255 ! wiz 13617: <td>PKG_USERS</td>
1.249 gutterid 13618: <td>PKG_USERS_VARS</td>
1.156 leot 13619: </tr>
13620: <tr>
1.255 ! wiz 13621: <td>PKG_VERBOSE</td>
1.249 gutterid 13622: <td>PLEASE</td>
1.156 leot 13623: </tr>
13624: <tr>
1.255 ! wiz 13625: <td>PLIST</td>
1.249 gutterid 13626: <td>PLIST_AWK</td>
1.156 leot 13627: </tr>
13628: <tr>
1.255 ! wiz 13629: <td>PLIST_AWK_ENV</td>
1.249 gutterid 13630: <td>PLIST_SRC</td>
1.156 leot 13631: </tr>
13632: <tr>
1.255 ! wiz 13633: <td>PLIST_SUBST</td>
1.249 gutterid 13634: <td>PLIST_TYPE</td>
1.156 leot 13635: </tr>
13636: <tr>
1.255 ! wiz 13637: <td>PLIST_VARS</td>
1.249 gutterid 13638: <td>POPTOP_USE_MPPE</td>
1.156 leot 13639: </tr>
13640: <tr>
1.255 ! wiz 13641: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.249 gutterid 13642: <td>POST_FETCH_HOOK</td>
1.156 leot 13643: </tr>
13644: <tr>
1.255 ! wiz 13645: <td>PREFER</td>
1.249 gutterid 13646: <td>PREFER_NATIVE</td>
1.156 leot 13647: </tr>
13648: <tr>
1.255 ! wiz 13649: <td>PREFER_NATIVE_PTHREADS</td>
1.249 gutterid 13650: <td>PREFER_PKGSRC</td>
1.156 leot 13651: </tr>
13652: <tr>
1.255 ! wiz 13653: <td>PREFIX</td>
1.249 gutterid 13654: <td>PREPEND_PATH</td>
1.156 leot 13655: </tr>
13656: <tr>
1.255 ! wiz 13657: <td>PRE_ROOT_CMD</td>
1.249 gutterid 13658: <td>PRIVILEGED_STAGES</td>
1.156 leot 13659: </tr>
13660: <tr>
1.255 ! wiz 13661: <td>PS</td>
1.249 gutterid 13662: <td>PTHREAD_AUTO_VARS</td>
1.156 leot 13663: </tr>
13664: <tr>
1.255 ! wiz 13665: <td>PTHREAD_CFLAGS</td>
1.249 gutterid 13666: <td>PTHREAD_LDFLAGS</td>
1.156 leot 13667: </tr>
13668: <tr>
1.255 ! wiz 13669: <td>PTHREAD_LIBS</td>
1.249 gutterid 13670: <td>PTHREAD_OPTS</td>
1.156 leot 13671: </tr>
13672: <tr>
1.255 ! wiz 13673: <td>PTHREAD_TYPE</td>
1.249 gutterid 13674: <td>PVM_SSH</td>
1.156 leot 13675: </tr>
13676: <tr>
1.255 ! wiz 13677: <td>PYPKGPREFIX</td>
1.249 gutterid 13678: <td>PYTHON_FOR_BUILD_ONLY</td>
1.156 leot 13679: </tr>
13680: <tr>
1.255 ! wiz 13681: <td>PYTHON_SELF_CONFLICT</td>
1.249 gutterid 13682: <td>PYTHON_VERSION</td>
1.156 leot 13683: </tr>
13684: <tr>
1.255 ! wiz 13685: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.249 gutterid 13686: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156 leot 13687: </tr>
13688: <tr>
1.255 ! wiz 13689: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.249 gutterid 13690: <td>PYTHON_VERSION_DEFAULT</td>
1.156 leot 13691: </tr>
13692: <tr>
1.255 ! wiz 13693: <td>PYTHON_VERSION_REQD</td>
1.249 gutterid 13694: <td>PYVERSSUFFIX</td>
1.156 leot 13695: </tr>
13696: <tr>
1.255 ! wiz 13697: <td>QMAILDIR</td>
1.249 gutterid 13698: <td>QMAIL_ALIAS_USER</td>
1.156 leot 13699: </tr>
13700: <tr>
1.255 ! wiz 13701: <td>QMAIL_DAEMON_USER</td>
1.249 gutterid 13702: <td>QMAIL_LOG_USER</td>
1.156 leot 13703: </tr>
13704: <tr>
1.255 ! wiz 13705: <td>QMAIL_NOFILES_GROUP</td>
1.249 gutterid 13706: <td>QMAIL_PASSWD_USER</td>
1.156 leot 13707: </tr>
13708: <tr>
1.255 ! wiz 13709: <td>QMAIL_QMAIL_GROUP</td>
1.249 gutterid 13710: <td>QMAIL_QUEUE_DIR</td>
1.156 leot 13711: </tr>
13712: <tr>
1.255 ! wiz 13713: <td>QMAIL_QUEUE_EXTRA</td>
1.249 gutterid 13714: <td>QMAIL_QUEUE_USER</td>
1.156 leot 13715: </tr>
13716: <tr>
1.255 ! wiz 13717: <td>QMAIL_REMOTE_USER</td>
1.249 gutterid 13718: <td>QMAIL_ROOT_USER</td>
1.156 leot 13719: </tr>
13720: <tr>
1.255 ! wiz 13721: <td>QMAIL_SEND_USER</td>
1.249 gutterid 13722: <td>QORE_LATEST_MODULE_API</td>
1.156 leot 13723: </tr>
13724: <tr>
1.255 ! wiz 13725: <td>QORE_MODULE_API</td>
1.249 gutterid 13726: <td>QORE_MODULE_DIR</td>
1.156 leot 13727: </tr>
13728: <tr>
1.255 ! wiz 13729: <td>QORE_USER_MODULE_DIR</td>
1.249 gutterid 13730: <td>QORE_VERSION</td>
1.156 leot 13731: </tr>
13732: <tr>
1.255 ! wiz 13733: <td>QPOPPER_FAC</td>
1.249 gutterid 13734: <td>QPOPPER_SPOOL_DIR</td>
1.156 leot 13735: </tr>
13736: <tr>
1.255 ! wiz 13737: <td>QPOPPER_USER</td>
1.249 gutterid 13738: <td>RAKE_NAME</td>
1.254 wiz 13739: </tr>
13740: <tr>
1.255 ! wiz 13741: <td>RASMOL_DEPTH</td>
1.254 wiz 13742: <td>RCD_DIR</td>
1.156 leot 13743: </tr>
13744: <tr>
1.255 ! wiz 13745: <td>RCD_ORDER</td>
1.249 gutterid 13746: <td>RCD_SCRIPTS</td>
1.246 leot 13747: </tr>
13748: <tr>
1.255 ! wiz 13749: <td>RCD_SCRIPTS_DIR</td>
1.249 gutterid 13750: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.218 nia 13751: </tr>
13752: <tr>
1.255 ! wiz 13753: <td>RCD_SCRIPTS_MODE</td>
1.249 gutterid 13754: <td>RCD_SCRIPTS_SHELL</td>
1.227 wiz 13755: </tr>
13756: <tr>
1.255 ! wiz 13757: <td>RCD_SCRIPT_SRC</td>
1.254 wiz 13758: <td>RCD_SUBR</td>
1.241 rillig 13759: </tr>
13760: <tr>
1.255 ! wiz 13761: <td>RDOC</td>
1.244 gutterid 13762: <td>READLINE_DEFAULT</td>
1.214 leot 13763: </tr>
13764: <tr>
1.255 ! wiz 13765: <td>READLINE_TYPE</td>
1.244 gutterid 13766: <td>REAL_ROOT_GROUP</td>
1.205 wiz 13767: </tr>
13768: <tr>
1.255 ! wiz 13769: <td>REAL_ROOT_USER</td>
1.244 gutterid 13770: <td>RECURSIVE_MAKE</td>
1.223 nia 13771: </tr>
13772: <tr>
1.255 ! wiz 13773: <td>RELAY_CTRL_DIR</td>
1.244 gutterid 13774: <td>RELRO_SUPPORTED</td>
1.177 leot 13775: </tr>
13776: <tr>
1.255 ! wiz 13777: <td>REPLACE_AWK</td>
1.244 gutterid 13778: <td>REPLACE_BASH</td>
1.214 leot 13779: </tr>
13780: <tr>
1.255 ! wiz 13781: <td>REPLACE_CSH</td>
1.244 gutterid 13782: <td>REPLACE_KSH</td>
1.212 wiz 13783: </tr>
13784: <tr>
1.255 ! wiz 13785: <td>REPLACE_LUA</td>
1.244 gutterid 13786: <td>REPLACE_NODEJS</td>
1.156 leot 13787: </tr>
13788: <tr>
1.255 ! wiz 13789: <td>REPLACE_OCTAVE</td>
1.244 gutterid 13790: <td>REPLACE_PERL</td>
1.205 wiz 13791: </tr>
13792: <tr>
1.255 ! wiz 13793: <td>REPLACE_PERL6</td>
1.244 gutterid 13794: <td>REPLACE_PHP</td>
1.197 leot 13795: </tr>
13796: <tr>
1.255 ! wiz 13797: <td>REPLACE_PYTHON</td>
1.244 gutterid 13798: <td>REPLACE_QORE</td>
1.156 leot 13799: </tr>
13800: <tr>
1.255 ! wiz 13801: <td>REPLACE_R</td>
1.244 gutterid 13802: <td>REPLACE_RUBY</td>
1.218 nia 13803: </tr>
13804: <tr>
1.255 ! wiz 13805: <td>REPLACE_RUBY_DIRS</td>
1.244 gutterid 13806: <td>REPLACE_RUBY_PAT</td>
1.161 leot 13807: </tr>
13808: <tr>
1.255 ! wiz 13809: <td>REPLACE_SH</td>
1.244 gutterid 13810: <td>REPLACE_TEXLUA</td>
1.254 wiz 13811: </tr>
13812: <tr>
1.255 ! wiz 13813: <td>REPLACE_TOOL_PYTHON</td>
1.241 rillig 13814: <td>REPLACE_WISH</td>
1.216 gutterid 13815: </tr>
13816: <tr>
1.255 ! wiz 13817: <td>REQD_DIRS</td>
1.241 rillig 13818: <td>REQD_DIRS_PERMS</td>
1.156 leot 13819: </tr>
13820: <tr>
1.255 ! wiz 13821: <td>REQD_FILES</td>
1.241 rillig 13822: <td>REQD_FILES_MODE</td>
1.218 nia 13823: </tr>
13824: <tr>
1.255 ! wiz 13825: <td>REQD_FILES_PERMS</td>
1.241 rillig 13826: <td>RESOLV_AUTO_VARS</td>
1.156 leot 13827: </tr>
13828: <tr>
1.255 ! wiz 13829: <td>RESOLV_LDFLAGS</td>
1.241 rillig 13830: <td>RESOLV_LIBS</td>
1.254 wiz 13831: </tr>
13832: <tr>
1.255 ! wiz 13833: <td>RM</td>
1.254 wiz 13834: <td>ROCKSPEC_NAME</td>
1.238 wiz 13835: </tr>
13836: <tr>
1.255 ! wiz 13837: <td>ROCKSPEC_SPECFILE</td>
1.232 gutterid 13838: <td>ROOT_CMD</td>
1.241 rillig 13839: </tr>
13840: <tr>
1.255 ! wiz 13841: <td>ROOT_GROUP</td>
1.241 rillig 13842: <td>ROOT_USER</td>
1.156 leot 13843: </tr>
13844: <tr>
1.255 ! wiz 13845: <td>RPCGEN</td>
1.241 rillig 13846: <td>RPM</td>
1.156 leot 13847: </tr>
13848: <tr>
1.255 ! wiz 13849: <td>RPM2PKG_PLIST</td>
1.241 rillig 13850: <td>RPM2PKG_PREFIX</td>
1.205 wiz 13851: </tr>
13852: <tr>
1.255 ! wiz 13853: <td>RPM2PKG_STAGE</td>
1.241 rillig 13854: <td>RPM2PKG_STRIP</td>
1.217 rillig 13855: </tr>
13856: <tr>
1.255 ! wiz 13857: <td>RPM2PKG_SUBPREFIX</td>
1.241 rillig 13858: <td>RPMFILES</td>
1.214 leot 13859: </tr>
13860: <tr>
1.255 ! wiz 13861: <td>RPMIGNOREPATH</td>
1.241 rillig 13862: <td>RPM_DB_PREFIX</td>
1.212 wiz 13863: </tr>
13864: <tr>
1.255 ! wiz 13865: <td>RSSH_CVS_PATH</td>
1.241 rillig 13866: <td>RSSH_RDIST_PATH</td>
1.156 leot 13867: </tr>
13868: <tr>
1.255 ! wiz 13869: <td>RSSH_RSYNC_PATH</td>
1.241 rillig 13870: <td>RSSH_SCP_PATH</td>
1.197 leot 13871: </tr>
13872: <tr>
1.255 ! wiz 13873: <td>RSSH_SFTP_SERVER_PATH</td>
1.241 rillig 13874: <td>RUBY</td>
1.156 leot 13875: </tr>
13876: <tr>
1.255 ! wiz 13877: <td>RUBYGEM</td>
1.241 rillig 13878: <td>RUBYGEM_MANPAGES</td>
1.156 leot 13879: </tr>
13880: <tr>
1.255 ! wiz 13881: <td>RUBYGEM_NAME</td>
1.241 rillig 13882: <td>RUBYGEM_OPTIONS</td>
1.156 leot 13883: </tr>
13884: <tr>
1.255 ! wiz 13885: <td>RUBYGEM_USE_MANPAGES</td>
1.241 rillig 13886: <td>RUBYGEM_VERBOSE</td>
1.231 jnemeth 13887: </tr>
13888: <tr>
1.255 ! wiz 13889: <td>RUBY_ABI_VERSION</td>
1.241 rillig 13890: <td>RUBY_ARCH</td>
1.156 leot 13891: </tr>
13892: <tr>
1.255 ! wiz 13893: <td>RUBY_ARCHINC</td>
1.241 rillig 13894: <td>RUBY_ARCHLIB</td>
1.156 leot 13895: </tr>
13896: <tr>
1.255 ! wiz 13897: <td>RUBY_BASE</td>
1.241 rillig 13898: <td>RUBY_BASERIDIR</td>
1.156 leot 13899: </tr>
13900: <tr>
1.255 ! wiz 13901: <td>RUBY_BUILD_DOCUMENT</td>
1.241 rillig 13902: <td>RUBY_DLEXT</td>
1.156 leot 13903: </tr>
13904: <tr>
1.255 ! wiz 13905: <td>RUBY_DOC</td>
1.241 rillig 13906: <td>RUBY_DYNAMIC_DIRS</td>
1.156 leot 13907: </tr>
13908: <tr>
1.255 ! wiz 13909: <td>RUBY_EG</td>
1.241 rillig 13910: <td>RUBY_ENCODING_ARG</td>
1.156 leot 13911: </tr>
13912: <tr>
1.255 ! wiz 13913: <td>RUBY_EXTCONF</td>
1.241 rillig 13914: <td>RUBY_EXTCONF_CHECK</td>
1.156 leot 13915: </tr>
13916: <tr>
1.255 ! wiz 13917: <td>RUBY_EXTCONF_DEBUG</td>
1.241 rillig 13918: <td>RUBY_EXTCONF_MAKEFILE</td>
1.198 leot 13919: </tr>
13920: <tr>
1.255 ! wiz 13921: <td>RUBY_GEM_ARCH</td>
1.241 rillig 13922: <td>RUBY_GEM_BASE</td>
1.156 leot 13923: </tr>
13924: <tr>
1.255 ! wiz 13925: <td>RUBY_INC</td>
1.241 rillig 13926: <td>RUBY_LIB</td>
1.156 leot 13927: </tr>
13928: <tr>
1.255 ! wiz 13929: <td>RUBY_LIB_BASE</td>
1.241 rillig 13930: <td>RUBY_NAME</td>
1.156 leot 13931: </tr>
13932: <tr>
1.255 ! wiz 13933: <td>RUBY_NOVERSION</td>
1.241 rillig 13934: <td>RUBY_PKGPREFIX</td>
1.156 leot 13935: </tr>
13936: <tr>
1.255 ! wiz 13937: <td>RUBY_RAILS</td>
1.244 gutterid 13938: <td>RUBY_RAILS61_VERSION</td>
1.223 nia 13939: </tr>
13940: <tr>
1.255 ! wiz 13941: <td>RUBY_RAILS70_VERSION</td>
1.251 gutterid 13942: <td>RUBY_RAILS71_VERSION</td>
1.156 leot 13943: </tr>
13944: <tr>
1.255 ! wiz 13945: <td>RUBY_RAILS_ACCEPTED</td>
1.242 gutterid 13946: <td>RUBY_RAILS_DEFAULT</td>
1.156 leot 13947: </tr>
13948: <tr>
1.255 ! wiz 13949: <td>RUBY_RAILS_REQD</td>
1.242 gutterid 13950: <td>RUBY_RAILS_STRICT_DEP</td>
1.156 leot 13951: </tr>
13952: <tr>
1.255 ! wiz 13953: <td>RUBY_RIDIR</td>
1.242 gutterid 13954: <td>RUBY_SETUP</td>
1.156 leot 13955: </tr>
13956: <tr>
1.255 ! wiz 13957: <td>RUBY_SHLIB</td>
1.242 gutterid 13958: <td>RUBY_SHLIBALIAS</td>
1.156 leot 13959: </tr>
13960: <tr>
1.255 ! wiz 13961: <td>RUBY_SHLIBVER</td>
1.242 gutterid 13962: <td>RUBY_SIMPLE_INSTALL</td>
1.156 leot 13963: </tr>
13964: <tr>
1.255 ! wiz 13965: <td>RUBY_SITEARCHLIB</td>
1.242 gutterid 13966: <td>RUBY_SITELIB</td>
1.156 leot 13967: </tr>
13968: <tr>
1.255 ! wiz 13969: <td>RUBY_SITELIB_BASE</td>
1.242 gutterid 13970: <td>RUBY_SITERIDIR</td>
1.156 leot 13971: </tr>
13972: <tr>
1.255 ! wiz 13973: <td>RUBY_SLEXT</td>
1.242 gutterid 13974: <td>RUBY_SRCDIR</td>
1.156 leot 13975: </tr>
13976: <tr>
1.255 ! wiz 13977: <td>RUBY_STATICLIB</td>
1.242 gutterid 13978: <td>RUBY_SUFFIX</td>
1.174 leot 13979: </tr>
13980: <tr>
1.255 ! wiz 13981: <td>RUBY_SYSRIDIR</td>
1.242 gutterid 13982: <td>RUBY_USE_PTHREAD</td>
1.156 leot 13983: </tr>
13984: <tr>
1.255 ! wiz 13985: <td>RUBY_VENDORARCHLIB</td>
1.242 gutterid 13986: <td>RUBY_VENDORLIB</td>
1.156 leot 13987: </tr>
13988: <tr>
1.255 ! wiz 13989: <td>RUBY_VENDORLIB_BASE</td>
1.242 gutterid 13990: <td>RUBY_VER</td>
1.156 leot 13991: </tr>
13992: <tr>
1.255 ! wiz 13993: <td>RUBY_VERSION</td>
1.242 gutterid 13994: <td>RUBY_VERSIONS_ACCEPTED</td>
1.156 leot 13995: </tr>
13996: <tr>
1.255 ! wiz 13997: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.242 gutterid 13998: <td>RUBY_VERSION_DEFAULT</td>
1.156 leot 13999: </tr>
14000: <tr>
1.255 ! wiz 14001: <td>RUBY_VERSION_REQD</td>
1.242 gutterid 14002: <td>RUBY_VER_DIR</td>
1.156 leot 14003: </tr>
14004: <tr>
1.255 ! wiz 14005: <td>RUN</td>
1.242 gutterid 14006: <td>RUN_LDCONFIG</td>
1.156 leot 14007: </tr>
14008: <tr>
1.255 ! wiz 14009: <td>RUST_TYPE</td>
1.242 gutterid 14010: <td>SCO</td>
1.156 leot 14011: </tr>
14012: <tr>
1.255 ! wiz 14013: <td>SCREWS_GROUP</td>
1.242 gutterid 14014: <td>SCREWS_USER</td>
1.156 leot 14015: </tr>
14016: <tr>
1.255 ! wiz 14017: <td>SCRIPTS_ENV</td>
1.242 gutterid 14018: <td>SCROLLKEEPER_DATADIR</td>
1.156 leot 14019: </tr>
14020: <tr>
1.255 ! wiz 14021: <td>SCROLLKEEPER_REBUILDDB</td>
1.242 gutterid 14022: <td>SCROLLKEEPER_UPDATEDB</td>
1.156 leot 14023: </tr>
14024: <tr>
1.255 ! wiz 14025: <td>SDIST_PAWD</td>
1.242 gutterid 14026: <td>SDL12_TYPE</td>
1.156 leot 14027: </tr>
14028: <tr>
1.255 ! wiz 14029: <td>SERIAL_DEVICES</td>
1.242 gutterid 14030: <td>SETGIDGAME</td>
1.156 leot 14031: </tr>
14032: <tr>
1.255 ! wiz 14033: <td>SETGID_GAMES_PERMS</td>
1.242 gutterid 14034: <td>SETUID_ROOT_PERMS</td>
1.156 leot 14035: </tr>
14036: <tr>
1.255 ! wiz 14037: <td>SH</td>
1.238 wiz 14038: <td>SHLIB</td>
1.246 leot 14039: </tr>
14040: <tr>
1.255 ! wiz 14041: <td>SHORTNAME</td>
1.251 gutterid 14042: <td>SIGN_PACKAGES</td>
1.233 wiz 14043: </tr>
14044: <tr>
1.255 ! wiz 14045: <td>SILC_CLIENT_WITH_PERL</td>
1.251 gutterid 14046: <td>SITE_SPECIFIC_PKGS</td>
1.156 leot 14047: </tr>
14048: <tr>
1.255 ! wiz 14049: <td>SKIP_DEPENDS</td>
1.251 gutterid 14050: <td>SMF_INSTANCES</td>
1.227 wiz 14051: </tr>
14052: <tr>
1.255 ! wiz 14053: <td>SMF_MANIFEST</td>
1.251 gutterid 14054: <td>SMF_METHODS</td>
1.156 leot 14055: </tr>
14056: <tr>
1.255 ! wiz 14057: <td>SMF_METHOD_SHELL</td>
1.251 gutterid 14058: <td>SMF_METHOD_SRC</td>
1.156 leot 14059: </tr>
14060: <tr>
1.255 ! wiz 14061: <td>SMF_NAME</td>
1.251 gutterid 14062: <td>SMF_PREFIX</td>
1.177 leot 14063: </tr>
14064: <tr>
1.255 ! wiz 14065: <td>SMF_SRCDIR</td>
1.251 gutterid 14066: <td>SNIPROXY_GROUP</td>
1.156 leot 14067: </tr>
14068: <tr>
1.255 ! wiz 14069: <td>SNIPROXY_USER</td>
1.251 gutterid 14070: <td>SOURCE_BUFFSIZE</td>
1.217 rillig 14071: </tr>
14072: <tr>
1.255 ! wiz 14073: <td>SPECIAL_PERMS</td>
1.251 gutterid 14074: <td>SPECIFIC_PKGS</td>
1.156 leot 14075: </tr>
14076: <tr>
1.255 ! wiz 14077: <td>SSH_SUID</td>
1.251 gutterid 14078: <td>SSP_SUPPORTED</td>
1.159 rillig 14079: </tr>
14080: <tr>
1.255 ! wiz 14081: <td>SSYNC_PAWD</td>
1.251 gutterid 14082: <td>STEP_MSG</td>
1.156 leot 14083: </tr>
14084: <tr>
1.255 ! wiz 14085: <td>STRIP</td>
1.251 gutterid 14086: <td>STRIP_DBG</td>
1.156 leot 14087: </tr>
14088: <tr>
1.255 ! wiz 14089: <td>STRIP_DEBUG</td>
1.251 gutterid 14090: <td>STRIP_DEBUG_SUPPORTED</td>
1.156 leot 14091: </tr>
14092: <tr>
1.255 ! wiz 14093: <td>STRIP_FILES_SKIP</td>
1.251 gutterid 14094: <td>SU</td>
1.156 leot 14095: </tr>
14096: <tr>
1.255 ! wiz 14097: <td>SUBDIR</td>
1.251 gutterid 14098: <td>SUBST</td>
1.156 leot 14099: </tr>
14100: <tr>
1.255 ! wiz 14101: <td>SUBST_CLASSES</td>
1.251 gutterid 14102: <td>SUBST_FILES</td>
1.156 leot 14103: </tr>
14104: <tr>
1.255 ! wiz 14105: <td>SUBST_FILTER_CMD</td>
1.251 gutterid 14106: <td>SUBST_MESSAGE</td>
1.156 leot 14107: </tr>
14108: <tr>
1.255 ! wiz 14109: <td>SUBST_NOOP_OK</td>
1.251 gutterid 14110: <td>SUBST_SED</td>
1.156 leot 14111: </tr>
14112: <tr>
1.255 ! wiz 14113: <td>SUBST_SHOW_DIFF</td>
1.251 gutterid 14114: <td>SUBST_SKIP_TEXT_CHECK</td>
1.156 leot 14115: </tr>
14116: <tr>
1.255 ! wiz 14117: <td>SUBST_STAGE</td>
1.251 gutterid 14118: <td>SUBST_VARS</td>
1.156 leot 14119: </tr>
14120: <tr>
1.255 ! wiz 14121: <td>SUNWSPROBASE</td>
1.251 gutterid 14122: <td>SUSE_PREFER</td>
1.246 leot 14123: </tr>
14124: <tr>
1.255 ! wiz 14125: <td>SU_CMD</td>
1.254 wiz 14126: <td>SVN_EXTRACTDIR</td>
14127: </tr>
14128: <tr>
1.255 ! wiz 14129: <td>SVN_REPO</td>
1.254 wiz 14130: <td>SVN_REPOSITORIES</td>
14131: </tr>
14132: <tr>
1.255 ! wiz 14133: <td>SVN_REVISION</td>
1.251 gutterid 14134: <td>SYSCONFBASE</td>
1.238 wiz 14135: </tr>
14136: <tr>
1.255 ! wiz 14137: <td>TARGET_MACHINE_ARCH</td>
1.251 gutterid 14138: <td>TBL</td>
1.255 ! wiz 14139: </tr>
! 14140: <tr>
1.246 leot 14141: <td>TERMCAP_TYPE</td>
1.255 ! wiz 14142: <td>TERMINFO_DEFAULT</td>
1.156 leot 14143: </tr>
14144: <tr>
1.246 leot 14145: <td>TERMINFO_TYPE</td>
1.255 ! wiz 14146: <td>TEST</td>
1.227 wiz 14147: </tr>
14148: <tr>
1.246 leot 14149: <td>TEST_DEPENDS</td>
1.255 ! wiz 14150: <td>TEST_DIRS</td>
1.156 leot 14151: </tr>
14152: <tr>
1.246 leot 14153: <td>TEST_ENV</td>
1.255 ! wiz 14154: <td>TEST_ENV_SHELL</td>
1.217 rillig 14155: </tr>
14156: <tr>
1.246 leot 14157: <td>TEST_MAKE_CMD</td>
1.255 ! wiz 14158: <td>TEST_MAKE_FLAGS</td>
1.212 wiz 14159: </tr>
14160: <tr>
1.246 leot 14161: <td>TEST_TARGET</td>
1.255 ! wiz 14162: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.217 rillig 14163: </tr>
14164: <tr>
1.246 leot 14165: <td>TEXLIVE_REV</td>
1.255 ! wiz 14166: <td>TEXLIVE_UNVERSIONED</td>
1.205 wiz 14167: </tr>
14168: <tr>
1.246 leot 14169: <td>TEXMFSITE</td>
1.255 ! wiz 14170: <td>TEX_FORMATS</td>
1.189 bacon 14171: </tr>
14172: <tr>
1.246 leot 14173: <td>TEX_HYPHEN_DAT</td>
1.255 ! wiz 14174: <td>TEX_HYPHEN_DEF</td>
1.161 leot 14175: </tr>
14176: <tr>
1.246 leot 14177: <td>TEX_TEXMF_DIRS</td>
1.255 ! wiz 14178: <td>THTTPD_LOG_FACILITY</td>
1.159 rillig 14179: </tr>
14180: <tr>
1.246 leot 14181: <td>TINYDYN_USER</td>
1.255 ! wiz 14182: <td>TLSWRAPPER_CHROOT</td>
1.156 leot 14183: </tr>
14184: <tr>
1.246 leot 14185: <td>TO</td>
1.255 ! wiz 14186: <td>TOOLDIR</td>
1.156 leot 14187: </tr>
14188: <tr>
1.251 gutterid 14189: <td>TOOLS_ALIASES</td>
1.246 leot 14190: <td>TOOLS_ALWAYS_WRAP</td>
1.156 leot 14191: </tr>
14192: <tr>
1.251 gutterid 14193: <td>TOOLS_ARGS</td>
1.246 leot 14194: <td>TOOLS_BROKEN</td>
1.156 leot 14195: </tr>
14196: <tr>
1.251 gutterid 14197: <td>TOOLS_CMD</td>
1.246 leot 14198: <td>TOOLS_CMDLINE_SED</td>
1.156 leot 14199: </tr>
14200: <tr>
1.251 gutterid 14201: <td>TOOLS_CREATE</td>
1.246 leot 14202: <td>TOOLS_CROSS_DESTDIR</td>
1.156 leot 14203: </tr>
14204: <tr>
1.251 gutterid 14205: <td>TOOLS_DIR</td>
1.246 leot 14206: <td>TOOLS_FAIL</td>
1.156 leot 14207: </tr>
14208: <tr>
1.251 gutterid 14209: <td>TOOLS_GNU_MISSING</td>
1.246 leot 14210: <td>TOOLS_LDCONFIG</td>
1.156 leot 14211: </tr>
14212: <tr>
1.251 gutterid 14213: <td>TOOLS_NOOP</td>
1.246 leot 14214: <td>TOOLS_PATH</td>
1.156 leot 14215: </tr>
14216: <tr>
1.251 gutterid 14217: <td>TOOLS_SCRIPT</td>
1.246 leot 14218: <td>TOOLS_USE_CROSS_COMPILE</td>
1.156 leot 14219: </tr>
14220: <tr>
1.251 gutterid 14221: <td>TOOL_DEPENDS</td>
1.254 wiz 14222: <td>TTF_FONTDIR</td>
14223: </tr>
14224: <tr>
1.242 gutterid 14225: <td>TTF_FONTS_DIR</td>
1.254 wiz 14226: <td>TYPE</td>
1.241 rillig 14227: </tr>
14228: <tr>
1.242 gutterid 14229: <td>UAC_REQD_EXECS</td>
1.254 wiz 14230: <td>UCSPI_SSL_GROUP</td>
1.238 wiz 14231: </tr>
14232: <tr>
1.242 gutterid 14233: <td>UCSPI_SSL_USER</td>
1.254 wiz 14234: <td>UNLIMIT_RESOURCES</td>
1.156 leot 14235: </tr>
14236: <tr>
1.242 gutterid 14237: <td>UNPRIVILEGED</td>
1.254 wiz 14238: <td>UNPRIVILEGED_GROUP</td>
1.223 nia 14239: </tr>
14240: <tr>
1.242 gutterid 14241: <td>UNPRIVILEGED_GROUPS</td>
1.254 wiz 14242: <td>UNPRIVILEGED_USER</td>
1.156 leot 14243: </tr>
14244: <tr>
1.242 gutterid 14245: <td>UNWRAP_FILES</td>
1.254 wiz 14246: <td>UNWRAP_PATTERNS</td>
1.212 wiz 14247: </tr>
14248: <tr>
1.242 gutterid 14249: <td>UPDATE_GEMSPEC</td>
1.254 wiz 14250: <td>UPDATE_TARGET</td>
1.156 leot 14251: </tr>
14252: <tr>
1.242 gutterid 14253: <td>URI</td>
1.254 wiz 14254: <td>USERGROUP_PHASE</td>
1.156 leot 14255: </tr>
14256: <tr>
1.242 gutterid 14257: <td>USERPPP_GROUP</td>
1.254 wiz 14258: <td>USER_SPECIFIC_PKGS</td>
1.156 leot 14259: </tr>
14260: <tr>
1.242 gutterid 14261: <td>USE_ABI_DEPENDS</td>
1.254 wiz 14262: <td>USE_APR</td>
1.156 leot 14263: </tr>
14264: <tr>
1.242 gutterid 14265: <td>USE_BSD_MAKEFILE</td>
1.254 wiz 14266: <td>USE_BUILTIN</td>
1.156 leot 14267: </tr>
14268: <tr>
1.243 gutterid 14269: <td>USE_CC_FEATURES</td>
1.254 wiz 14270: <td>USE_CROSS_COMPILE</td>
1.243 gutterid 14271: </tr>
14272: <tr>
14273: <td>USE_CURSES</td>
1.254 wiz 14274: <td>USE_CWRAPPERS</td>
1.156 leot 14275: </tr>
14276: <tr>
1.243 gutterid 14277: <td>USE_CXX_FEATURES</td>
1.254 wiz 14278: <td>USE_DB185</td>
1.156 leot 14279: </tr>
14280: <tr>
1.242 gutterid 14281: <td>USE_FEATURES</td>
1.254 wiz 14282: <td>USE_GAMESGROUP</td>
1.156 leot 14283: </tr>
14284: <tr>
1.242 gutterid 14285: <td>USE_GCC_RUNTIME</td>
1.254 wiz 14286: <td>USE_IMAKE</td>
1.156 leot 14287: </tr>
14288: <tr>
1.242 gutterid 14289: <td>USE_JAVA</td>
1.254 wiz 14290: <td>USE_JAVA2</td>
1.205 wiz 14291: </tr>
14292: <tr>
1.242 gutterid 14293: <td>USE_LANGUAGES</td>
1.254 wiz 14294: <td>USE_LIBTOOL</td>
1.156 leot 14295: </tr>
14296: <tr>
1.242 gutterid 14297: <td>USE_NATIVE_GCC</td>
1.254 wiz 14298: <td>USE_NETBSD_REPO</td>
1.156 leot 14299: </tr>
14300: <tr>
1.242 gutterid 14301: <td>USE_PKGSRC_GCC</td>
1.254 wiz 14302: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.156 leot 14303: </tr>
14304: <tr>
1.242 gutterid 14305: <td>USE_PKGTASKS</td>
1.254 wiz 14306: <td>USE_PKG_ADMIN_DIGEST</td>
1.156 leot 14307: </tr>
14308: <tr>
1.242 gutterid 14309: <td>USE_RUBY_EXTCONF</td>
1.254 wiz 14310: <td>USE_RUBY_INSTALL</td>
1.156 leot 14311: </tr>
14312: <tr>
1.242 gutterid 14313: <td>USE_RUBY_SETUP</td>
1.254 wiz 14314: <td>USE_RUBY_SETUP_PKG</td>
1.156 leot 14315: </tr>
14316: <tr>
1.242 gutterid 14317: <td>USE_TOOLS</td>
1.254 wiz 14318: <td>UUCP_GROUP</td>
1.156 leot 14319: </tr>
14320: <tr>
1.242 gutterid 14321: <td>UUCP_USER</td>
1.254 wiz 14322: <td>VARBASE</td>
1.156 leot 14323: </tr>
14324: <tr>
1.242 gutterid 14325: <td>VARNAME</td>
1.254 wiz 14326: <td>VIM_EXTRA_OPTS</td>
1.156 leot 14327: </tr>
14328: <tr>
1.242 gutterid 14329: <td>WARNING_MSG</td>
1.254 wiz 14330: <td>WCALC_CGIDIR</td>
1.156 leot 14331: </tr>
14332: <tr>
1.242 gutterid 14333: <td>WCALC_CGIPATH</td>
1.254 wiz 14334: <td>WCALC_HTMLDIR</td>
1.156 leot 14335: </tr>
14336: <tr>
1.242 gutterid 14337: <td>WCALC_HTMLPATH</td>
1.254 wiz 14338: <td>WDM_MANAGERS</td>
1.156 leot 14339: </tr>
14340: <tr>
1.242 gutterid 14341: <td>WRAPPER_CC</td>
1.254 wiz 14342: <td>WRAPPER_REORDER_CMDS</td>
1.156 leot 14343: </tr>
14344: <tr>
1.242 gutterid 14345: <td>WRKDIR</td>
1.254 wiz 14346: <td>WRKDIR_BASENAME</td>
1.156 leot 14347: </tr>
14348: <tr>
1.242 gutterid 14349: <td>WRKDIR_LOCKTYPE</td>
1.254 wiz 14350: <td>WRKLOG</td>
1.156 leot 14351: </tr>
14352: <tr>
1.242 gutterid 14353: <td>WRKOBJDIR</td>
1.254 wiz 14354: <td>WRKSRC</td>
1.156 leot 14355: </tr>
14356: <tr>
1.242 gutterid 14357: <td>X10_PORT</td>
1.254 wiz 14358: <td>X11</td>
1.156 leot 14359: </tr>
14360: <tr>
1.242 gutterid 14361: <td>X11BASE</td>
1.254 wiz 14362: <td>X11_PKGSRCDIR</td>
1.156 leot 14363: </tr>
14364: <tr>
1.242 gutterid 14365: <td>X11_TYPE</td>
1.254 wiz 14366: <td>X509_CERTIFICATE</td>
1.156 leot 14367: </tr>
14368: <tr>
1.242 gutterid 14369: <td>X509_KEY</td>
1.254 wiz 14370: <td>XAW_TYPE</td>
1.189 bacon 14371: </tr>
14372: <tr>
1.242 gutterid 14373: <td>XLOCK_DEFAULT_MODE</td>
1.254 wiz 14374: <td>XMKMF</td>
1.156 leot 14375: </tr>
14376: <tr>
1.242 gutterid 14377: <td>XMKMF_FLAGS</td>
1.254 wiz 14378: <td>XXX</td>
1.156 leot 14379: </tr>
14380: <tr>
1.254 wiz 14381: <td>XXXX</td>
1.239 dholland 14382: <td>YES</td>
1.246 leot 14383: </tr>
14384: <tr>
1.251 gutterid 14385: <td>ZSH_STATIC</td>
1.246 leot 14386: <td>__stdc__</td>
1.233 wiz 14387: </tr>
14388: <tr>
1.251 gutterid 14389: <td>_vargroups</td>
1.246 leot 14390: <td>accept</td>
1.156 leot 14391: </tr>
14392: <tr>
1.251 gutterid 14393: <td>acquire-localbase-lock</td>
1.246 leot 14394: <td>acquire-lock</td>
1.227 wiz 14395: </tr>
14396: <tr>
1.251 gutterid 14397: <td>add</td>
1.246 leot 14398: <td>added</td>
1.156 leot 14399: </tr>
14400: <tr>
1.251 gutterid 14401: <td>administrator</td>
1.246 leot 14402: <td>alloca</td>
1.159 rillig 14403: </tr>
14404: <tr>
1.251 gutterid 14405: <td>alternatives</td>
1.246 leot 14406: <td>aslr</td>
1.217 rillig 14407: </tr>
14408: <tr>
1.251 gutterid 14409: <td>asprintf</td>
1.246 leot 14410: <td>atlas</td>
1.156 leot 14411: </tr>
14412: <tr>
1.251 gutterid 14413: <td>autoconf</td>
1.246 leot 14414: <td>automake</td>
1.201 cirnatda 14415: </tr>
14416: <tr>
1.251 gutterid 14417: <td>autoreconf</td>
1.246 leot 14418: <td>awk</td>
1.174 leot 14419: </tr>
14420: <tr>
1.251 gutterid 14421: <td>bash</td>
1.246 leot 14422: <td>big-endian</td>
1.156 leot 14423: </tr>
14424: <tr>
1.251 gutterid 14425: <td>bin-install</td>
1.246 leot 14426: <td>bind</td>
1.156 leot 14427: </tr>
14428: <tr>
1.251 gutterid 14429: <td>binpkg-list</td>
1.246 leot 14430: <td>blas</td>
1.174 leot 14431: </tr>
14432: <tr>
1.251 gutterid 14433: <td>bootstrap-depends</td>
1.246 leot 14434: <td>broken</td>
1.156 leot 14435: </tr>
14436: <tr>
1.251 gutterid 14437: <td>broken_on_platform</td>
1.246 leot 14438: <td>bsd</td>
1.161 leot 14439: </tr>
14440: <tr>
1.251 gutterid 14441: <td>bsd.prog.mk</td>
1.246 leot 14442: <td>build</td>
1.156 leot 14443: </tr>
14444: <tr>
1.251 gutterid 14445: <td>build-env</td>
1.246 leot 14446: <td>buildlink-directories</td>
1.156 leot 14447: </tr>
14448: <tr>
1.251 gutterid 14449: <td>buildlink-oss-soundcard-h</td>
1.246 leot 14450: <td>built-in</td>
1.156 leot 14451: </tr>
14452: <tr>
1.251 gutterid 14453: <td>builtin</td>
1.246 leot 14454: <td>c</td>
1.242 gutterid 14455: </tr>
14456: <tr>
1.251 gutterid 14457: <td>c++</td>
1.246 leot 14458: <td>ccache</td>
1.177 leot 14459: </tr>
14460: <tr>
1.251 gutterid 14461: <td>cce</td>
1.246 leot 14462: <td>cdefs</td>
1.159 rillig 14463: </tr>
14464: <tr>
1.251 gutterid 14465: <td>ceil</td>
1.246 leot 14466: <td>changes</td>
1.156 leot 14467: </tr>
14468: <tr>
1.251 gutterid 14469: <td>changes-entry</td>
1.246 leot 14470: <td>changes-entry-noupdate</td>
1.174 leot 14471: </tr>
14472: <tr>
1.251 gutterid 14473: <td>check</td>
1.246 leot 14474: <td>check-clean</td>
1.156 leot 14475: </tr>
14476: <tr>
1.251 gutterid 14477: <td>check-files</td>
1.246 leot 14478: <td>check-files-clean</td>
1.156 leot 14479: </tr>
14480: <tr>
1.255 ! wiz 14481: <td>check-hackage</td>
1.251 gutterid 14482: <td>check-vulnerable</td>
1.255 ! wiz 14483: </tr>
! 14484: <tr>
1.246 leot 14485: <td>checksum</td>
1.255 ! wiz 14486: <td>checksum-phase</td>
1.156 leot 14487: </tr>
14488: <tr>
1.246 leot 14489: <td>clean</td>
1.255 ! wiz 14490: <td>clean-depends</td>
1.156 leot 14491: </tr>
14492: <tr>
1.246 leot 14493: <td>cleandir</td>
1.255 ! wiz 14494: <td>commit</td>
1.174 leot 14495: </tr>
14496: <tr>
1.246 leot 14497: <td>commit-changes-entry</td>
1.255 ! wiz 14498: <td>compact</td>
1.156 leot 14499: </tr>
14500: <tr>
1.246 leot 14501: <td>compiler</td>
1.255 ! wiz 14502: <td>conf</td>
1.156 leot 14503: </tr>
14504: <tr>
1.246 leot 14505: <td>config.guess</td>
1.255 ! wiz 14506: <td>config.sub</td>
1.156 leot 14507: </tr>
14508: <tr>
1.246 leot 14509: <td>configuration</td>
1.255 ! wiz 14510: <td>configure</td>
1.156 leot 14511: </tr>
14512: <tr>
1.246 leot 14513: <td>configure-env</td>
1.255 ! wiz 14514: <td>configure-help</td>
1.156 leot 14515: </tr>
14516: <tr>
1.246 leot 14517: <td>configure_args</td>
1.255 ! wiz 14518: <td>connect</td>
1.156 leot 14519: </tr>
14520: <tr>
1.246 leot 14521: <td>cos</td>
1.255 ! wiz 14522: <td>cpe</td>
1.156 leot 14523: </tr>
14524: <tr>
1.246 leot 14525: <td>cputime</td>
1.255 ! wiz 14526: <td>create-usergroup</td>
1.156 leot 14527: </tr>
14528: <tr>
1.246 leot 14529: <td>csh</td>
1.255 ! wiz 14530: <td>ctf</td>
1.156 leot 14531: </tr>
14532: <tr>
1.254 wiz 14533: <td>cvs</td>
1.255 ! wiz 14534: <td>debug</td>
1.254 wiz 14535: </tr>
14536: <tr>
14537: <td>declaration</td>
1.255 ! wiz 14538: <td>declare</td>
1.241 rillig 14539: </tr>
14540: <tr>
1.254 wiz 14541: <td>defined</td>
1.255 ! wiz 14542: <td>depend</td>
1.238 wiz 14543: </tr>
14544: <tr>
1.254 wiz 14545: <td>dependencies</td>
1.255 ! wiz 14546: <td>depends</td>
1.223 nia 14547: </tr>
14548: <tr>
1.254 wiz 14549: <td>depends-checksum</td>
1.255 ! wiz 14550: <td>depends-fetch</td>
1.174 leot 14551: </tr>
14552: <tr>
1.254 wiz 14553: <td>deps</td>
1.255 ! wiz 14554: <td>describe</td>
1.214 leot 14555: </tr>
14556: <tr>
1.254 wiz 14557: <td>destdir</td>
1.255 ! wiz 14558: <td>disable</td>
1.205 wiz 14559: </tr>
14560: <tr>
1.254 wiz 14561: <td>distclean</td>
1.255 ! wiz 14562: <td>distinfo</td>
1.161 leot 14563: </tr>
14564: <tr>
1.254 wiz 14565: <td>dl</td>
1.255 ! wiz 14566: <td>dlopen</td>
1.197 leot 14567: </tr>
14568: <tr>
1.254 wiz 14569: <td>do-buildlink</td>
1.255 ! wiz 14570: <td>do-clean</td>
1.156 leot 14571: </tr>
14572: <tr>
1.254 wiz 14573: <td>do-configure</td>
1.255 ! wiz 14574: <td>do-configure-post-hook</td>
1.156 leot 14575: </tr>
14576: <tr>
1.254 wiz 14577: <td>do-extract</td>
1.255 ! wiz 14578: <td>do-fetch</td>
1.156 leot 14579: </tr>
14580: <tr>
1.254 wiz 14581: <td>do-install</td>
1.255 ! wiz 14582: <td>download</td>
1.156 leot 14583: </tr>
14584: <tr>
1.242 gutterid 14585: <td>emul</td>
1.254 wiz 14586: <td>emul-distinfo</td>
1.156 leot 14587: </tr>
14588: <tr>
1.242 gutterid 14589: <td>emul-fetch</td>
1.254 wiz 14590: <td>emulation</td>
1.162 rillig 14591: </tr>
14592: <tr>
1.242 gutterid 14593: <td>emulator</td>
1.254 wiz 14594: <td>enable</td>
1.156 leot 14595: </tr>
14596: <tr>
1.238 wiz 14597: <td>endian</td>
1.254 wiz 14598: <td>endif</td>
1.246 leot 14599: </tr>
14600: <tr>
1.251 gutterid 14601: <td>enomem</td>
1.246 leot 14602: <td>ensurepip</td>
1.233 wiz 14603: </tr>
14604: <tr>
1.251 gutterid 14605: <td>err</td>
1.246 leot 14606: <td>errx</td>
1.156 leot 14607: </tr>
14608: <tr>
1.251 gutterid 14609: <td>etc</td>
1.246 leot 14610: <td>exp</td>
1.227 wiz 14611: </tr>
14612: <tr>
1.251 gutterid 14613: <td>extract-rpm</td>
1.246 leot 14614: <td>fabs</td>
1.214 leot 14615: </tr>
14616: <tr>
1.251 gutterid 14617: <td>feature</td>
1.246 leot 14618: <td>features</td>
1.156 leot 14619: </tr>
14620: <tr>
1.251 gutterid 14621: <td>fetch</td>
1.246 leot 14622: <td>fetch-list</td>
1.205 wiz 14623: </tr>
14624: <tr>
1.251 gutterid 14625: <td>follows</td>
1.246 leot 14626: <td>forbids</td>
1.197 leot 14627: </tr>
14628: <tr>
1.251 gutterid 14629: <td>form</td>
1.246 leot 14630: <td>format</td>
1.156 leot 14631: </tr>
14632: <tr>
1.251 gutterid 14633: <td>fortify</td>
1.246 leot 14634: <td>fortify_source</td>
1.238 wiz 14635: </tr>
14636: <tr>
1.254 wiz 14637: <td>fossil</td>
1.251 gutterid 14638: <td>friend</td>
1.254 wiz 14639: </tr>
14640: <tr>
1.242 gutterid 14641: <td>fts</td>
1.254 wiz 14642: <td>fts_close</td>
1.241 rillig 14643: </tr>
14644: <tr>
1.242 gutterid 14645: <td>fts_open</td>
1.254 wiz 14646: <td>fts_read</td>
1.217 rillig 14647: </tr>
14648: <tr>
1.242 gutterid 14649: <td>fts_set</td>
1.254 wiz 14650: <td>gcc</td>
1.223 nia 14651: </tr>
14652: <tr>
1.242 gutterid 14653: <td>gethostbyaddr</td>
1.254 wiz 14654: <td>gethostbyname</td>
1.156 leot 14655: </tr>
14656: <tr>
1.242 gutterid 14657: <td>gethostbyname2</td>
1.254 wiz 14658: <td>getopt_long</td>
1.156 leot 14659: </tr>
14660: <tr>
1.242 gutterid 14661: <td>getprogname</td>
1.254 wiz 14662: <td>getservbyname</td>
1.156 leot 14663: </tr>
14664: <tr>
1.242 gutterid 14665: <td>getservbyport</td>
1.254 wiz 14666: <td>getservent</td>
1.156 leot 14667: </tr>
14668: <tr>
1.238 wiz 14669: <td>gettext</td>
1.254 wiz 14670: <td>git</td>
1.246 leot 14671: </tr>
14672: <tr>
1.251 gutterid 14673: <td>github</td>
1.246 leot 14674: <td>gitlab</td>
1.233 wiz 14675: </tr>
14676: <tr>
1.251 gutterid 14677: <td>glob</td>
1.246 leot 14678: <td>gnu</td>
1.174 leot 14679: </tr>
14680: <tr>
1.251 gutterid 14681: <td>gnu_configure_strict</td>
1.246 leot 14682: <td>go</td>
1.227 wiz 14683: </tr>
14684: <tr>
1.251 gutterid 14685: <td>go-deps</td>
1.246 leot 14686: <td>golang</td>
1.223 nia 14687: </tr>
14688: <tr>
1.251 gutterid 14689: <td>guess-license</td>
1.246 leot 14690: <td>hashbang</td>
1.217 rillig 14691: </tr>
14692: <tr>
1.251 gutterid 14693: <td>heimdal</td>
1.246 leot 14694: <td>help</td>
1.238 wiz 14695: </tr>
14696: <tr>
1.254 wiz 14697: <td>hg</td>
1.251 gutterid 14698: <td>imake</td>
1.254 wiz 14699: </tr>
14700: <tr>
1.242 gutterid 14701: <td>in-tree</td>
1.254 wiz 14702: <td>increment</td>
1.241 rillig 14703: </tr>
14704: <tr>
14705: <td>indirect</td>
1.254 wiz 14706: <td>inet_aton</td>
1.156 leot 14707: </tr>
14708: <tr>
1.241 rillig 14709: <td>interp</td>
1.254 wiz 14710: <td>interpreter</td>
1.214 leot 14711: </tr>
14712: <tr>
1.241 rillig 14713: <td>intl</td>
1.254 wiz 14714: <td>ip4</td>
1.156 leot 14715: </tr>
14716: <tr>
1.241 rillig 14717: <td>ip6</td>
1.254 wiz 14718: <td>ipv4</td>
1.205 wiz 14719: </tr>
14720: <tr>
1.241 rillig 14721: <td>ipv6</td>
1.254 wiz 14722: <td>iso</td>
1.197 leot 14723: </tr>
14724: <tr>
1.241 rillig 14725: <td>kerberos</td>
1.254 wiz 14726: <td>krb</td>
1.161 leot 14727: </tr>
14728: <tr>
1.241 rillig 14729: <td>krb5</td>
1.254 wiz 14730: <td>ksh</td>
1.156 leot 14731: </tr>
14732: <tr>
1.241 rillig 14733: <td>lapack</td>
1.254 wiz 14734: <td>latex</td>
1.156 leot 14735: </tr>
14736: <tr>
1.241 rillig 14737: <td>libintl_bindtextdomain</td>
1.254 wiz 14738: <td>libintl_gettext</td>
1.156 leot 14739: </tr>
14740: <tr>
1.241 rillig 14741: <td>libintl_textdomain</td>
1.254 wiz 14742: <td>libnbcompat</td>
1.189 bacon 14743: </tr>
14744: <tr>
1.241 rillig 14745: <td>libs</td>
1.254 wiz 14746: <td>libtool</td>
1.189 bacon 14747: </tr>
14748: <tr>
1.241 rillig 14749: <td>licence</td>
1.254 wiz 14750: <td>license</td>
1.156 leot 14751: </tr>
14752: <tr>
1.241 rillig 14753: <td>lintl</td>
1.254 wiz 14754: <td>little-endian</td>
1.177 leot 14755: </tr>
14756: <tr>
1.241 rillig 14757: <td>lock</td>
1.254 wiz 14758: <td>locking</td>
1.156 leot 14759: </tr>
14760: <tr>
1.241 rillig 14761: <td>lua</td>
1.254 wiz 14762: <td>lvalue</td>
1.174 leot 14763: </tr>
14764: <tr>
1.241 rillig 14765: <td>make</td>
1.254 wiz 14766: <td>makesum</td>
1.159 rillig 14767: </tr>
14768: <tr>
1.241 rillig 14769: <td>memory</td>
1.254 wiz 14770: <td>mercurial</td>
1.246 leot 14771: </tr>
14772: <tr>
1.251 gutterid 14773: <td>meta</td>
1.246 leot 14774: <td>meta-package</td>
1.156 leot 14775: </tr>
14776: <tr>
1.251 gutterid 14777: <td>meta_package</td>
1.246 leot 14778: <td>mit-krb5</td>
1.233 wiz 14779: </tr>
14780: <tr>
1.251 gutterid 14781: <td>mk.conf</td>
1.246 leot 14782: <td>mkl</td>
1.227 wiz 14783: </tr>
14784: <tr>
1.251 gutterid 14785: <td>mount</td>
1.246 leot 14786: <td>move</td>
1.156 leot 14787: </tr>
14788: <tr>
1.251 gutterid 14789: <td>moved</td>
1.246 leot 14790: <td>mprotect</td>
1.156 leot 14791: </tr>
14792: <tr>
1.251 gutterid 14793: <td>mremap</td>
1.246 leot 14794: <td>native</td>
1.177 leot 14795: </tr>
14796: <tr>
1.251 gutterid 14797: <td>nb</td>
1.246 leot 14798: <td>nbcompat</td>
1.159 rillig 14799: </tr>
14800: <tr>
1.251 gutterid 14801: <td>netlib</td>
1.255 ! wiz 14802: <td>network</td>
! 14803: </tr>
! 14804: <tr>
1.246 leot 14805: <td>node</td>
1.255 ! wiz 14806: <td>node.js</td>
1.226 gutterid 14807: </tr>
14808: <tr>
1.246 leot 14809: <td>nodejs</td>
1.255 ! wiz 14810: <td>obstack</td>
1.156 leot 14811: </tr>
14812: <tr>
1.246 leot 14813: <td>obstack_ptr_grow</td>
1.255 ! wiz 14814: <td>occurs</td>
1.156 leot 14815: </tr>
14816: <tr>
1.246 leot 14817: <td>only</td>
1.255 ! wiz 14818: <td>openblas</td>
1.218 nia 14819: </tr>
14820: <tr>
1.246 leot 14821: <td>options</td>
1.255 ! wiz 14822: <td>options.mk</td>
1.218 nia 14823: </tr>
14824: <tr>
1.246 leot 14825: <td>order</td>
1.255 ! wiz 14826: <td>override</td>
1.205 wiz 14827: </tr>
14828: <tr>
1.246 leot 14829: <td>override-intltool</td>
1.255 ! wiz 14830: <td>override-message-intltool</td>
1.156 leot 14831: </tr>
14832: <tr>
1.246 leot 14833: <td>package</td>
1.255 ! wiz 14834: <td>parallel</td>
1.161 leot 14835: </tr>
14836: <tr>
1.246 leot 14837: <td>path</td>
1.255 ! wiz 14838: <td>pax</td>
1.156 leot 14839: </tr>
14840: <tr>
1.246 leot 14841: <td>paxctl</td>
1.255 ! wiz 14842: <td>pbulk-index</td>
1.156 leot 14843: </tr>
14844: <tr>
1.246 leot 14845: <td>pc</td>
1.255 ! wiz 14846: <td>perl</td>
1.156 leot 14847: </tr>
14848: <tr>
1.246 leot 14849: <td>perl5</td>
1.255 ! wiz 14850: <td>perms</td>
1.156 leot 14851: </tr>
14852: <tr>
1.246 leot 14853: <td>php</td>
1.255 ! wiz 14854: <td>pkg-build-options</td>
1.156 leot 14855: </tr>
14856: <tr>
1.246 leot 14857: <td>pkg-config</td>
1.255 ! wiz 14858: <td>pkg_build_options</td>
1.156 leot 14859: </tr>
14860: <tr>
1.246 leot 14861: <td>pkgsrc</td>
1.255 ! wiz 14862: <td>platform</td>
1.156 leot 14863: </tr>
14864: <tr>
1.246 leot 14865: <td>plist</td>
1.255 ! wiz 14866: <td>post-extract</td>
1.156 leot 14867: </tr>
14868: <tr>
1.246 leot 14869: <td>post-fetch</td>
1.255 ! wiz 14870: <td>post-wrapper</td>
1.156 leot 14871: </tr>
14872: <tr>
1.246 leot 14873: <td>pre-build-checks-hook</td>
1.255 ! wiz 14874: <td>pre-configure-checks-hook</td>
1.156 leot 14875: </tr>
14876: <tr>
1.246 leot 14877: <td>pre-extract</td>
1.255 ! wiz 14878: <td>pre-fetch</td>
1.156 leot 14879: </tr>
14880: <tr>
1.246 leot 14881: <td>print-go-deps</td>
1.255 ! wiz 14882: <td>print-plist</td>
1.156 leot 14883: </tr>
14884: <tr>
1.246 leot 14885: <td>print-summary-data</td>
1.255 ! wiz 14886: <td>privileged-install-hook</td>
1.156 leot 14887: </tr>
14888: <tr>
1.246 leot 14889: <td>pypi</td>
1.255 ! wiz 14890: <td>python</td>
1.174 leot 14891: </tr>
14892: <tr>
1.246 leot 14893: <td>r</td>
1.255 ! wiz 14894: <td>readme-all</td>
1.156 leot 14895: </tr>
14896: <tr>
1.246 leot 14897: <td>recursive</td>
1.255 ! wiz 14898: <td>recv</td>
1.156 leot 14899: </tr>
14900: <tr>
1.246 leot 14901: <td>recvfrom</td>
1.255 ! wiz 14902: <td>regcomp</td>
1.156 leot 14903: </tr>
14904: <tr>
1.246 leot 14905: <td>release-localbase-lock</td>
1.255 ! wiz 14906: <td>release-lock</td>
1.156 leot 14907: </tr>
14908: <tr>
1.246 leot 14909: <td>relro</td>
1.255 ! wiz 14910: <td>remove</td>
1.156 leot 14911: </tr>
14912: <tr>
1.246 leot 14913: <td>removed</td>
1.255 ! wiz 14914: <td>rename</td>
1.174 leot 14915: </tr>
14916: <tr>
1.246 leot 14917: <td>renamed</td>
1.255 ! wiz 14918: <td>reorder</td>
1.174 leot 14919: </tr>
14920: <tr>
1.246 leot 14921: <td>replace</td>
1.255 ! wiz 14922: <td>replace_interpreter</td>
1.156 leot 14923: </tr>
14924: <tr>
1.246 leot 14925: <td>reproducible</td>
1.255 ! wiz 14926: <td>resolv</td>
1.226 gutterid 14927: </tr>
14928: <tr>
1.246 leot 14929: <td>root</td>
1.255 ! wiz 14930: <td>ruby</td>
1.226 gutterid 14931: </tr>
14932: <tr>
1.246 leot 14933: <td>send</td>
1.255 ! wiz 14934: <td>sendfile</td>
1.156 leot 14935: </tr>
14936: <tr>
1.246 leot 14937: <td>sendto</td>
1.255 ! wiz 14938: <td>setenv</td>
1.156 leot 14939: </tr>
14940: <tr>
1.246 leot 14941: <td>setgid</td>
1.255 ! wiz 14942: <td>setprogname</td>
1.156 leot 14943: </tr>
14944: <tr>
1.246 leot 14945: <td>setuid</td>
1.255 ! wiz 14946: <td>sh</td>
1.174 leot 14947: </tr>
14948: <tr>
1.246 leot 14949: <td>shebang</td>
1.255 ! wiz 14950: <td>show</td>
1.156 leot 14951: </tr>
14952: <tr>
1.246 leot 14953: <td>show-all</td>
1.255 ! wiz 14954: <td>show-build-defs</td>
1.156 leot 14955: </tr>
14956: <tr>
1.246 leot 14957: <td>show-depends</td>
1.255 ! wiz 14958: <td>show-depends-dirs</td>
1.156 leot 14959: </tr>
14960: <tr>
1.246 leot 14961: <td>show-depends-pkgpaths</td>
1.255 ! wiz 14962: <td>show-depends-recursive</td>
1.156 leot 14963: </tr>
14964: <tr>
1.246 leot 14965: <td>show-deps</td>
1.255 ! wiz 14966: <td>show-distfiles</td>
1.181 rillig 14967: </tr>
14968: <tr>
1.246 leot 14969: <td>show-downlevel</td>
1.255 ! wiz 14970: <td>show-subdir-var</td>
1.156 leot 14971: </tr>
14972: <tr>
1.246 leot 14973: <td>show-tools</td>
1.255 ! wiz 14974: <td>show-var</td>
1.222 gutterid 14975: </tr>
14976: <tr>
1.246 leot 14977: <td>show-vars</td>
1.255 ! wiz 14978: <td>snprintf</td>
1.223 nia 14979: </tr>
14980: <tr>
1.246 leot 14981: <td>socket</td>
1.255 ! wiz 14982: <td>ssp</td>
1.156 leot 14983: </tr>
14984: <tr>
1.246 leot 14985: <td>st_mode</td>
1.255 ! wiz 14986: <td>stage-install</td>
1.156 leot 14987: </tr>
14988: <tr>
1.246 leot 14989: <td>strcasestr</td>
1.255 ! wiz 14990: <td>strict</td>
1.156 leot 14991: </tr>
14992: <tr>
1.246 leot 14993: <td>strip</td>
1.255 ! wiz 14994: <td>strndup</td>
1.156 leot 14995: </tr>
14996: <tr>
1.246 leot 14997: <td>strnlen</td>
1.255 ! wiz 14998: <td>strsep</td>
1.174 leot 14999: </tr>
15000: <tr>
1.246 leot 15001: <td>subst</td>
1.255 ! wiz 15002: <td>substitutions</td>
1.238 wiz 15003: </tr>
15004: <tr>
1.254 wiz 15005: <td>subversion</td>
1.255 ! wiz 15006: <td>sun</td>
1.254 wiz 15007: </tr>
15008: <tr>
15009: <td>sunpro</td>
1.255 ! wiz 15010: <td>sunwspro</td>
1.241 rillig 15011: </tr>
15012: <tr>
1.254 wiz 15013: <td>svn</td>
1.255 ! wiz 15014: <td>symlink</td>
1.214 leot 15015: </tr>
15016: <tr>
1.242 gutterid 15017: <td>test</td>
1.255 ! wiz 15018: <td>test-env</td>
1.212 wiz 15019: </tr>
15020: <tr>
1.242 gutterid 15021: <td>tex</td>
1.255 ! wiz 15022: <td>texlive</td>
1.227 wiz 15023: </tr>
15024: <tr>
1.242 gutterid 15025: <td>tmp</td>
1.255 ! wiz 15026: <td>todo</td>
1.223 nia 15027: </tr>
15028: <tr>
1.242 gutterid 15029: <td>tool</td>
1.255 ! wiz 15030: <td>tools</td>
1.161 leot 15031: </tr>
15032: <tr>
1.242 gutterid 15033: <td>tools-libtool-m4-override</td>
1.255 ! wiz 15034: <td>transitive</td>
1.156 leot 15035: </tr>
15036: <tr>
1.242 gutterid 15037: <td>type</td>
1.255 ! wiz 15038: <td>ulimit</td>
1.156 leot 15039: </tr>
15040: <tr>
1.242 gutterid 15041: <td>undefined</td>
1.255 ! wiz 15042: <td>undo-replace</td>
1.156 leot 15043: </tr>
15044: <tr>
1.242 gutterid 15045: <td>unlimit</td>
1.255 ! wiz 15046: <td>unprivileged</td>
1.156 leot 15047: </tr>
15048: <tr>
1.242 gutterid 15049: <td>unprivileged-install-hook</td>
1.255 ! wiz 15050: <td>unstripped</td>
1.156 leot 15051: </tr>
15052: <tr>
1.242 gutterid 15053: <td>update</td>
1.255 ! wiz 15054: <td>updated</td>
1.156 leot 15055: </tr>
15056: <tr>
1.242 gutterid 15057: <td>upload</td>
1.255 ! wiz 15058: <td>upload-distfiles</td>
1.156 leot 15059: </tr>
15060: <tr>
1.242 gutterid 15061: <td>use_tools</td>
1.255 ! wiz 15062: <td>user</td>
1.156 leot 15063: </tr>
15064: <tr>
1.242 gutterid 15065: <td>utimes</td>
1.255 ! wiz 15066: <td>vasprintf</td>
1.156 leot 15067: </tr>
15068: <tr>
1.242 gutterid 15069: <td>verbose</td>
1.255 ! wiz 15070: <td>vsnprintf</td>
1.156 leot 15071: </tr>
15072: <tr>
1.242 gutterid 15073: <td>warn</td>
1.255 ! wiz 15074: <td>warning</td>
1.156 leot 15075: </tr>
15076: <tr>
1.242 gutterid 15077: <td>warnings</td>
1.255 ! wiz 15078: <td>warnx</td>
1.156 leot 15079: </tr>
15080: <tr>
1.242 gutterid 15081: <td>wattr_off</td>
1.255 ! wiz 15082: <td>wattr_on</td>
1.156 leot 15083: </tr>
15084: <tr>
1.242 gutterid 15085: <td>work</td>
1.255 ! wiz 15086: <td>wrapper</td>
1.156 leot 15087: </tr>
15088: <tr>
1.174 leot 15089: <td>wrkdir</td>
1.255 ! wiz 15090: <td> </td>
1.156 leot 15091: </tr>
15092: </table>
1.154 rillig 15093: </div>
15094: <div class="appendix">
15095: <div class="titlepage"><div><div><h1 class="title">
1.207 leot 15096: <a name="editing"></a>Appendix F. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 15097: <div class="toc">
15098: <p><b>Table of Contents</b></p>
1.100 leot 15099: <dl class="toc">
1.207 leot 15100: <dt><span class="sect1"><a href="#targets">F.1. Make targets</a></span></dt>
15101: <dt><span class="sect1"><a href="#procedure">F.2. Procedure</a></span></dt>
1.1 dsieger 15102: </dl>
15103: </div>
15104: <p>This section contains information on editing the pkgsrc
15105: guide itself.</p>
1.41 asau 15106: <div class="sect1">
1.1 dsieger 15107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 15108: <a name="targets"></a>F.1. Make targets</h2></div></div></div>
1.1 dsieger 15109: <p>The pkgsrc guide's source code is stored in
15110: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
15111: are created from it:</p>
1.41 asau 15112: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 15113: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
15114: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174 leot 15115: <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>
15116: <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 15117: The PDF version of the pkgsrc guide.</p></li>
1.174 leot 15118: <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 15119: PostScript version of the pkgsrc guide.</p></li>
15120: </ul></div>
15121: </div>
1.41 asau 15122: <div class="sect1">
1.1 dsieger 15123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.207 leot 15124: <a name="procedure"></a>F.2. Procedure</h2></div></div></div>
1.1 dsieger 15125: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 15126: <div class="procedure"><ol class="procedure" type="1">
1.190 bacon 15127: <li class="step"><p>Make sure you have checked out the htdocs repository
15128: into a sibling directory of your pkgsrc directory. You will need
15129: the ability to commit from both pkgsrc and htdocs.</p></li>
1.41 asau 15130: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 15131: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 15132: documentation) installed. These are automatically installed when
1.207 leot 15133: 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 15134: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 15135: right directory. All further steps will take place
15136: here.</p></li>
1.41 asau 15137: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 15138: <code class="filename">files/</code>.</p></li>
1.41 asau 15139: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 15140: guide for valid XML and to build the final output files. If you
15141: get any errors at this stage, you can just edit the files, as
15142: there are only symbolic links in the working directory, pointing
15143: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 15144: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 15145: commit)</strong></span></p></li>
1.41 asau 15146: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 15147: regenerate the output files with the proper RCS
15148: Ids.</p></li>
1.41 asau 15149: <li class="step">
1.10 hubertf 15150: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 15151: commit the files in both <code class="filename">pkgsrc/doc</code> and
15152: <code class="filename">htdocs</code>.</p>
1.41 asau 15153: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 15154: <h3 class="title">Note</h3>
15155: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 15156: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
15157: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 15158: directory.</p>
15159: </div>
15160: </li>
15161: </ol></div>
15162: </div>
15163: </div>
15164: </div></body>
15165: </html>
CVSweb <webmaster@jp.NetBSD.org>